Domain name for API request: live.tencentcloudapi.com.
This API is used to query the playback data. It supports querying the playback details by stream name and aggregated data by playback domain name. Data in the last 4 minutes or so cannot be queried due to delay.
Note: to query by AppName, you need to submit a ticket first. After your application succeeds, it will take about 5 business days (subject to the time in the reply) for the configuration to take effect.
A maximum of 500 requests can be initiated per second for this API.
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: DescribeStreamPlayInfoList. |
| 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. |
| StartTime | Yes | String | Start time (Beijing time) in the format of yyyy-mm-dd HH:MM:SS |
| EndTime | Yes | String | End time (Beijing time) in the format of yyyy-mm-dd HH:MM:SS The end time and start time must be on the same day. Data in the last 3 days can be queried. |
| PlayDomain | No | String | Playback domain name, If this parameter is left empty, data of live streams of all playback domain names will be queried. |
| StreamName | No | String | Stream name (exact match). If this parameter is left empty, full playback data will be queried. |
| AppName | No | String | Push address. Its value is the same as the AppName in playback address. It supports exact match, and takes effect only when StreamName is passed at the same time.If it is left empty, the full playback data will be queried. Note: to query by AppName, you need to submit a ticket first. After your application succeeds, it will take about 5 business days (subject to the time in the reply) for the configuration to take effect. |
| Parameter Name | Type | Description |
|---|---|---|
| DataInfoList | Array of DayStreamPlayInfo | Statistics list at a 1-minute granularity. |
| RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
https://live.tencentcloudapi.com/?Action=DescribeStreamPlayInfoList
&PlayDomain=5000.playdomain.com
&StreamName=stream1
&StartTime=2019-03-01 00:00:00
&EndTime=2019-03-01 00:03:00
&<Common request parameters>{
"Response": {
"DataInfoList": [
{
"Time": "2019-03-01 00:00:00",
"Bandwidth": 10.0,
"Flux": 75.0,
"Request": 50,
"Online": 10
},
{
"Time": "2019-03-01 00:02:00",
"Bandwidth": 20.0,
"Flux": 150.0,
"Request": 50,
"Online": 20
},
{
"Time": "2019-03-01 00:03:00",
"Bandwidth": 30.0,
"Flux": 225.0,
"Request": 50,
"Online": 30
}
],
"RequestId": "8e50cdb5-56dc-408b-89b0-31818958d424"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| FailedOperation | Operation failed. |
| InternalError | Internal error. |
| InternalError.DBError | DB execution error. |
| InvalidParameterValue | Invalid parameter value. |
| MissingParameter | Parameter missing. |
Was this page helpful?