全部产品
Search

搜索本产品

    CDN：DescribeCdnDomainStagingConfig - 查询模拟环境配置

    文档中心

    CDN：DescribeCdnDomainStagingConfig - 查询模拟环境配置

    更新时间：Aug 06, 2024

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

    接口说明

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

    调试

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

    授权信息

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

    • 操作：是指具体的权限点。
    • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
    • 资源类型：是指操作中支持授权的资源类型。具体说明如下：
      • 对于必选的资源类型，用背景高亮的方式表示。
      • 对于不支持资源级授权的操作，用全部资源表示。
    • 条件关键字：是指云产品自身定义的条件关键字。
    • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
    操作访问级别资源类型条件关键字关联操作
    cdn:DescribeCdnDomainStagingConfigget
    • Domain
      acs:cdn:*:{#accountId}:domain/{#DomainName}
      无
    		无

    请求参数

    名称类型必填描述示例值
    DomainNamestring是

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

    		example.com
    FunctionNamesstring否

    功能名称列表，多个用半角逗号（,）分隔，可配置功能请参见功能列表。

    		aliauth

    返回参数

    名称类型描述示例值
    object
    DomainNamestring

    加速域名。

    		example.com
    RequestIdstring

    请求 ID。

    		C80705BF-0F76-41FA-BAD1-5B59296A4E59
    DomainConfigsarray<object>

    域名配置列表。

    object
    Statusstring

    配置状态。取值：

    • testing：配置校验中。
    • configuring：配置中。
    • success：成功。
    • failed：失败。
    		success
    ParentIdstring

    规则条件 ID，非必填项。通过配置域名配置功能参数中的功能函数 condition（规则引擎），可以创建出规则条件（规则条件可以通过识别用户请求中携带的各种参数来匹配和过滤用户请求），每一个规则条件被创建以后都会生成一个对应的 ConfigId ，ConfigId 可以被当作 ParentId 参数被其他功能函数引用，这样规则条件就可以与功能配置一起组合形成更灵活的配置。 具体配置操作请参考批量配置域名或下文 ParentId 配置示例说明。

    		222728944812032
    ConfigIdstring

    配置 ID。

    		6xx5
    FunctionNamestring

    功能名称。

    		aliauth
    FunctionArgsarray<object>

    各个功能说明。

    object
    ArgNamestring

    配置名称。

    		auth_type
    ArgValuestring

    配置值。

    		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格式

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

    错误码

    HTTP status code错误码错误信息描述
    400Invalid%s.ValueNotSupportedFunctionName [%s] is not supported.此方法不支持。

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

    变更历史

    变更时间变更内容概要操作
    暂无变更历史