Configures one or more domain names for CDN.

Note This operation is available only in the China (Shanghai) region.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes BatchSetVodDomainConfigs

The operation that you want to perform. Set the value to BatchSetVodDomainConfigs.

DomainNames String Yes example.com

The domain name for CDN. Separate multiple domain names with commas (,).
Functions String Yes [{"functionArgs":[{"argName":"domain_name","argValue":"www.example.com"}],"functionName":"set_req_host_header"}]

The features to configure.

  • Set this parameter in the following format: [{"functionArgs":[{"argName":"domain_name","argValue":"www.example.com"}],"functionName":"set_req_host_header"}].
  • Specific features, such as filetype_based_ttl_set, support more than one configuration record. To update one of the configuration records, use the configId field to specify the record. [{"functionArgs":[{"argName":"file_type","argValue":"jpg"},{"argName":"ttl","argValue":"18"},{"argName":"weight","argValue":"30"}],"functionName":"filetype_based_ttl_set","configId":5068995}]
  • For more information, see the Feature description section.

Feature description

All parameter values are of the string type.

Feature

Description

Parameter

referer_white_list_set

Specifies the referer whitelist.

refer_domain_allow_list: the referers to be added to the whitelist. Separate multiple referers with commas (,).

allow_empty: specifies whether an empty referer is allowed. Valid values: on and off.

referer_black_list_set

Specifies the referer blacklist.

refer_domain_deny_list: the referers to be added to the blacklist. Separate multiple referers with commas (,).

allow_empty: specifies whether an empty referer is allowed. Valid values: on and off.

filetype_based_ttl_set

Specifies the time period after which a file expires.

ttl: the expiration time of the cached content. Unit: seconds.

file_type: the file type. Separate multiple file types with commas (,). Example: txt,jpg.

weight: the weight of the file in the cache. Valid values: 1 to 199.

path_based_ttl_set

Specifies the time period after which a directory expires.

ttl: the expiration time of the cached content. Unit: seconds.

path: the directory, which must start with a forward slash (/).

weight: the weight of the directory in the cache. Valid values: 1 to 99.

oss_auth

Configures authentication for the access to an Object Storage Service (OSS) bucket.

oss_bucket_id: the ID of the bucket.

ip_black_list_set

Specifies the IP address blacklist.

ip_list: the IP addresses to be added to the whitelist. Separate multiple IP addresses with commas (,).

ip_allow_list_set

Specifies the IP address whitelist.

ip_list: the IP addresses to be added to the whitelist. Separate multiple IP addresses with commas (,).

ip_white_list_set

Specifies the self-defined rules for the rate limit.

ip_list: the IP addresses to be added to the whitelist. Separate multiple IP addresses with commas (,).

error_page

Redirects an error page to a specified page.

error_code: the error code.

rewrite_page: the page to which the error page is redirected.

set_req_host_header

Modifies the custom header of back-to-origin requests.

domain_name: the custom host header of back-to-origin requests.

set_hashkey_args

Ignores the specified URL parameters.

hashkey_args: the parameters to be reserved. Separate multiple parameters with commas (,).

disable: specifies whether to ignore all parameters. A value of on indicates that all parameters are ignored. A value of off indicates that none of the parameters are ignored.

aliauth

Configures Alibaba Cloud authentication.

auth_type: the authentication type. Valid values: no_auth, type_a, type_b, and type_c.

auth_key1: the primary authentication key.

auth_key2: the secondary authentication key.

ali_auth_delta: the custom buffer time for authentication.

ali_auth_remote_desc: the pattern matching string.

set_resp_header

Specifies a response header. To verify the setting, you can check the response message in a browser.

key: the name of the response header. Valid values: 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, and Access-Control-Expose-Headers.

value: the content of the response header. If you want to delete the header, enter null.

https_force

Configures force redirect to HTTPS.

enable: specifies whether to enable force redirect to HTTPS. Valid values: on and off.

http_force

Configures force redirect to HTTP.

enable: specifies whether to enable force redirect to HTTP. Valid values: on and off.

l2_oss_key

Configures private key authentication for back-to-origin requests from L2 nodes to private OSS buckets.

private_oss_auth: specifies whether to authenticate the access to a private OSS bucket. Valid values: on and off.

green_manager

Configures pornography detection.

enable: specifies whether to enable pornography detection. Valid values: on and off.

range

Configures object chunking.

enable: specifies whether to enable object chunking. Valid values: on, off, and force.

video_seek

Configures video seeking.

enable: specifies whether to enable video seeking. Valid values: on and off.

set_hashkey_args

Ignores the specified URL parameters.

hashkey_args: the parameters to be reserved. Separate multiple parameters with commas (,).

disable: specifies whether to ignore all parameters. A value of on indicates that all parameters are ignored. A value of off indicates that none of the parameters are ignored.

tmd_signature

Specifies the self-defined rules for the rate limit.

name: the name of the rule, which must be unique in the domain name.

path: the URI path. You can specify duplicate URI paths. However, you must verify their validity.

pathType: the matching rule. Valid values: 0 and 1. A value of 0 indicates a prefix match. A value of 1 indicates an exact match.

interval: the interval at which data is monitored. Unit: seconds. The interval must be greater than or equal to 10 seconds.

count: the number of visits from an IP address.

action: the operation to be performed after the specified conditions are met. Valid values: 0 and 1. A value of 0 indicates blocking. A value of 1 indicates bot detection.

ttl: the time period during which access is blocked. Unit: seconds.

ali_business

Configures custom features.

ali_business_type: required. The business type.

ali_business_table: the pattern matching string.

hls_token_rewrite

Configures M3U8 encryption and rewriting.

enable: required. Specifies whether to enable M3U8 encryption and rewriting. Valid values: on and off.

hls_token_arg_name: the name of the appended parameter. If you do not specify the name, the parameter name MtsHlsUriToken is used.

Response parameters

Parameter Type Example Description
RequestId String 04F0F334-1335-436C-****-6C044FE73368

The ID of the request.

Examples

Sample requests

https://vod.{ApiRegion}.aliyuncs.com/?Action=BatchSetVodDomainConfigs
&DomainNames=example.com
&Functions=[{"functionArgs":[{"argName":"domain_name","argValue":"www.example.com"}],"functionName":"set_req_host_header"}]
&<Common request parameters>

Sample success responses

XML format 

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

JSON format 

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

Error codes

For a list of error codes, visit the API Error Center.

Common errors

The following table describes the common errors that this operation can return.

Error code

Error message

HTTP status code

Description

InvalidFunctions.Malformed

Specified Functions is malformed.

400

The error message returned because the value of the Functions parameter is invalid.

InvalidFunctionName.ValueNotSupported

FunctionName %s is not supported.

400

The error message returned because the %s feature name is invalid.

InvalidArgName.ValueNotSupported

ArgName %s is not supported.

400

The error message returned because the %s parameter is invalid.

InvalidArgValue.Malformed

Specified ArgValue is malformed.

400

The error message returned because the value of the argValue field is invalid.