调用DescribeCdnDomainConfigs查询加速域名配置信息-CDN-阿里云

调用DescribeCdnDomainConfigs获取加速域名的配置信息，一次可查询多个功能配置信息。

接口说明

说明

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

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

cdn:DescribeCdnDomainConfigs

get

*Domain

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

无

请求参数

名称	类型	必填	描述	示例值
DomainName	string	是	加速域名，仅支持查询单个域名。	example.com
FunctionNames	string	否	功能函数名称，多个用英文逗号（,）分隔。更多功能名称，请参见域名配置功能参数。	aliauth
ConfigId	string	否	功能配置 ID。ConfigId 查询和使用，请参见 ConfigId 使用说明。	6295

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	C80705BF-0F76-41FA-BAD1-5B59296A4E59
DomainConfigs	object
DomainConfig	array<object>	域名配置。
	object
Status	string	配置状态。取值： success：成功。 testing：测试中。 failed：失败。 configuring：配置中。	success
ParentId	string	规则条件 ID，非必填项。通过配置域名配置功能参数中的功能函数 condition（规则引擎），可以创建出规则条件（规则条件可以通过识别用户请求中携带的各种参数来匹配和过滤用户请求），每一个规则条件被创建以后都会生成一个对应的 ConfigId ，ConfigId 可以被当作 ParentId 参数被其他功能函数引用，这样规则条件就可以与功能配置一起组合形成更灵活的配置。具体配置操作请参考批量配置域名或下文 ParentId 配置示例说明。	222728944812032
ConfigId	string	配置 ID。	6295
FunctionName	string	功能函数名称。	aliauth
FunctionArgs	object
FunctionArg	array<object>	各个功能函数所对应的参数配置。
	object
ArgName	string	参数名称，functionName 的配置项（可配置多个配置项）。	auth_type
ArgValue	string	参数值，functionName 的配置项的取值。	req_auth

ParentId 配置示例

parentId 为**-1**：表示删除该配置里面已有的规则条件。

   "functionArgs": [{
     "argName": "功能参数 A", 
     "argValue": "功能参数 A 对应的值"
    }, 
  {
    "argName": "功能参数 B", 
    "argValue": "功能参数 B 对应的值"
     }], 
 "functionName": "功能名称",
 "parentId": "选填项，对应引用规则条件的 configid"
}]

不使用 parentId 的情况下，配置示例如下：使用函数origin_request_header添加回源 HTTP 请求头的时候引用了configid=222728944812032的规则条件，请求参数如下：

        "functionArgs": [{
            "argName": "header_operation_type",
            "argValue": "add"
        }, {
            "argName": "header_name",
            "argValue": "Accept-Encoding"
        }, {
            "argName": "header_value",
            "argValue": "gzip"
        }, {
            "argName": "duplicate",
            "argValue": "off"
        }],
        "functionName": "origin_request_header"
}]

使用 parentId 的情况下，配置示例如下：使用函数origin_request_header添加回源 HTTP 请求头的时候引用了configid=222728944812032的规则条件，请求参数如下：

        "functionArgs": [{
            "argName": "header_operation_type",
            "argValue": "add"
        }, {
            "argName": "header_name",
            "argValue": "Accept-Encoding"
        }, {
            "argName": "header_value",
            "argValue": "gzip"
        }, {
            "argName": "duplicate",
            "argValue": "off"
        }],
        "functionName": "origin_request_header",
        "parentId": "222728944812032"
}]

示例

正常返回示例

JSON格式

{
  "RequestId": "C80705BF-0F76-41FA-BAD1-5B59296A4E59",
  "DomainConfigs": {
    "DomainConfig": [
      {
        "Status": "success",
        "ParentId": "222728944812032",
        "ConfigId": "6295",
        "FunctionName": "aliauth",
        "FunctionArgs": {
          "FunctionArg": [
            {
              "ArgName": "auth_type",
              "ArgValue": "req_auth"
            }
          ]
        }
      }
    ]
  }
}

错误码

HTTP status code	错误码	错误信息	描述
400	Invalid%s.ValueNotSupported	FunctionName [%s] is not supported.

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

变更历史

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