DescribeLiveDomainConfigs - ApsaraVideo Live - Alibaba Cloud Documentation Center

Operation description

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.

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

live:DescribeLiveDomainConfigs

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
DomainName	string	Yes	The ingest domain or streaming domain.	demo.aliyundoc.com
FunctionNames	string	Yes	The names of the features. Separate multiple features with commas (,). For more information, see the Features specified by the Functions parameter section in this topic.	set_req_host_header,set_hashkey_args

Features specified by the Functions 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 the configId field to specify the record.

Name	Parameter
referer_white_list_set: 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: 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: 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: 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: 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: 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: 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 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. 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 specifies that authentication type A is enabled. A value of no_auth specifies 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. 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 duration for authentication.- retry: the number of retries upon authentication timeout.- timeout: the action to perform upon authentication timeout. Valid values: pass and 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 redirection 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 redirection 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 video seeking. Valid values: on and off.
gzip: configures 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 the feature. Valid values: on and off.
ali_ua: configures User-Agent-based access control.	ua: the User-Agent type. Valid values: black and white.
host_redirect: configures URL rewrite.	regex: the URL to be rewritten, for example, ^/$.replacement: the final URL, for 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 Videos (FLVs).	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 elements

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

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
400	Invalid%s.ValueNotSupported	FunctionName [%s] is not supported.
404	InvalidUser	The user's account is invalid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.