DescribeLiveDomainDetail - ApsaraVideo Live - Alibaba Cloud Documentation Center

Queries the basic information about a domain name.

Operation description

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 a few minutes until the configuration of the domain name is completed in ApsaraVideo Live.

QPS limit

You can call this operation up to 50 times per second 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

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
live:DescribeLiveDomainDetail	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
DomainName	string	Yes	The streaming domain or ingest domain.	demo.aliyundoc.com

Response parameters

Parameter	Type	Description	Example
	object
DomainDetail	object	The configuration details of the domain name.
CertName	string	The name of the certificate.	liveCert****
Cname	string	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.	learn.developer.aliyundoc.com
Description	string	The description of the domain name.	test
DomainName	string	The streaming domain or ingest domain.	demo.aliyundoc.com
DomainStatus	string	The status of the domain name. Valid values: online: The domain name is enabled. offline: The domain name is disabled. configuring: The domain is being configured.	online
GmtCreated	string	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.	2018-07-27T06:51:25Z
GmtModified	string	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.	2018-08-07T06:51Z
LiveDomainType	string	The type of the domain name. Valid values: liveVideo: streaming domain liveEdge: ingest domain	liveVideo
Region	string	The ID of the region where the domain name resides.	cn-shanghai
SSLProtocol	string	Indicates whether the SSL certificate is enabled. Valid values: on off	on
SSLPub	string	The public key of the certificate.	Public Key
Scope	string	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.	domestic
ResourceGroupId	string	The ID of the resource group.	rg-aek2ogvt4nwmi7i
RequestId	string	The ID of the request.	09ABE829-6CD3-4FE0-AFEE-556113E29727

Examples

Sample success responses

JSONformat

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

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-09-27	API Description Update	View Change Details
2024-09-25	The response structure of the API has changed	View Change Details