批量配置加速域名。

调试

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

请求参数

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

系统规定参数,取值:BatchSetVodDomainConfigs

DomainNames String example.com

点播加速域名,多个使用英文逗号(,)分隔。

Functions String [{"functionArgs":[{"argName":"domain_name","argValue":"www.example.com"}],"functionName":"set_req_host_header"}]

功能列表。

  • Functions格式:[{"functionArgs":[{"argName":"domain_name","argValue":"www.example.com"}],"functionName":"set_req_host_header"}]
  • 某些功能,如filetype_based_ttl_set,可以设置多条纪录,当需要更新其中某条纪录时,可通过该条纪录的configId来指定。 [{"functionArgs":[{"argName":"file_type","argValue":"jpg"},{"argName":"ttl","argValue":"18"},{"argName":"weight","argValue":"30"}],"functionName":"filetype_based_ttl_set","configId":5068995}]

功能说明

所有参数值均按照字符串类型处理。

名称

描述

参数

referer_white_list_set

refer白名单

refer_domain_allow_list:白名单列表,多个使用英文逗号(,)分隔。

allow_empty:是否允许空refer进入,取值:on/off。

referer_black_list_set

refer黑名单

refer_domain_deny_list:黑名单列表,多个使用英文逗号(,)分隔。

allow_empty:是否允许空refer进入,取值:on/off 。

filetype_based_ttl_set

文件过期时间设置

ttl:cache时间,单位:秒。

file_type:文件类型,支持多个,使用英文逗号(,)分隔。如:txt,jpg。

weight:权重,取值范围1~199

path_based_ttl_set

目录过期时间设置

ttl:cache时间,单位:秒。

path:目录,必须以正斜线(/)开头。

weight:权重,取值范围1~99

oss_auth

OSS鉴权Bucket

oss_bucket_id:用户bucket地址。

ip_black_list_set

IP黑名单

ip_list:IP列表多个使用英文逗号(,)分隔。

ip_allow_list_set

IP白名单

ip_list:IP列表多个使用英文逗号(,)分隔。

ip_white_list_set

TMD免拦截

ip_list:IP列表多个使用英文逗号(,)分隔。

error_page

错误页面重定向

error_code:错误码。

rewrite_page:重定向页面。

set_req_host_header

修改回源自定义头

domain_name:回源Host头内容。

set_hashkey_args

忽略url参数

hashkey_args:保留参数的列表,多个使用英文逗号(,)分隔。

disable:disable等于on的时候表示忽略所有参数,off不忽略。

aliauth

阿里鉴权

auth_type:鉴权类型,取值范围:”no_auth”,”type_a”,”type_b”,”type_c”。

auth_key1:鉴权key1。

auth_key2:鉴权key2。

ali_auth_delta:自定义鉴权缓冲时间。

ali_auth_remote_desc:模式字符串。

set_resp_header

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

key:响应头,取值:Content-Type,Cache-Control,Content-Disposition,Content-Language,Expires,Access-Control-Allow-Origin,Access-Control-Allow-Methods,Access-Control-Allow-Headers,Access-Control-Max-Age,Access-Control-Expose-Headers。

value:响应头内容,删除填写null。

https_force

强制HTTPS跳转

enable:功能开关,取值:on/off 。

http_force

强制HTTP跳转

enable:功能开关,取值:on/off 。

l2_oss_key

L2 OSS 回源私钥

private_oss_auth:是否开启私有oss鉴权功能,取值:on/off 。

green_manager

鉴黄功能

enable:是否开启鉴黄功能,取值:on/off 。

range

range回源

enable:开关,支持on/off/force

video_seek

视频拖拽播放

enable:开关,支持on/off

set_hashkey_args

忽略url参数

hashkey_args:保留参数的列表,多个使用英文逗号(,)分隔。

disable:disable等于on的时候表示忽略所有参数,off不忽略 。

tmd_signature

TMD自定义规则

name:规则名称,域名内不可重复。

path:可重复,需校验URL路径合法性。

pathType:匹配规则,0表示前缀匹配,1表示完全匹配。

interval:监测时长,单位为秒,参数必须大于等于10

count:单IP访问次数。

action:阻断类型,0表示封禁,1表示人机识别。

ttl:阻断时长,单位为秒。

ali_business

特定用户定制

ali_business_type:必填,业务类型。

ali_business_table:模式字符串 。

hls_token_rewrite

M3U8标准加密改写

enable:必填,开关,支持on/off。

hls_token_arg_name:追加参数名称,如果不设置,使用MtsHlsUriToken作为追加的参数名。

返回数据

名称 类型 示例值 描述
RequestId String 04F0F334-1335-436C-****-6C044FE73368

请求ID。

示例

请求示例

http(s)://[Endpoint]/?Action=BatchSetVodDomainConfigs
&DomainNames=example.com
&Functions=[{"functionArgs":[{"argName":"domain_name","argValue":"www.example.com"}],"functionName":"set_req_host_header"}]
&<公共请求参数>

正常返回示例

XML 格式

<BatchSetVodDomainConfigsResponse>
  <RequestId>04F0F334-1335-436C-****-6C044FE73368</RequestId>
</BatchSetVodDomainConfigsResponse>

JSON 格式

{
    "RequestId": "04F0F334-1335-436C-****-6C044FE73368"
}

错误码

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

接口错误码

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

错误代码

错误信息

HTTP 状态码

说明

InvalidFunctions.Malformed

Specified Functions is malformed.

400

指定的 Functions 不合法

InvalidFunctionName.ValueNotSupported

FunctionName %s is not supported.

400

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

InvalidArgName.ValueNotSupported

ArgName %s is not supported.

400

不支持的ArgName %s(%s为具体参数名)

InvalidArgValue.Malformed

Specified ArgValue is malformed.

400

指定的 ArgValue 不合法