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

调用DescribeDcdnUserDomainsByFunc通过FuncId查询用户名下所有配置了指定功能的DCDN域名。

接口说明

说明

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

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

dcdn:DescribeDcdnUserDomainsByFunc

get

Domain

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

无

请求参数

名称	类型	必填	描述	示例值
FuncId	integer	是	功能 ID，您可在域名配置功能参数文档，根据功能名称搜索查询。例如：配置回源 HOST（set_req_host_header）功能 ID 为 18。	7
FuncFilter	string	否	是否开通 funcid 功能。 config：开通。 unconfig：未开通。	config
DomainName	string	否	加速域名。	example.com
PageNumber	integer	否	页码，默认值：1。取值范围：1~100000。	1
PageSize	integer	否	单页显示域名的数量，默认值：20。取值范围：1~500。	20
ResourceGroupId	string	否	资源组 ID。	rg-acfmyuji4b6r4**
MatchType	string	否	查询类型，支持以下 2 种类型，默认为精确查询。 fuzzy_match：模糊查询。 exact_match：精确查询。	exact_match

返回参数

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

示例

正常返回示例

JSON格式

{
  "RequestId": "AA75AADB-5E25-4970-B480-EAA1F5658483",
  "PageNumber": 1,
  "PageSize": 5,
  "TotalCount": 16,
  "Domains": {
    "PageData": [
      {
        "GmtCreated": "2015-10-28T09:32:51Z",
        "SslProtocol": "on",
        "Description": "audit failed",
        "ResourceGroupId": "rg-acfmyuji4b6r4**",
        "Sandbox": "normal",
        "DomainStatus": "configure_failed",
        "Cname": "example.com.w.alikunlun.net",
        "GmtModified": "2015-10-28T11:05:50Z",
        "DomainName": "example.com",
        "Sources": {
          "Source": [
            {
              "Type": "oss",
              "Weight": "20",
              "Priority": "20",
              "Port": 80,
              "Content": "image.developer.aliyundoc.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值错误，请重新填写。
400	InvalidChangeStartTime.Malformed	The specified ChangeStartTime is invalid.	更新开始时间非法。
400	InvalidChangeEndTime.Malformed	The specified ChangeEndTime is invalid.	更新结束时间非法。

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

变更历史

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