Queries the basic information about a domain name.

Usage notes

You can call this operation to query the basic information about an ingest domain or a streaming domain.

If you want to query a newly added domain name, wait several minutes until the domain name is configured in ApsaraVideo Live.

Limits on QPS

You can call this operation up to 50 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation. For more information, see QPS limit on an API operation in ApsaraVideo Live.

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 DescribeLiveDomainDetail

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

DomainName String Yes demo.aliyundoc.com

The ingest domain or streaming domain.

Response parameters

Parameter Type Example Description
DomainDetail Struct

The information about the domain name.

CertName String liveCert****

The name of the certificate.

Cname String learn.developer.aliyundoc.com

The CNAME that is assigned to the domain name. You must add a CNAME record in the system of your Domain Name System (DNS) service provider to map the domain name to the CNAME.

Note A time-to-live (TTL) value is specified in the CNAME record of a domain name to indicate how long the CNAME record can be cached on the DNS resolver. If you modify the CNAME record of the domain name, the new settings take effect after the cache expires, which takes about 10 minutes. For more information, see CNAME resolution.
Description String test

The description of the domain name.

DomainName String demo.aliyundoc.com

The ingest domain or streaming domain.

DomainStatus String online

The status of the domain name. Valid values:

  • online: The domain name is enabled.
  • offline: The domain name is disabled.
  • configuring: The domain name is being configured.
GmtCreated String 2018-07-27T06:51:25Z

The time when the domain name was added. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

GmtModified String 2018-08-07T06:51Z

The time when the domain name was last modified. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

LiveDomainType String liveVideo

The type of the domain name. Valid values:

  • liveVideo: streaming domain
  • liveEdge: edge ingest domain
Region String cn-shanghai

The ID of the region in which the domain name resides.

SSLProtocol String on

Indicates whether the SSL certificate is enabled. Valid values:

  • on: yes
  • off: no
SSLPub String Public Key

The public key of the certificate.

Scope String domestic

The acceleration region. Valid values:

  • domestic: regions in the Chinese mainland
  • overseas: regions outside the Chinese mainland
  • global: regions in and outside the Chinese mainland
RequestId String 09ABE829-6CD3-4FE0-AFEE-556113E29727

The ID of the request.

Examples

Sample requests

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

Sample success responses

XML format 

<DescribeLiveDomainDetailResponse>
  <DomainDetail>
        <Description>test</Description>
        <Scope>domestic</Scope>
        <LiveDomainType>liveVideo</LiveDomainType>
        <DomainName>demo.aliyundoc.com</DomainName>
        <SSLPub>Public Key</SSLPub>
        <GmtModified>2018-08-07T06:51Z</GmtModified>
        <Region>cn-shanghai</Region>
        <CertName>liveCert****</CertName>
        <GmtCreated>2018-07-27T06:51:25Z</GmtCreated>
        <Cname>learn.developer.aliyundoc.com</Cname>
        <DomainStatus>online</DomainStatus>
        <SSLProtocol>on</SSLProtocol>
  </DomainDetail>
  <RequestId>09ABE829-6CD3-4FE0-AFEE-556113E29727</RequestId>
</DescribeLiveDomainDetailResponse>

JSON format 

{
    "DescribeLiveDomainDetailResponse": {
        "DomainDetail": {
            "Description": "test",
            "Scope": "domestic",
            "LiveDomainType": "liveVideo",
            "DomainName": "demo.aliyundoc.com",
            "SSLPub": "Public Key",
            "GmtModified": "2018-08-07T06:51Z",
            "Region": "cn-shanghai",
            "CertName": "liveCert****",
            "GmtCreated": "2018-07-27T06:51:25Z",
            "Cname": "learn.developer.aliyundoc.com",
            "DomainStatus": "online",
            "SSLProtocol": "on"
        },
        "RequestId": "09ABE829-6CD3-4FE0-AFEE-556113E29727"
    }
}

Error codes

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