Configure CDN for domain names with BatchSetVodDomainConfigs - ApsaraVideo VOD - Alibaba Cloud - ApsaraVideo VOD

Configures multiple accelerated domain names in a batch.

Operation description

Currently, the only supported service region is China (Shanghai).
You can configure up to 50 domain names at a time.
After you call this operation to configure certain features for domain names, a unique ConfigId is generated. You can use the ConfigId to update or delete domain name configurations. This operation does not return the ConfigId. To obtain the ConfigId, call the DescribeVodDomainConfigs operation.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

vod:BatchSetVodDomainConfigs

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
DomainNames	string	Yes	The accelerated domain names for ApsaraVideo VOD. Separate multiple domain names with commas (,). You can configure up to 50 domain names at a time.	example.com
Functions	string	Yes	The list of features. functionName (feature name, required): For the features that can be configured and their feature name parameters, see Domain name configuration features. argName (parameter name, required): The configuration items of functionName. You can configure multiple configuration items. argValue (parameter value, required): The values of the configuration items of functionName. For detailed information about the features that can be configured for accelerated domain names, including feature names and parameter names, see Domain name configuration features. Note Some features, such as filetype_based_ttl_set (file expiration time), support multiple configuration rules. To update a specific configuration rule, specify the configId of that rule. Example: `[{"functionArgs":[{"argName":"file_type","argValue":"jpg"},{"argName":"ttl","argValue":"18"},{"argName":"weight","argValue":"30"}],"functionName":"filetype_based_ttl_set","configId":5068995}]`	[{"functionArgs":[{"argName":"domain_name","argValue":"www.example.com"}],"functionName":"set_req_host_header"}]

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 elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	04F0F334-1335-436C-****-6C044FE73368

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidFunctions.Malformed	The specified Functions is incorrectly formatted.
400	InvalidArgValue.Malformed	The specified ArgValue is invalid.
400	Invalid%s.ValueNotSupported	[%s] is not supported.
400	Invalid%s.Malformed	The specified ArgValue [%s] is invalid.
400	MissingParameter%s	The specified value of ArgName[%s] is missing.
400	InvalidFunctionArgs.Malformed	The specified FunctionArgs is invalid.
400	MissingParameter	The specified ArgValue is missing.
400	InvalidHeaderKey.ValueNotSupported	The specified value of parameter HeaderKey is not supported.
400	TooManyDomains	The count of domain is over 50.
400	InvalidRule.Malformed	%s
400	InvalidFunction.NotSupported	The domain is not supported to set the function.
400	InvalidDomain.BelongToConfigGroup	This Domain activated in configuration group and should modify by config group.
400	EntityNotExist.Role	EntityNotExist.Role
400	MissingParameterFunctions	The specified value of Functions is missing.
400	NoPermission.SLR	The current user does not have permission to create servicelinkedrole. Please contact the Alibaba Cloud account or administrator to authorize AliyunCDNFullAccess or custom policy:Service Name:cdn-ddos.cdn.aliyuncs.com,Role: AliyunServiceRoleForCDNAccessingDDoS,Permission: ram: CreateServiceLinkedRole
400	ConfigExceedLimit	Count of config entries exceeds the limit.
400	EdgeScriptCountExceedLimit	The number of rules exceeds the default limit (1). To increase the limit, submit a ticket.	You can configure only one script. To increase the limit, submit a ticket.
400	EdgeScripOptionsHasInnerConfig	The extension has a background configuration or a parameter of this configuration is invalid. For more information, submit a ticket.
400	EdgeScriptGrammarNotSupport	A background customization rule exists or a parameter of this configuration is invalid. For more information, submit a ticket.
400	EdgeScriptNotSupportJs	JavaScript rules are not supported. For more information, submit a ticket.
400	ServiceInvokeFailed	Failed to invoke service.
400	ConfigurationConflicts	Failed to modify the parameter settings in the production environment because the parameter settings are different from those in the staging environment. Set parameters in the staging environment before you publish them to the production environment.	Failed to modify the parameter settings in the production environment because the parameter settings are different from those in the staging environment. Set parameters in the staging environment before you publish them to the production environment.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.