文档

DescribeVsDomainConfigs - 查询域名配置

更新时间:

查询域名配置,一次可查询多个功能配置。

调试

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

授权信息

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

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

请求参数

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

您的加速域名。

example.aliyundoc.com
FunctionNamesstring

功能列表名称。

说明 支持多个,用英文逗号(,)分隔。
path_based_ttl_set,oss_auth

功能说明

名称参数
referer_white_list_setrefer 白名单。
referer_black_list_setrefer 黑名单。
filetype_based_ttl_set文件过期时间设置。
path_based_ttl_set目录过期时间设置。
cc_defense防 CC 攻击。
oss_authOSS 鉴权 Bucket。
ip_black_list_setIP 黑名单。
ip_white_list_setIP 白名单。
error_page错误页面重定向。
tesla页面优化加速。
set_req_host_header修改回源自定义头。
set_hashkey_args忽略 URL 参数。
aliauth阿里鉴权。
set_resp_header设置响应头(浏览器端可见)。
video_seek视频切片拖拽开关。
rangeRange 请求功能。
gzip页面 Gzip 优化。
https_force强制 HTTPS 跳转。
http_force强制 HTTP 跳转。
alilive视频直播配置。
forward_scheme静态协议跟随回源。
tmd_signature配置频次控制自定义规则。
cdn_wafWAF 基础防护。

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

D94D0E1E-E71B-562D-8C18-969BB3653FBD
DomainConfigsarray<object>

域名配置。

object
Statusstring

状态。取值包括:

  • success
  • testing
  • failed
  • configuring
success
ConfigIdstring

配置 ID。

6295
FunctionNamestring

function 名称。

aliauth
FunctionArgsarray<object>

各个 function。

object
ArgNamestring

配置名称。

auth_type
ArgValuestring

配置值。

req_auth

示例

正常返回示例

JSON格式

{
  "RequestId": "D94D0E1E-E71B-562D-8C18-969BB3653FBD",
  "DomainConfigs": [
    {
      "Status": "success",
      "ConfigId": "6295",
      "FunctionName": "aliauth",
      "FunctionArgs": [
        {
          "ArgName": "auth_type",
          "ArgValue": "req_auth"
        }
      ]
    }
  ]
}

错误码

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

特殊错误码

错误代码描述HTTP 状态码语义
InvalidFunctionName.ValueNotSupportedFunctionName %s is not supported.400不支持的 FunctionName %s(%s 为具体功能名)。