获取加速域名的配置信息 - CDN

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

调试

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

请求参数


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

返回数据


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

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"
}]

示例

请求示例

http(s)://cdn.aliyuncs.com/?Action=DescribeCdnDomainConfigs
&DomainName=example.com
&FunctionNames=aliauth
&<公共请求参数>

正常返回示例

XML格式

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

<DescribeCdnDomainConfigsResponse>
    <RequestId>C80705BF-0F76-41FA-BAD1-5B59296A4E59</RequestId>
    <DomainConfigs>
        <Status>success</Status>
        <ParentId>222728944812032</ParentId>
        <ConfigId>6295</ConfigId>
        <FunctionName>aliauth</FunctionName>
        <FunctionArgs>
            <ArgName>auth_type</ArgName>
            <ArgValue>req_auth</ArgValue>
        </FunctionArgs>
    </DomainConfigs>
</DescribeCdnDomainConfigsResponse>

JSON格式

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

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

错误码


HttpCode	错误码	错误信息	描述
400	Invalid%s.ValueNotSupported	FunctionName [%s] is not supported.	此方法不支持。

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