调用DescribeDcdnUserDomains查询用户域名_边缘安全加速(ESA)-阿里云帮助中心

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

接口说明

说明单用户调用频率：80 次/秒。

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
PageSize	integer	否	分页大小。默认 20，取值：1~500。	20
PageNumber	integer	否	页数。取值范围：1~100000。	1
DomainName	string	否	加速域名。如果不传该参数，默认不做域名匹配搜索，返回所有符合条件的域名。	example.com
DomainStatus	string	否	域名状态过滤。 online：启用。 offline：停用。 configuring：配置中。 configure_failed：配置失败。 checking：正在审核。 check_failed：审核失败。	online
DomainSearchType	string	否	域名查询类型。 fuzzy_match：模糊匹配。 pre_match：前匹配。 suf_match：后匹配。 full_match（默认值）：完全匹配。说明传递了域名参数的情况下，不传 DomainSearchType 参数，则默认采用完全匹配模式。	fuzzy_match
CheckDomainShow	boolean	否	是否展示审核中、审核失败、配置失败的域名。取值： true：展示。 false：不展示。	false
ResourceGroupId	string	否	资源组 ID。	rg-acfmv6jutt**
ChangeStartTime	string	否	更新开始时间，日期格式按照 ISO8601 表示法，并使用 UTC+0 时间，格式为 yyyy-MM-ddTHH:mm:ssZ。	2018-05-10T12:00:00Z
ChangeEndTime	string	否	更新结束时间，日期格式按照 ISO8601 表示法，并使用 UTC+0 时间，格式为 yyyy-MM-ddTHH:mm:ssZ。说明结束时间需大于起始时间。	2018-05-10T14:00:00Z
Coverage	string	否	加速区域：默认为全部。 domestic：仅中国内地。 overseas：全球（不包含中国内地）。 global：全球。	domestic
Tag	array<object>	否	标签列表。
	object	否	标签解释。
Key	string	否	标签键，N 的取值范围 1~20。通过 TagDcdnResources 接口可以给域名设置 Tag。	1
Value	string	否	标签值，N 的取值范围 1~20。	1
WebSiteType	string	否	业务类型，多个用逗号隔开，默认值为 dynamic，查询普通 dcdn 域名。查询计算服务类型域名时，传 computing_routine,computing_image。	computing_routine

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	AA75AADB-5E25-4970-B480-EAA1F5658483
PageNumber	long	返回数据的页码。	1
PageSize	long	整页大小。	12
TotalCount	long	总条数。	12
Domains	array<object>	由 PageData 组成的数组格式，返回加速域名的状态信息。
PageData	object
GmtCreated	string	加速域名创建时间。	2015-10-28T11:05:50Z
Description	string	审核失败原因。	audit failed
SSLProtocol	string	HTTPS 开关。 on：已开启。 off：未开启。	on
ResourceGroupId	string	资源组 ID。	rg-acfmv6jutt**
Sandbox	string	沙箱。	normal
DomainStatus	string	加速域名状态。 online：启用。 offline：停用。 configuring：配置中。 configure_failed：配置失败。 checking：正在审核。 check_failed：审核失败。	online
Cname	string	加速域名对应的 CNAME 域名。	test.aliyun.com.w.alikunlun.com
GmtModified	string	加速域名修改时间。	2015-10-28T09:31:59Z
DomainName	string	域名信息。	www.example.com
DomainId	long	加速域名 ID。	11223344
Sources	array<object>	源站信息。
Source	object
Type	string	源站类型。	oss
Weight	string	权重。	20
Priority	string	优先级。	20
Port	integer	源站端口。	80
Content	string	源站地址。	example.com
Scene	string	场景。支持： apiscene：API 加速。 webservicescene：网站业务加速。 staticscene：视频、图文类加速。（空）：没有场景。	apiscene
FunctionType	string	计算服务类型。取值： routine：程序。 image：镜像。 cloudFunction：函数。	routine

示例

正常返回示例

JSON格式

{
  "RequestId": "AA75AADB-5E25-4970-B480-EAA1F5658483",
  "PageNumber": 1,
  "PageSize": 12,
  "TotalCount": 12,
  "Domains": {
    "PageData": [
      {
        "GmtCreated": "2015-10-28T11:05:50Z",
        "Description": "audit failed",
        "SSLProtocol": "on",
        "ResourceGroupId": "rg-acfmv6jutt**",
        "Sandbox": "normal",
        "DomainStatus": "online",
        "Cname": "test.aliyun.com.w.alikunlun.com",
        "GmtModified": "2015-10-28T09:31:59Z",
        "DomainName": "www.example.com",
        "DomainId": 11223344,
        "Sources": {
          "Source": [
            {
              "Type": "oss",
              "Weight": "20",
              "Priority": "20",
              "Port": 80,
              "Content": "example.com"
            }
          ]
        },
        "Scene": "apiscene",
        "FunctionType": "routine"
      }
    ]
  }
}

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidPageNumber.ValueNotSupported	The specified value of PageNumber is not supported.	页码参数错误，请重新填写。
400	InvalidPageSize.ValueNotSupported	The specified value of PageSize is invalid.	PageSize参数错误，请重新填写。
400	InvalidDomainStatus.ValueNotSupported	The specified value of DomainStatus is invalid.	DomainStatus值错误，请重新填写。
400	InvalidDomainName.Malformed	The specified DomainName is invalid.	域名格式错误。
400	InvalidDomainSearchType.ValueNotSupported	The specified value of DomainSearchType is invalid.	DomainSearchType值错误，请重新填写。
400	InvalidChangeStartTime.Malformed	The specified ChangeStartTime is invalid.	更新开始时间非法。
400	InvalidChangeEndTime.Malformed	The specified ChangeEndTime is invalid.	更新结束时间非法。

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

变更历史

变更时间	变更内容概要	操作
2024-05-11	OpenAPI 错误码发生变更	查看变更详情
2023-08-29	OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更	查看变更详情
2023-08-02	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情