Contents:
## 1. API Description
API request domain name: live.tencentcloudapi.com.
This API returns the live stream list.
Default API request rate limit: 500 requests/second.
2. Request Parameters
The following parameters are required for requesting this API, including action-specific parameters and common parameters. For more information about common parameters for all requests, see Common Request Parameters.
Parameter name | Required | Type | Description |
---|---|---|---|
Action | Yes | String | Common parameter; the name of this API: DescribeLiveStreamOnlineList |
Version | Yes | String | Common parameter; the version of this API: 2018-08-01 |
Region | No | String | Common parameter; optional for this API |
DomainName | No | String | Push domain name. |
AppName | No | String | Application name |
PageNum | No | Integer | The page number to get; 1 by default. |
PageSize | No | Integer | Size per page; up to 100. Value: any integer between 10 and 100. Default value: 10. |
StreamName | No | String | Stream name; exact query. |
3. Return Parameters
Parameter name | Type | Description |
---|---|---|
TotalNum | Integer | Total number of eligible ones. |
TotalPage | Integer | Total number of pages. |
PageNum | Integer | Page number. |
PageSize | Integer | Number of entries displayed per page. |
OnlineInfo | Array of StreamOnlineInfo | Live push stream information list |
RequestId | String | The ID of the request. Each request returns a unique ID. The RequestId is required to troubleshoot issues. |
4. Sample
Request Sample
Input Sample Code
https://live.tencentcloudapi.com/?Action=DescribeLiveStreamOnlineList
&DomainName=5000.livepush.myqcloud.com
&AppName=live
&PageNum=1
&PageSize=10
&<Common request parameter>
Output Sample Code
{
"Response": {
"OnlineInfo":[{
"StreamName": "5000_abcdefg",
"AppName": "live",
"DomainName": "5000.livepush.myqcloud.com",
"PublishTimeList": [{
"PublishTime": "2017-10-24T12:00:00Z"
}]
}],
"TotalNum": 100,
"TotalPage": 10,
"PageNum": 1,
"PageSize": 10,
"RequestId": "8e50cdb5-56dc-408b-89b0-31818958d424"
}
}
5. Developer Resources
API Explorer
API Explorer is a tool that provides ease of use in requesting APIs, authenticating identities, generating SDK and exploring APIs in Tencent Cloud environment.
SDK
Cloud API 3.0 comes with a set of complementary development toolkits (SDKs) that support multiple programming languages and make it easier to call the API.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for NodeJS
- Tencent Cloud SDK 3.0 for .NET
TCCLI
6. Error Codes
The following error codes are API business logic-related. For other error codes, see Common Error Codes.
Error Code | Description |
---|---|
InternalError | Internal error |
InternalError.CallOtherSvrError | Error calling internal service. |
InternalError.ConfigNotExist | The configuration does not exist. |
InternalError.GetBizidError | Error getting user account. |
InternalError.GetStreamInfoError | Failed to get stream information. |
InternalError.GetUpstreamInfoError | Error getting live stream source information. |
InternalError.NotPermmitOperat | No permission to operate. |
InternalError.StreamStatusError | Exceptional stream status. |
InternalError.UpdateDataError | Failed to update data. |
InvalidParameter | Parameter error |
InvalidParameterValue | Incorrect parameter value |
MissingParameter | Missing parameter |