调用DescribeDcdnIpaUserDomains查询用户名下所有的IPA层应用加速域名,支持模糊搜索或者按域名状态过滤。

说明 单用户调用频率:30次/秒。

调试

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

请求参数

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

系统规定参数。取值:DescribeDcdnIpaUserDomains

PageSize Integer 5

每个页面显示的域名数,默认20,最大500

取值范围:1~500之间的任意整数。

PageNumber Integer 1

页码。取值范围为:1~100000

默认值为1

DomainName String example.com

域名模糊匹配过滤。

DomainStatus String online

域名状态过滤。

  • online:启用。
  • offline:停用。
  • configuring:配置中。
  • configure_failed:配置失败。
  • checking:正在审核。
  • check_failed:审核失败。
DomainSearchType String fuzzy_match

域名查询类型。

  • fuzzy_match(默认值):模糊匹配。
  • pre_match:前匹配。
  • suf_match:后匹配。
  • full_match:完全匹配。
CheckDomainShow Boolean false

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

  • true:显示。
  • false:不显示。
ResourceGroupId String ResourceGroupId

资源组ID。

FuncId String 7

功能ID。 例如:7表示路径过期时间。更多功能ID,请参见域名配置功能函数

FuncFilter String config

Func开关设置。

  • config:代表开通Func。
  • unconfig:代表没有开通Func。
Tag.N.Key String 1

标签键,N的取值范围1~20。通过TagDcdnResources接口可以给域名设置Tag。

Tag.N.Value String 1

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

返回数据

名称 类型 示例值 描述
RequestId String AA75AADB-5E25-4970-B480-EAA1F5658483

请求ID。

PageNumber Long 1

当前页码。

PageSize Long 20

单页显示的域名总数。

TotalCount Long 1

查询到的域名总数。

Domains Array of PageData

由PageData组成的数组格式,返回加速域名的状态信息。

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

加速域名创建时间。

Description String audit failed

审核失败原因。

SSLProtocol String on

HTTPS开关。

  • on表示已开启。
  • off表示未开启。
ResourceGroupId String abcd1234abcd****

资源组ID。

Sandbox String normal

沙箱。

DomainStatus String online

加速域名状态,取值:

  • online:启用。
  • offline:停用。
  • configuring:配置中。
  • configure_failed:配置失败。
  • checking:正在审核。
  • check_failed:审核失败。
Cname String example.com.*.com

加速域名对应的CNAME域名。

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

加速域名修改时间。

DomainName String example.com

加速域名名称。

Sources Array of Source

源站信息。

Source
Type String OSS域名

源站类型。

Weight String 20

回源权重。

Priority String 20

优先级。

Port Integer 80

源站端口。

Content String *.aliyuncs.com

源站地址。

示例

请求示例

http(s)://dcdn.aliyuncs.com/?Action=DescribeDcdnIpaUserDomains
&PageSize=5
&PageNumber=1
&DomainName=example.com
&DomainStatus=online
&DomainSearchType=fuzzy_match
&CheckDomainShow=false
&ResourceGroupId=ResourceGroupId
&FuncId=7
&FuncFilter=config
&Tag=[{"Key":"1","Value":"1"}]
&公共请求参数

正常返回示例

XML格式

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

<DescribeDcdnIpaUserDomainsResponse>
    <RequestId>AA75AADB-5E25-4970-B480-EAA1F5658483</RequestId>
    <PageNumber>1</PageNumber>
    <PageSize>20</PageSize>
    <TotalCount>1</TotalCount>
    <Domains>
        <GmtCreated>2015-10-28T09:32:51Z</GmtCreated>
        <Description>audit failed</Description>
        <SSLProtocol>on</SSLProtocol>
        <ResourceGroupId>abcd1234abcd****</ResourceGroupId>
        <Sandbox>normal</Sandbox>
        <DomainStatus>online</DomainStatus>
        <Cname>example.com.*.com</Cname>
        <GmtModified>2015-10-28T11:05:52Z</GmtModified>
        <DomainName>example.com</DomainName>
        <Sources>
            <Type>OSS域名</Type>
            <Weight>20</Weight>
            <Priority>20</Priority>
            <Port>80</Port>
            <Content>*.aliyuncs.com</Content>
        </Sources>
    </Domains>
</DescribeDcdnIpaUserDomainsResponse>

JSON格式

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

{
  "RequestId" : "AA75AADB-5E25-4970-B480-EAA1F5658483",
  "PageNumber" : 1,
  "PageSize" : 20,
  "TotalCount" : 1,
  "Domains" : [ {
    "GmtCreated" : "2015-10-28T09:32:51Z",
    "Description" : "audit failed",
    "SSLProtocol" : "on",
    "ResourceGroupId" : "abcd1234abcd****",
    "Sandbox" : "normal",
    "DomainStatus" : "online",
    "Cname" : "example.com.*.com",
    "GmtModified" : "2015-10-28T11:05:52Z",
    "DomainName" : "example.com",
    "Sources" : [ {
      "Type" : "OSS域名",
      "Weight" : "20",
      "Priority" : "20",
      "Port" : 80,
      "Content" : "*.aliyuncs.com"
    } ]
  } ]
}

错误码

HttpCode 错误码 错误信息 描述
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值错误,请重新填写。

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