DescribeUserDomains - 查询用户域名 - CDN

调用DescribeUserDomains查询用户名下所有的域名与状态，支持域名模糊匹配过滤和域名状态过滤。

接口说明

单用户调用频率：100 次/秒。
支持批量查询域名，多个域名用半角逗号（,）分隔，一次最多支持 50 个域名查询。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
cdn:DescribeUserDomains	get	Domain `acs:cdn::{#accountId}:domain/*`	无	无

请求参数

名称	类型	必填	描述	示例值
PageSize	integer	否	分页大小，取值1~500，默认值为 20，最大值为 500。	5
PageNumber	integer	否	取得第几页，取值范围：1~100000。	1
DomainName	string	否	加速域名。如果不传该参数，默认不做域名匹配搜索，返回所有符合条件的域名。	example.com
DomainStatus	string	否	域名状态过滤。取值： online：启用。 offline：停用。 configuring：配置中。 configure_failed：配置失败。 checking：正在审核。 check_failed：审核失败。 stopping：停用中。 deleting：删除中。如果不传该参数，默认查询所有状态。	configure_failed
DomainSearchType	string	否	域名查询类型。取值： fuzzy_match：模糊匹配。 pre_match：前匹配。 suf_match：后匹配。 full_match（默认值）：完全匹配。说明传递了域名参数的情况下，不传 DomainSearchType 参数，则默认采用完全匹配模式。	fuzzy_match
CdnType	string	否	CDN 业务类型，多个用半角逗号（,）分隔。取值： web：图片小文件。 download：大文件下载。 video：视音频点播。如果不传该参数，默认查询所有业务类型。	download,web,video
CheckDomainShow	boolean	否	是否展示审核中、审核失败、配置失败的域名。取值： true：是。 false：否。	false
ResourceGroupId	string	否	资源组 ID，默认查询所有资源组 ID。	abcd1234abcd1234
ChangeStartTime	string	否	更新开始时间，使用 UTC+0 时间表示，格式为 yyyy-MM-ddTHH:mm:ssZ。	2019-10-10T12:14:55Z
ChangeEndTime	string	否	更新结束时间，使用 UTC+0 时间表示，格式为 yyyy-MM-ddTHH:mm:ssZ。说明结束时间需晚于起始时间。	2019-10-10T12:14:58Z
Coverage	string	否	加速区域，默认为全部区域。取值： domestic：仅中国内地。 global：全球。 overseas：全球（不包含中国内地）。	domestic
Source	string	否	源站信息。	***
Tag	array<object>	否	标签列表。列表元素最大数量：20。
	object	否	标签解释。
Key	string	否	标签键。默认查询所有标签键。	key
Value	string	否	标签值。默认查询所有标签值。	value

返回参数

名称	类型	描述	示例值
	object	参数解释。
RequestId	string	请求 ID。	BDA62CE4-3477-439A-B52E-D2D7C829D7C1
PageNumber	long	返回数据的页码。	1
PageSize	long	整页大小。	20
TotalCount	long	总条数。	2
Domains	array<object>	域名信息。
PageData	object	域名信息。
SslProtocol	string	HTTPS 开关。取值： on：已开启。 off：未开启。	on
Sandbox	string	是否在沙箱。取值： true：是空字符串：否	true
GmtModified	string	加速域名修改时间。	2015-10-28T11:05:52Z
DomainName	string	加速域名。	example.com
DomainId	long	加速域名 ID。	11223344
GmtCreated	string	加速域名创建时间。	2015-10-28T09:32:51Z
Description	string	域名备案信息的描述。	filing description
Coverage	string	加速区域。取值： domestic：仅中国内地。 global：全球。 overseas：全球（不包含中国内地）。	domestic
ResourceGroupId	string	资源组 ID。	abcd1234abcd1234
Cname	string	加速域名对应的 CNAME。	example.com.w.alikunlun.net
DomainStatus	string	加速域名状态。取值： online：启用。 offline：停用。 configuring：配置中。 configure_failed：配置失败。 checking：正在审核。 check_failed：审核失败。 stopping：停用中。 deleting：删除中。	configure_failed
CdnType	string	加速业务类型。取值： web：图片小文件。 download：大文件下载。 video：视音频点播。	download
Sources	array<object>	数据类型 Source。
Source	object	数据类型 Source。
Type	string	源站类型。	oss
Weight	string	回源权重。	15
Priority	string	优先级。	20
Port	integer	源站端口。	80
Content	string	源站地址。	***.oss-cn-hangzhou.aliyuncs.com

示例

正常返回示例

JSON格式

{
  "RequestId": "BDA62CE4-3477-439A-B52E-D2D7C829D7C1",
  "PageNumber": 1,
  "PageSize": 20,
  "TotalCount": 2,
  "Domains": {
    "PageData": [
      {
        "SslProtocol": "on",
        "Sandbox": "true",
        "GmtModified": "2015-10-28T11:05:52Z",
        "DomainName": "example.com",
        "DomainId": 11223344,
        "GmtCreated": "2015-10-28T09:32:51Z",
        "Description": "filing description",
        "Coverage": "domestic",
        "ResourceGroupId": "abcd1234abcd1234",
        "Cname": "example.com.w.alikunlun.net",
        "DomainStatus": "configure_failed",
        "CdnType": "download",
        "Sources": {
          "Source": [
            {
              "Type": "oss",
              "Weight": "15",
              "Priority": "20",
              "Port": 80,
              "Content": "***.oss-cn-hangzhou.aliyuncs.com"
            }
          ]
        }
      }
    ]
  }
}

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidPageNumber.ValueNotSupported	The specified value of PageNumber is not supported.	-
400	InvalidPageSize.ValueNotSupported	The specified value of PageSize is invalid.	-
400	InvalidDomainStatus.ValueNotSupported	The specified value of DomainStatus is invalid.	-
400	InvalidDomainName.Malformed	The specified DomainName is invalid.	域名格式错误。
400	InvalidDomainSearchType.ValueNotSupported	The specified value of DomainSearchType is invalid.	-
400	InvalidChangeStartTime.Malformed	The specified ChangeStartTime is invalid.	-
400	InvalidChangeEndTime.Malformed	The specified ChangeEndTime is invalid.	-
400	InvalidCdnType.Malformed	The specified CdnType is invalid.	-

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2024-12-18	OpenAPI 描述信息更新、OpenAPI 错误码发生变更	查看变更详情
2024-05-11	OpenAPI 错误码发生变更	查看变更详情
2023-08-19	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2023-06-27	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情