Queries the information on how a domain name is mapped with another domain name.

Usage note

The domain name, namely, the ingest domain name, the main streaming name, or the sub-streaming domain, is mandatory for calling this operation.

QPS limit

A single user can perform a maximum of 500 queries per minute. Throttling is triggered when the number of calls per second exceeds the QPS limit. The throttling may affect your business. Thus, we recommend that you observe the QPS limit on this operation. For more information about what a single user means and the QPS details, see QPS limit on an API operation in ApsaraVideo Live.


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 DescribeLiveDomainMapping

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

DomainName String Yes example.com

The domain name whose mapping configuration you want to query. It can be one of the following:

  • The ingest domain.
  • The main streaming domain.
  • The sub-streaming domain.
RegionId String No cn-beijing

The ID of the region where the streaming domain resides.

Response parameters

Parameter Type Example Description
LiveDomainModels Array of LiveDomainModel

The information about the mapped domain names.

DomainName String example.aliyundoc.com

The domain name that is mapped to the domain name being queried.

Type String play

The type of the domain name mapped to the domain name being queried. Valid values:

  • vhost: a main streaming domain.
  • publish: an ingest domain.
  • play: a sub-streaming domain.
RequestId String 16A96B9A-F203-4EC5-8E43-CB92E68F6CD8

The ID of the request.


Sample requests

&<Common request parameters>

Sample success responses

XML format


JSON format

    "RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F6CD8",
    "LiveDomainModels": {
        "LiveDomainModel": {
            "Type": "play",
            "DomainName": "example.aliyundoc.com"

Error codes

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