Documentation|Tencent Cloud

Recent Pages

Documentation

DescribeLiveDomains

Last updated: 2020-07-31 11:04:32

1. API Description

Domain name for API request: live.tencentcloudapi.com.

This API is used to query domain names by domain name status and type.

A maximum of 500 requests can be initiated per second for this API.

We recommend you to use API Explorer

Try it

API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name	Required	Type	Description
Action	Yes	String	Common parameter. The value used for this API: DescribeLiveDomains.
Version	Yes	String	Common parameter. The value used for this API: 2018-08-01.
Region	No	String	Common parameter. This parameter is not required for this API.
DomainStatus	No	Integer	Filter by domain name status. 0: disabled, 1: enabled.
DomainType	No	Integer	Filter by domain name type. 0: push. 1: playback
PageSize	No	Integer	Number of entries per page. Value range: 10-100. Default value: 10.
PageNum	No	Integer	Page number to get. Value range: 1-100000. Default value: 1.
IsDelayLive	No	Integer	0: LVB, 1: LCB. Default value: 0.
DomainPrefix	No	String	Domain name prefix.

3. Output Parameters

Parameter Name	Type	Description
AllCount	Integer	Total number of results.
DomainList	Array of DomainInfo	List of domain name details.
RequestId	String	The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying domain name list

Input Example

https://live.tencentcloudapi.com/?Action=DescribeLiveDomains
&DomainType=1
&DomainStatus=1
&PageSize=10
&PageNum=1
&IsDelayLive=0
&<Common request parameters>

Output Example

{
  "Response": {
    "RequestId": "eac6b301-a322-493a-8e36-83b295459397",
    "AllCount": 2,
    "DomainList": [
      {
        "Name": "abc.com",
        "Type": 1,
        "Status": 1,
        "PlayType": 1,
        "IsDelayLive": 0,
        "CreateTime": "2018-08-29 10:00:00",
        "BCName": 1,
        "CurrentCName": "",
        "TargetDomain": "abc.com.liveplay.myqcloud.com",
        "RentTag": 0,
        "RentExpireTime": "0000-00-00 00:00:00"
      }
    ]
  }
}

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

API 3.0 Explorer

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code	Description
InternalError	Internal error.
InternalError.ConnectDbError	Database connection error.
InternalError.DBError	DB execution error.
InternalError.GetBizidError	Error getting user account.