调用DescribeUserDomains查询指定条件下所有加速域名的基本配置。

说明
  • 单用户调用频率:100次/秒。
  • 支持批量查询域名,多个域名用半角逗号(,)分隔,一次最多支持50个域名查询。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeUserDomains

系统规定参数。取值:DescribeUserDomains

PageSize Integer 5

分页大小,取值1~50,默认值为20,最大值为50

PageNumber Integer 1

取得第几页,取值范围:1~100000

DomainName String example.com

域名模糊匹配过滤。如果不传该参数,默认不匹配。

DomainStatus String configure_failed

域名状态过滤。取值:

  • online:启用。
  • offline:停用。
  • configuring:配置中。
  • configure_failed:配置失败。
  • checking:正在审核。
  • check_failed:审核失败。
  • stopping:停用中。
  • deleting:删除中。

如果不传该参数,默认查询所有状态。

DomainSearchType String fuzzy_match

域名查询类型。取值:

  • fuzzy_match(默认值):模糊匹配。
  • pre_match:前匹配。
  • suf_match:后匹配。
  • full_match:完全匹配。
CdnType String download,web,video

CDN业务类型,多个用半角逗号(,)分隔。取值:

  • web:图片小文件。
  • download:大文件下载。
  • video:视音频点播。

如果不传该参数,默认查询所有业务类型。

CheckDomainShow Boolean false

是否展示审核中、审核失败、配置失败的域名。取值:

  • true:是。
  • false:否。
ResourceGroupId String abcd1234abcd1234

资源组ID,默认查询所有资源组ID。

ChangeStartTime String 2019-10-10T12:14:55Z

更新开始时间,使用UTC时间表示,格式为yyyy-MM-ddTHH:mm:ssZ。

ChangeEndTime String 2019-10-10T12:14:58Z

更新结束时间,使用UTC时间表示,格式为yyyy-MM-ddTHH:mm:ssZ。

说明 结束时间需晚于起始时间。
Coverage String domestic

加速区域,默认为全部区域。取值:

  • domestic:仅中国内地。
  • global:全球。
  • overseas:全球(不包含中国内地)。
Source String ***

源站信息。

Tag.N.Key String key

标签键,N的取值范围为1~20

默认查询所有标签键。

Tag.N.Value String value

标签值,N的取值范围为1~20

默认查询所有标签值。

返回数据

名称 类型 示例值 描述
RequestId String BDA62CE4-3477-439A-B52E-D2D7C829D7C1

请求ID。

PageNumber Long 1

返回数据的页码。

PageSize Long 20

整页大小。

TotalCount Long 2

总条数。

Domains Array of PageData

域名信息。

PageData
GmtCreated String 2015-10-28T09:32:51Z

加速域名创建时间。

SslProtocol String on

HTTPS开关。取值:

  • on:已开启。
  • off:未开启。
Description String filing description

域名备案信息的描述。

Coverage String domestic

加速区域。取值:

  • domestic:仅中国内地。
  • global:全球。
  • overseas:全球(不包含中国内地)。
ResourceGroupId String abcd1234abcd1234

资源组ID。

Sandbox String normal

沙箱。

DomainStatus String configure_failed

加速域名状态。取值:

  • online:启用。
  • offline:停用。
  • configuring:配置中。
  • configure_failed:配置失败。
  • checking:正在审核。
  • check_failed:审核失败。
  • stopping:停用中。
  • deleting:删除中。
Cname String example.com.w.alikunlun.net

加速域名对应的CNAME。

GmtModified String 2015-10-28T11:05:52Z

加速域名修改时间。

CdnType String download

加速业务类型。取值:

  • web:图片小文件。
  • download:大文件下载。
  • video:视音频点播。
DomainName String example.com

加速域名。

Sources Array of Source

数据类型Source。

Source
Type String oss

源站类型。

Weight String 15

回源权重。

Priority String 20

优先级。

Port Integer 80

源站端口。

Content String ***.oss-cn-hangzhou.aliyuncs.com

源站地址。

示例

请求示例

http(s)://cdn.aliyuncs.com/?Action=DescribeUserDomains
&PageNumber=1
&PageSize=5
&DomainSearchType=fuzzy_match
&Coverage=domestic
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

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

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

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

错误码

HttpCode 错误码 错误信息 描述
400 InvalidDomainName.Malformed The specified DomainName is invalid. 域名格式错误。

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