DescribeLiveDomainConfigs - ApsaraVideo Live - Alibaba Cloud Documentation Center

Usage notes

You can call this operation to query multiple configurations at a time.

QPS limit

You can call this operation up to 100 times per second per account. Requests that exceed this limit are dropped, and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see QPS limits.

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	DescribeLiveDomainConfigs	The operation that you want to perform. Set the value to DescribeLiveDomainConfigs.
DomainName	String	Yes	demo.aliyundoc.com	The ingest domain or streaming domain.
FunctionNames	String	Yes	set_req_host_header,set_hashkey_args	The names of the features. Separate multiple features with commas (,). For more information, see the Features specified by the FunctionNames parameter section of this topic.

Features specified by the FunctionNames parameter

Note All parameter values are of the string type. Some features, such as filetype_based_ttl_set, support multiple configuration records. To update one of the configuration records, use configId to identify the record.

Feature	Attribute
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 cache duration. Unit: seconds. file_type: the file type. Separate multiple file types with commas (,). weight: the weight of the file type. Valid values: 1 to 99.
path_based_ttl_set: specifies the time period after which a directory expires.	ttl: the cache duration. Unit: seconds. path: the directory, which must start with a forward slash (/). weight: the weight of the directory. Valid values: 1 to 99.
oss_auth: authenticates 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 IP address whitelist for rate limiting.	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 specific 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. Valid values: on and off. A value of on specifies that all parameters are ignored. A value of off specifies 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 letters and digits. auth_key2: the secondary authentication key. ali_auth_delta: the custom buffer time for authentication. Unit: seconds. We recommend that you set the value to at least 60 seconds.
remote_auth: configures remote authentication for live streaming.	enable: specifies whether to enable remote authentication. This attribute is required. Valid values: on and off. remote_auth_path: the address of the authentication server. This attribute is required. remote_auth_pattern: the authentication mode. The following fields are available: param: specifies whether to pass parameters in the ingest URL to the authentication server. Valid values: pass (default) and fail. args_white: the parameter that you want to pass. Separate multiple parameters with commas (,). args_black: the parameter that you do not want to pass. Separate multiple parameters with commas (,). code: the HTTP status code. A value in the form of code=XXX is returned by the authentication server to ApsaraVideo Live upon successful authentication. Example: code=200. A value in the form of code=~XXX is returned by the authentication server to ApsaraVideo Live upon failed authentication. Example: code=~403. delta: the timeout period for authentication. retry: the number of retries upon authentication timeout. timeout: the action to perform upon authentication timeout. Valid values: pass or fail. pass: ApsaraVideo Live passes the request. fail: ApsaraVideo Live returns the HTTP status code 403 that indicates failure. async: specifies whether to enable asynchronous authentication. Valid values: on and off (default).
set_resp_header: configures a response header. To verify the configuration, 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 the feature. Valid values: on and off. The https_force and http_force features are mutually exclusive. You cannot configure them both. If you have configured one of the features, you must delete it before you can configure the other feature.
http_force: configures force redirect to HTTP.	enable: specifies whether to enable the feature. Valid values: on and off. The https_force and http_force features are mutually exclusive. You cannot configure them both. If you have configured one of the features, you must delete it before you can configure the other feature.
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 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 custom rate limiting rules.	name: the name of the rule, which must be globally unique. 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 specifies a prefix match. A value of 1 specifies 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 action to perform after the specified conditions are met. Valid values: 0 and 1. A value of 0 specifies that access is blocked. A value of 1 specifies that bot detection is performed. ttl: the time period during which access is blocked. Unit: seconds.
forward_scheme: configures adaptive back-to-origin.	enable: specifies whether to enable the feature. Valid values: on and off. scheme_origin: the protocol of the origin. Valid values: http, https, and follow. scheme_origin_port: the port number of the origin. Valid values: 80, 443, and 80:443.
video_seek: configures video seeking.	enable: specifies whether to enable the feature. Valid values: on and off.
gzip: configures Gzip compression.	enable: specifies whether to enable the feature. Valid values: on and off.
tesla: configures page optimization to accelerate access.	enable: specifies whether to enable the feature. Valid values: on and off.
ali_ua: configures User-Agent-based access control.	ua: the User-Agent. type: the type of the User-Agent list. Valid values: black and white.
host_redirect: configures URL rewrite.	regex: the URL to be rewritten. Example: ^/$. replacement: the destination URL. Example: /go/act/sale/tbzlsy.php. flag: the flag. Valid values: redirect and break.
ipv6: configures IPv6.	switch: specifies whether to enable IPv6. This attribute is required. Valid values: on and off. If you want to disable this feature after this feature is enabled, deselect the feature in the console. Do not delete the configuration. Otherwise, the feature is still enabled. region: the region in which you want to enable IPv6. Valid values: cn-beijing (Beijing), cn-shanghai (Shanghai), cn-shenzhen (Shenzhen), cn-qingdao (Qingdao), apsoutheast-1 (Singapore), eu-central-1 (Germany), ap-northeast-1 (Tokyo), and ap-southeast-5 (Jakarta).
ali_location: configures region-based access control.	location: the regions.
type: the type of the list.	Valid values: black and white.
enable: specifies whether to enable the feature.	Valid values: on and off.
live_forbid_flv: specifies whether to prohibit the playback of Flash Video (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.
https_option : configures HTTP settings.	http2: specifies whether to enable HTTP/2. Default value: off. Valid values: on and off. live_http2: specifies whether to enable live_http2. Default value: off. Valid values: on and off.

Response parameters

Parameter	Type	Example	Description
RequestId	String	F8AA0364-0FDB-4AD5-AC74-D69FAB8924ED	The request ID.
DomainConfigs	Array of DomainConfig		The configurations of the domain name.
DomainConfig
Status	String	success	The configuration status. Valid values: success testing failed configuring
ConfigId	String	5003576	The ID of the configuration.
FunctionName	String	set_req_host_header	The name of the feature.
FunctionArgs	Array of FunctionArg		The attributes of the feature.
FunctionArg
ArgName	String	domain_name	The attribute name.
ArgValue	String	developer.aliyundoc.com	The attribute value.

Examples

Sample requests

http(s)://live.aliyuncs.com/?Action=DescribeLiveDomainConfigs
&DomainName=demo.aliyundoc.com
&FunctionNames=set_req_host_header,set_hashkey_args
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<?xml version="1.0" encoding="UTF-8" ?>
<DescribeLiveDomainConfigsResponse>
<RequestId>F8AA0364-0FDB-4AD5-AC74-D69FAB8924ED</RequestId>
<DomainConfigs>
    <DomainConfig>
        <Status>success</Status>
        <FunctionName>set_req_host_header</FunctionName>
        <ConfigId>5003576</ConfigId>
        <FunctionArgs>
            <FunctionArg>
                <ArgValue>developer.aliyundoc.com</ArgValue>
                <ArgName>domain_name</ArgName>
            </FunctionArg>
        </FunctionArgs>
    </DomainConfig>
</DomainConfigs>
</DescribeLiveDomainConfigsResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "DescribeLiveDomainConfigsResponse" : {
    "RequestId" : "F8AA0364-0FDB-4AD5-AC74-D69FAB8924ED",
    "DomainConfigs" : {
      "DomainConfig" : {
        "Status" : "success",
        "FunctionName" : "set_req_host_header",
        "ConfigId" : 5003576,
        "FunctionArgs" : {
          "FunctionArg" : {
            "ArgValue" : "developer.aliyundoc.com",
            "ArgName" : "domain_name"
          }
        }
      }
    }
  }
}

Error codes

For a list of error codes, see Service error codes.