DescribeDcdnIpaUserDomains - 获取用户IPA层应用加速域名

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

接口说明

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

调试

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

授权信息

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

请求参数

名称类型必填描述示例值
PageSizeinteger

每个页面显示的域名数,默认 20,最大 500。 取值范围:1~500 之间的任意整数。

5
PageNumberinteger

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

1
DomainNamestring

根据域名匹配过滤。

example.com
DomainStatusstring

域名状态过滤。取值:

  • online:启用。

  • offline:停用。

  • configuring:配置中。

  • configure_failed:配置失败。

  • checking:正在审核。

  • check_failed:审核失败。

online
DomainSearchTypestring

域名查询类型。取值:

  • full_match(默认值):完全匹配。

  • fuzzy_match:模糊匹配。

  • pre_match:前匹配。

  • suf_match:后匹配。

fuzzy_match
CheckDomainShowboolean

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

  • true:显示。
  • false:不显示。
false
ResourceGroupIdstring

资源组 ID。

rg-acfmyuji4b6r4**
FuncIdstring

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

7
FuncFilterstring

Func 开关设置。

  • config:代表开通 Func。
  • unconfig:代表没有开通 Func。
config
Tagarray<object>

标签列表。

object

标签解释。

Keystring

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

1
Valuestring

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

1

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

AA75AADB-5E25-4970-B480-EAA1F5658483
PageNumberlong

当前页码。

1
PageSizelong

单页显示的域名总数。

20
TotalCountlong

查询到的域名总数。

1
Domainsarray<object>

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

PageDataobject
GmtCreatedstring

加速域名创建时间。

2015-10-28T09:32:51Z
Descriptionstring

审核失败原因。

audit failed
SSLProtocolstring

HTTPS 开关。

  • on 表示已开启。
  • off 表示未开启。
on
ResourceGroupIdstring

资源组 ID。

abcd1234abcd****
Sandboxstring

沙箱。

normal
DomainStatusstring

加速域名状态,取值:

  • online:启用。

  • offline:停用。

  • configuring:配置中。

  • configure_failed:配置失败。

  • checking:正在审核。

  • check_failed:审核失败。

online
Cnamestring

加速域名对应的 CNAME 域名。

example.com.*.com
GmtModifiedstring

加速域名修改时间。

2015-10-28T11:05:52Z
DomainNamestring

加速域名名称。

example.com
Sourcesarray<object>

源站信息。

Sourceobject
Typestring

源站类型。

OSS域名
Weightstring

回源权重。

20
Prioritystring

优先级。

20
Portinteger

源站端口。

80
Contentstring

源站地址。

*.aliyuncs.com

示例

正常返回示例

JSON格式

{
  "RequestId": "AA75AADB-5E25-4970-B480-EAA1F5658483",
  "PageNumber": 1,
  "PageSize": 20,
  "TotalCount": 1,
  "Domains": {
    "PageData": [
      {
        "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": {
          "Source": [
            {
              "Type": "OSS域名",
              "Weight": "20",
              "Priority": "20",
              "Port": 80,
              "Content": "*.aliyuncs.com"
            }
          ]
        }
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
400InvalidPageNumber.ValueNotSupportedThe specified value of PageNumber is not supported.页码参数错误,请重新填写。
400InvalidPageSize.ValueNotSupportedThe specified value of PageSize is invalid.PageSize参数错误,请重新填写。
400InvalidDomainStatus.ValueNotSupportedThe specified value of DomainStatus is invalid.DomainStatus值错误,请重新填写。
400InvalidDomainName.MalformedThe specified DomainName is invalid.域名格式错误。
400InvalidDomainSearchType.ValueNotSupportedThe specified value of DomainSearchType is invalid.DomainSearchType值错误,请重新填写。

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