Configures one or more streaming domains.

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 BatchSetLiveDomainConfigs

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

DomainNames String Yes play.yourdomain.com

The streaming domain. Separate multiple streaming domains with commas (,).

Functions String Yes [{"functionArgs":[{"argName":"file_type","argValue":"jpg"},{"argName":"ttl","argValue":"18"},{"argName":"weight","argValue":"30"}],"functionName":"filetype_based_ttl_set","configId":506***}]

The features to configure.

Specific features, such as filetype_based_ttl_set, support multiple configuration records. To update one of the configuration records, use the configId field to specify the record. For more information, see the Feature description section of this topic.

Feature description

Feature

Description

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 (,).

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 path of your OSS bucket.

ip_black_list_set: specifies the IP address blacklist.

ip_list: the IP addresses to be added to the blacklist. 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 Taobao Missile Defense (TMD) whitelist.

ip_list: the IP addresses to be added to the TMD 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 host header of back-to-origin requests.

domain_name: the 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: type_a and no_auth. A value of type_a indicates that authentication type A is enabled. A value of no_auth indicates that authentication is disabled.

auth_key1: the primary authentication key. The authentication key must be 16 to 32 characters in length and can contain uppercase letters, lowercase letters, and digits.

auth_key2: the secondary authentication key.

ali_auth_delta: the custom buffer time for authentication.

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<br>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: the content of the response header. If you want to delete the header, enter null.

https_force: configures forcible redirect to HTTPS.

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

http_force: configures forcible redirect to HTTP.

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

forward_scheme: configures adaptive back-to-origin.

enable: specifies whether to enable adaptive back-to-origin. Valid values: on and off.

scheme_origin: specifies the protocol of the origin. Valid values: http, https, and follow.

scheme_origin_port: specifies the port number of the origin. Valid values: 80, 443, and 80:443.

green_manager: configures pornography detection.

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

tmd_signature: configures TMD rules.

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

path: the uniform resource identifier (URI). You can specify duplicate URIs. 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.

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.

range: configures object chunking.

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

video_seek: configures video seeking.

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

gzip: configures GNU zip (Gzip) compression.

enable: specifies whether to enable Gzip compression. Valid values: on and off.

tesla: configures page optimization to accelerate access.

enable: specifies whether to enable page optimization to accelerate access. Valid values: on and off.

ali_ua: configures user-agent-based access control.

ua: the user agent.

type: the type of the list. Valid values: black and white.

host_redirect: configures URL rewrite.

regex: the URL to be rewritten. Example: ^/$.

replacement: the URL after rewrite. Example: /go/act/sale/tbzlsy.php.

flag: the action. Valid values: redirect and break.

ipv6: configures IPv6.

switch: required. Specifies whether to enable IPv6. Valid values: on and off. If you want to disable IPv6 after IPv6 is enabled, you must not delete the configuration. Otherwise, the setting does not take effect.

region: the region where IPv6 is enabled.

ali_location: configures region-based access control.

location: the regions.

type: the type of the list. Valid values: black and white.

cc_defense: configures protection against HTTP flood attacks.

enable: specifies whether to enable protection against HTTP flood attacks. Valid values: on and off.

alilive: configures the ApsaraVideo Live service.

notify_url: the URL for receiving notifications from ApsaraVideo Live.

enable: specifies whether to enable the protocol prohibition feature. Valid values: on and off.

live_forbid_flv: specifies whether to prohibit the playback of FLV videos. Valid values: on and off.

live_forbid_rtmp: specifies whether to prohibit the playback of Real-Time Messaging Protocol (RTMP) videos. Valid values: on and off.

live_forbid_hls: specifies whether to prohibit the playback of HTTP-Live-Streaming (HLS) videos. Valid values: on and off.

ali_grtn: connects to Global Realtime Transport Network (GRTN).

grtn_rts_pub: specifies whether to enable Real-Time Streaming (RTS) stream ingest for ingest domains. Valid values: on and off.

grtn_rts_play: specifies whether to enable RTS streaming for streaming domains. Valid values: on and off.

edge_function: configures scripts in EdgeScript.

Required parameters:

rule: the domain-specific language (DSL) script.

pri: the priority of the script.

enable: specifies whether to enable the script. Valid values: on and off.

Optional parameters:

name: the name of the script.

pos: specifies the position to execute the script.

brk: After the current script is matched, the subsequent scripts at the specified position are skipped.

option: the extension used to perform response header debugging.

grammar: the extension used to specify the scripting language. Valid values: es2 and js. You can also leave this parameter unspecified.

jsmode: the extension used to manage the domain name whitelist in JavaScript. Valid value: redirect and bypass.

https_tls_version: the version of the Transport Layer Security (TLS) protocol.

tls10: specifies whether to enable TLS 1.0. Default value: on. Valid values: on and off.

tls11: specifies whether to enable TLS 1.1. Default value: on. Valid values: on and off.

tls12: specifies whether to enable TLS 1.2. Default value: on. Valid values: on and off.

tls13: specifies whether to enable TLS 1.3. Default value: on. Valid values: on and off.

Response parameters

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

The ID of the request.

Examples

Sample requests

http(s)://live.aliyuncs.com/?Action=BatchSetLiveDomainConfigs
&DomainNames=play.yourdomain.com
&Functions= [{"functionArgs":[{"argName":"file_type","argValue":"jpg"},{"argName":"ttl","argValue":"18"},{"argName":"weight","argValue":"30"}],"functionName":"filetype_based_ttl_set","configId":506***}]
&<Common request parameters>

Sample success responses

XML format

<BatchSetLiveDomainConfigsResponse>
	  <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>
</BatchSetLiveDomainConfigsResponse>

JSON format

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

Error codes

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

Error code

Error message

HTTP status code

Description

InvalidFunctions.Malformed

Specified Functions is malformed.

400

The error message returned because the Functions parameter is invalid.

InvalidFunctionName.ValueNotSupported

unctionName %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 specified parameter value is invalid.