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

说明 目前服务地址仅支持:华东2(上海)

调试

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

请求参数

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

系统规定参数。取值:DescribeVodDomainConfigs

DomainName String www.example.com

点播加速域名。

FunctionNames String filetype_based_ttl_set,set_req_host_header

功能列表名称。多个使用英文逗号(,)分隔。具体信息,请参见下表功能说明

功能说明

名称

说明

referer_white_list_set

refer白名单

referer_black_list_set

refer黑名单

filetype_based_ttl_set

文件过期时间设置

path_based_ttl_set

目录过期时间设置

cc_defense

防CC攻击

oss_auth

OSS鉴权Bucket

ip_black_list_set

IP黑名单

ip_white_list_set

IP白名单

error_page

错误页面重定向

tesla

页面优化加速

set_req_host_header

修改回源自定义头

set_hashkey_args

忽略url参数

aliauth

阿里鉴权

set_resp_header

设置响应头(浏览器端可见)

video_seek

视频切片拖拽开关

range

Range请求功能

gzip

页面Gzip优化

https_force

强制HTTPS跳转

http_force

强制HTTP跳转

alivod

视频点播配置

forward_scheme

自适应回源

tmd_signature

TMD自定义规则

返回数据

名称 类型 示例值 描述
RequestId String F8AA0364-0FDB-4AD5-****-D69FAB8924ED

请求ID。

DomainConfigs Array of DomainConfig

域名配置。

DomainConfig
Status String success

状态。取值:

  • success(配置成功)
  • testing(测试中)
  • failed(配置失败)
  • configuring(配置中)
ConfigId String 5003576

配置ID。

FunctionName String set_req_host_header

function名称。

FunctionArgs Array of FunctionArg

各个function。

FunctionArg
ArgName String file_type

配置名称。

ArgValue String txt

配置值。

示例

请求示例

https://vod.{ApiRegion}.aliyuncs.com/?Action=DescribeVodDomainConfigs
&DomainName=www.example.com
&FunctionNames=filetype_based_ttl_set,set_req_host_header
&<公共请求参数>

正常返回示例

XML格式

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

<DescribeVodDomainConfigsResponse>
    <RequestId>F8AA0364-0FDB-4AD5-****-D69FAB8924ED</RequestId>
	<DomainConfigs>
		<DomainConfig>
			<FunctionArgs>
				<FunctionArg>
					<ArgName>domain_name</ArgName>
					<ArgValue>www.example.com</ArgValue>
				</FunctionArg>
			</FunctionArgs>
			<ConfigId>5003576</ConfigId>
			<FunctionName>set_req_host_header</FunctionName>
		</DomainConfig>
		<DomainConfig>
			<FunctionArgs>
				<FunctionArg>
					<ArgName>file_type</ArgName>
					<ArgValue>txt</ArgValue>
				</FunctionArg>
				<FunctionArg>
					<ArgName>ttl</ArgName>
					<ArgValue>13</ArgValue>
				</FunctionArg>
				<FunctionArg>
					<ArgName>weight</ArgName>
					<ArgValue>8</ArgValue>
				</FunctionArg>
			</FunctionArgs>
			<ConfigId>5068995</ConfigId>
			<FunctionName>filetype_based_ttl_set</FunctionName>
		</DomainConfig>
	</DomainConfigs>
</DescribeVodDomainConfigsResponse>

JSON格式

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

{
  "RequestId" : "F8AA0364-0FDB-4AD5-****-D69FAB8924ED",
  "DomainConfigs" : {
    "DomainConfig" : [ {
      "FunctionArgs" : {
        "FunctionArg" : [ {
          "ArgName" : "domain_name",
          "ArgValue" : "www.example.com"
        } ]
      },
      "ConfigId" : 5003576,
      "FunctionName" : "set_req_host_header"
    }, {
      "FunctionArgs" : {
        "FunctionArg" : [ {
          "ArgName" : "file_type",
          "ArgValue" : "txt"
        }, {
          "ArgName" : "ttl",
          "ArgValue" : "13"
        }, {
          "ArgName" : "weight",
          "ArgValue" : "8"
        } ]
      },
      "ConfigId" : 5068995,
      "FunctionName" : "filetype_based_ttl_set"
    } ]
  }
}

错误码

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

接口错误码

下表列举了本接口特有的错误码。

错误代码

错误信息

HTTP 状态码

说明

DeleteFunctionFailed

Batch delete functions failed.

400

批量删除配置失败。

InvalidFunctionName.ValueNotSupported

FunctionName %s is not supported.

400

不支持的FunctionName %s(%s为具体功能名)。