调用DescribeCdnDomainStagingConfig查询模拟环境配置信息,一次可查询多个功能配置。

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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeCdnDomainStagingConfig

系统规定参数。取值:DescribeCdnDomainStagingConfig

DomainName String example.com

加速域名,仅支持单个查询。

FunctionNames String aliauth

功能名称列表,多个用半角逗号(,)分隔,可配置功能请参见功能列表

返回数据

名称 类型 示例值 描述
DomainName String example.com

加速域名。

RequestId String C80705BF-0F76-41FA-BAD1-5B59296A4E59

请求ID。

DomainConfigs Array of DomainConfig

域名配置列表。

Status String success

配置状态。取值:

  • testing:配置校验中。
  • configuring:配置中。
  • success:成功。
  • failed:失败。
ParentId String 222728944812032

规则条件ID,非必填项。通过配置域名配置功能参数中的功能函数condition(规则引擎),可以创建出规则条件(规则条件可以通过识别用户请求中携带的各种参数来匹配和过滤用户请求),每一个规则条件被创建以后都会生成一个对应的ConfigId,ConfigId可以被当作ParentId参数被其他功能函数引用,这样规则条件就可以与功能配置一起组合形成更灵活的配置。

具体配置操作请参考批量配置域名或下文ParentId配置示例说明。

ConfigId String 6xx5

配置ID。

FunctionName String aliauth

功能名称。

FunctionArgs Array of FunctionArg

各个功能说明。

ArgName String auth_type

配置名称。

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

示例

请求示例

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

正常返回示例

XML格式

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

<DescribeCdnDomainStagingConfigResponse>
    <DomainName>example.com</DomainName>
    <RequestId>C80705BF-0F76-41FA-BAD1-5B59296A4E59</RequestId>
    <DomainConfigs>
        <Status>success</Status>
        <ParentId>222728944812032</ParentId>
        <ConfigId>6xx5</ConfigId>
        <FunctionName>aliauth</FunctionName>
        <FunctionArgs>
            <ArgName>auth_type</ArgName>
            <ArgValue>req_auth</ArgValue>
        </FunctionArgs>
    </DomainConfigs>
</DescribeCdnDomainStagingConfigResponse>

JSON格式

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

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

错误码

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

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