Queries the basic information about a domain name.

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 example.com

The streaming domain and ingest domain.

Response parameters

Parameter Type Example Description
DomainDetail Struct

The domain name that was queried.

CertName String testCertName

The name of the certificate.

Cname String example.com.alikunlun.com

The canonical domain name generated for the domain name. You must add a canonical name (CNAME) record with your domain name system (DNS) provider to map the domain name to the canonical domain name.

Description String test

The description of the domain name.

DomainName String example.com

The streaming domain and ingest 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 created. 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 region where the domain name resides.

SSLProtocol String on

Indicates whether the SSL certificate is enabled. Valid values:

  • on: The SSL certificate is enabled.
  • off: The SSL certificate is disabled.
SSLPub String publickey

The public key of the certificate.

Scope String domestic

The edge group. Valid values:

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

The ID of the request.

Examples

Sample requests

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

Sample success responses

XML format

<DescribeLiveDomainDetailResponse>
  <DomainDetail>
        <Description>test</Description>
        <DomainName>example.com</DomainName>
        <SSLPub>publickey</SSLPub>
        <GmtModified>2018-08-07T06:51Z</GmtModified>
        <GmtCreated>2018-07-27T06:51:25Z</GmtCreated>
        <Cname>example.com.alikunlun.com</Cname>
        <SSLProtocol>on</SSLProtocol>
        <Scope>domestic</Scope>
        <LiveDomainType>liveVideo</LiveDomainType>
        <Region>cn-shanghai</Region>
        <CertName>testCertName</CertName>
        <DomainStatus>online</DomainStatus>
  </DomainDetail>
  <RequestId>09ABE829-6CD3-4FE0-AFEE-556113E29727</RequestId>
</DescribeLiveDomainDetailResponse>

JSON format

{
  "DomainDetail": {
    "Description": "test",
    "DomainName": "example.com",
    "SSLPub": "publickey",
    "GmtModified": "2018-08-07T06:51Z",
    "GmtCreated": "2018-07-27T06:51:25Z",
    "Cname": "example.com.alikunlun.com",
    "SSLProtocol": "on",
    "Scope": "domestic",
    "LiveDomainType": "liveVideo",
    "Region": "cn-shanghai",
    "CertName": "testCertName",
    "DomainStatus": "online"
  },
  "RequestId": "09ABE829-6CD3-4FE0-AFEE-556113E29727"
}

Error codes

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