DescribeLiveDomainDetail-阿里云帮助中心

Queries the basic configuration information of a specified ingest domain or streaming domain.

Operation description

This operation queries the basic configuration information of a specified ingest domain or streaming domain. If you query a newly added domain, it takes several minutes to complete the domain configuration. You can query the domain only after the configuration is fully complete.

QPS limit

The queries per second (QPS) limit for a single user is 50. If the limit is exceeded, API calls are throttled, which may affect your services. Make API calls at a reasonable rate.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

live:DescribeLiveDomainDetail

get

*All Resource

*

None

Request parameters

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

Response elements

Element	Type	Description	Example
	object
DomainDetail	object	The domain name configuration details.
CertName	string	The name of the certificate.	liveCert****
Cname	string	The CNAME domain name. A CNAME domain name is generated for the live domain. You must configure a CNAME record at your DNS provider to resolve the live domain to this CNAME domain name. Note Due to the caching of local DNS resolution records, it takes about 10 minutes for the CNAME record configuration to take effect and be displayed as successful after you configure the CNAME record for the domain. For more information, see FAQ about CNAME resolution.	learn.developer.aliyundoc.com
Description	string	The description of the domain name.	test
DomainName	string	The ingest domain or streaming domain.	demo.aliyundoc.com
DomainStatus	string	The running status of the live domain name. Valid values: online: The domain name is enabled. offline: The domain name is disabled. configuring: The domain name is being configured.	online
GmtCreated	string	The creation time. The time follows the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2018-07-27T06:51:25Z
GmtModified	string	The last modification time. The time follows the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2018-08-07T06:51Z
LiveDomainType	string	The business type of the domain name. Valid values: liveVideo: Streaming domain. liveEdge: Edge ingest domain.	liveVideo
Region	string	The region to which the domain name belongs.	cn-shanghai
SSLProtocol	string	Specifies whether the SSL certificate is enabled. Valid values: on: Enabled. off: Disabled.	on
SSLPub	string	The public key of the certificate.	Public Key
Scope	string	The acceleration region. Valid values: domestic: The Chinese mainland. overseas: Outside the Chinese mainland. global: Global.	domestic
ResourceGroupId	string	The ID of the resource group.	rg-k3bpq2yjw22
RequestId	string	The request ID.	09ABE829-6CD3-4FE0-AFEE-556113E29727

Examples

Success response

JSON format

{
  "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-**k3bpq2yjw22**"
  },
  "RequestId": "09ABE829-6CD3-4FE0-AFEE-556113E29727"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.