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

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 whose mapping configuration you want to query.

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.

LiveDomainModel
DomainName String example.com

The domain name that is mapped.

Type String vhost

The type of the domain name. 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.

Examples

Sample requests

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

Sample success responses

XML format

<DescribeLiveDomainMappingResponse>
  <LiveDomainModels>
        <LiveDomainModel>
              <DomainName>example.com</DomainName>
              <Type>vhost</Type>
        </LiveDomainModel>
        <LiveDomainModel>
              <DomainName>push.example.com</DomainName>
              <Type>publish</Type>
        </LiveDomainModel>
  </LiveDomainModels>
  <RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F6CD8</RequestId>
</DescribeLiveDomainMappingResponse>

JSON format

{
    "LiveDomainModels": {
        "LiveDomainModel": [
            {
                "DomainName": "example.com",
                "Type": "vhost"
            }, 
            {
                "DomainName": "push.example.com",
                "Type": "publish"
            }
        ]
    },
    "RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F6CD8"
}

Error codes

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