首页 CDN API参考指南 API目录 域名管理相关接口 域名配置 DescribeCdnDomainConfigs - 查询域名配置

DescribeCdnDomainConfigs - 查询域名配置

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

接口说明

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

调试

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

调试

授权信息

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

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

请求参数

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

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

example.com
FunctionNamesstring

功能函数名称,多个用英文逗号(,)分隔。更多功能名称,请参见域名配置功能参数

aliauth
ConfigIdstring

功能配置ID。ConfigId查询和使用,请参见ConfigId使用说明

6295

返回参数

名称类型描述示例值
object
RequestIdstring

请求ID。

C80705BF-0F76-41FA-BAD1-5B59296A4E59
DomainConfigsarray

域名配置。

object
Statusstring

配置状态。取值:

  • success:成功。

  • testing:测试中。

  • failed:失败。

  • configuring:配置中。

success
ParentIdstring

规则条件ID,非必填项。

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

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

222728944812032
ConfigIdstring

配置ID。

6295
FunctionNamestring

功能函数名称。

aliauth
FunctionArgsarray

各个功能函数所对应的参数配置。

object
ArgNamestring

参数名称,functionName的配置项(可配置多个配置项)。

auth_type
ArgValuestring

参数值,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": [
    {
      "Status": "success",
      "ParentId": "222728944812032",
      "ConfigId": "6295",
      "FunctionName": "aliauth",
      "FunctionArgs": [
        {
          "ArgName": "auth_type",
          "ArgValue": "req_auth"
        }
      ]
    }
  ]
}

错误码

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

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

阿里云首页 CDN 相关技术圈