All Products
Search
Document Center

:DescribeLiveDomainMapping

Last Updated:May 08, 2024

Queries the mappings of an ingest domain, a main streaming domain, or a sub-streaming domain.

Usage notes

Obtain the domain name, and then call this operation to query the mappings of the domain name.

QPS limit

You can call this operation up to 500 times per minute 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 DescribeLiveDomainMapping

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

DomainName String Yes example.com

The domain name for which you want to query the mappings. The following types of domain names are supported:

  • Ingest domain
  • Main streaming domain
  • Sub-streaming domain

Response parameters

Parameter

Type

Example

Description

RequestId String 16A96B9A-F203-4EC5-8E43-CB92E68F6CD8

The request ID.

LiveDomainModels Array of LiveDomainModel

The mappings of the queried domain name.

LiveDomainModel
Type String play

The type of the queried domain name. Valid values:

  • vhost: main streaming domain
  • publish: ingest domain
  • play: sub-streaming domain
DomainName String example.aliyundoc.com

The domain name to which the queried domain name is mapped.

Examples

Sample requests

http(s)://live.aliyuncs.com/?Action=DescribeLiveDomainMapping
&DomainName=example.com
&<Common request parameters>

Sample success responses

XML format

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

<DescribeLiveDomainMappingResponse>
    <RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F6CD8</RequestId>
    <LiveDomainModels>
        <Type>play</Type>
        <DomainName>example.aliyundoc.com</DomainName>
    </LiveDomainModels>
</DescribeLiveDomainMappingResponse>

JSON format

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

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

Error codes

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