Last updated: 2020-09-25 14:27:51

1. API Description

Domain name for API request:

This API is used to query the downstream information of all streams at a specified point in time (at a 1-minute granularity).

A maximum of 20 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: DescribeAllStreamPlayInfoList.
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.
QueryTime Yes String Query time accurate down to the minute in the format of yyyy-mm-dd HH:MM:SS. Data for the last month can be queried. The data has a delay of about 5 minutes; therefore, if you want to query real-time data, we recommend you pass in a point in time 5 minutes ago.

3. Output Parameters

Parameter Name Type Description
QueryTime String Query point in time in the returned input parameters.
DataInfoList Array of MonitorStreamPlayInfo Data information list.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Sample request

Input Example
&QueryTime=2019-12-12 10:00:00
&<Common request parameters>

Output Example

  "Response": {
    "QueryTime": "2019-12-12 10:00:00",
    "DataInfoList": [
        "Bandwidth": 1.82,
        "Online": 1,
        "PlayDomain": "",
        "Protocol": "Hls",
        "Rate": 0,
        "Request": 19,
        "StreamName": "test1"
        "Bandwidth": 1.59,
        "Online": 1,
        "PlayDomain": "",
        "Protocol": "Flv",
        "Rate": 0,
        "Request": 10,
        "StreamName": "test2"
        "Bandwidth": 3.6,
        "Online": 2,
        "PlayDomain": "",
        "Protocol": "Flv",
        "Rate": 0,
        "Request": 12,
        "StreamName": "test3"
    "RequestId": "k54e3deb-f318-4147-8a68-3c959642f9ec"

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.


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

Command Line Interface

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
FailedOperation Operation failed.
InvalidParameter Invalid parameter.
InvalidParameterValue Invalid parameter value.
MissingParameter Parameter missing.

Was this page helpful?

Was this page helpful?

  • Not at all
  • Not very helpful
  • Somewhat helpful
  • Very helpful
  • Extremely helpful
Send Feedback