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. For more information, see the "Feature description" section.

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 name 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: no_auth and type_a.

auth_key1: the primary authentication key.

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.

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.

tmd_signature: configures TMD rules.

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

path: the URI path. You can specify duplicate URI paths. You must verify the validity of each URI path.

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.

https_tls_version: TLS protocol version.

tls10: Open TLSv1.0. The default is on. Valid values: on and off.

tls11: Open TLSv1.1. The default is on. Valid values: on and off.

tls12: Open TLSv1.2. The default is on. Valid values: on and off.

tls13: Open TLSv1.3. The default is on. Valid values: on and off.

Note All parameter values are of the string type. 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.

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.