调用DescribeDcdnIpaUserDomains获取用户IPA层应用加速域名_边缘安全加速(ESA)-阿里云帮助中心

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

接口说明

说明

单用户调用频率：30 次/秒。

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

dcdn:DescribeDcdnIpaUserDomains

get

*IpaDomain

acs:dcdn:*:{#accountId}:domain/*

无

请求参数

名称	类型	必填	描述	示例值
PageSize	integer	否	每个页面显示的域名数，默认 20，最大 500。取值范围：1~500 之间的任意整数。	5
PageNumber	integer	否	页码。取值范围为：1~100000。默认值为 1。	1
DomainName	string	否	根据域名匹配过滤。	example.com
DomainStatus	string	否	域名状态过滤。取值： online：启用。 offline：停用。 configuring：配置中。 configure_failed：配置失败。 checking：正在审核。 check_failed：审核失败。	online
DomainSearchType	string	否	域名查询类型。取值： full_match（默认值）：完全匹配。 fuzzy_match：模糊匹配。 pre_match：前匹配。 suf_match：后匹配。	fuzzy_match
CheckDomainShow	boolean	否	是否展示审核中、审核失败、配置失败的域名。取值： true：显示。 false：不显示。	false
ResourceGroupId	string	否	资源组 ID。	rg-acfmyuji4b6r4**
FuncId	string	否	功能 ID。例如：7 表示路径过期时间。更多功能 ID，请参见域名配置功能函数。	7
FuncFilter	string	否	Func 开关设置。 config：代表开通 Func。 unconfig：代表没有开通 Func。	config
Tag	array<object>	否	标签列表。
	object	否	标签解释。
Key	string	否	标签键，N 的取值范围 1~20。通过 TagDcdnResources 接口可以给域名设置 Tag。	1
Value	string	否	标签值，N 的取值范围 1~20。	1

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	AA75AADB-5E25-4970-B480-EAA1F5658483
PageNumber	integer	当前页码。	1
PageSize	integer	单页显示的域名总数。	20
TotalCount	integer	查询到的域名总数。	1
Domains	object
PageData	array<object>	由 PageData 组成的数组格式，返回加速域名的状态信息。
	object
GmtCreated	string	加速域名创建时间。	2015-10-28T09:32:51Z
Description	string	审核失败原因。	audit failed
SSLProtocol	string	HTTPS 开关。 on 表示已开启。 off 表示未开启。	on
ResourceGroupId	string	资源组 ID。	abcd1234abcd****
Sandbox	string	沙箱。	normal
DomainStatus	string	加速域名状态，取值： online：启用。 offline：停用。 configuring：配置中。 configure_failed：配置失败。 checking：正在审核。 check_failed：审核失败。	online
Cname	string	加速域名对应的 CNAME 域名。	example.com.*.com
GmtModified	string	加速域名修改时间。	2015-10-28T11:05:52Z
DomainName	string	加速域名名称。	example.com
Sources	object
Source	array<object>	源站信息。
	object
Type	string	源站类型。	OSS域名
Weight	string	回源权重。	20
Priority	string	优先级。	20
Port	integer	源站端口。	80
Content	string	源站地址。	*.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	错误码	错误信息	描述
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值错误，请重新填写。

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

变更历史

更多信息，参考变更详情。