Documentation|Tencent Cloud

Recent Pages

DescribePlayErrorCodeDetailInfoList

Last updated: 2020-07-14 18:07:50

1. API Description

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

This API is used to query the information of downstream playback error codes, i.e., the occurrences of each HTTP error code (4xx and 5xx) at a 1-minute granularity in a certain period of time.

A maximum of 100 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: DescribePlayErrorCodeDetailInfoList.
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`. Note: `EndTime` and `StartTime` only support querying data for the last day.
Granularity	Yes	Integer	Query granularity: 1: 1-minute granularity.
StatType	Yes	String	Yes. Valid values: "4xx", "5xx". Mixed codes in the format of `4xx,5xx` are also supported.
PlayDomains.N	No	Array of String	Playback domain name list.
MainlandOrOversea	No	String	Region. Valid values: Mainland (data for Mainland China), Oversea (data for regions outside Mainland China), China (data for China, including Hong Kong, Macao, and Taiwan), Foreign (data for regions outside China, excluding Hong Kong, Macao, and Taiwan), Global (default). If this parameter is left empty, data for all regions will be queried.

3. Output Parameters

Parameter Name	Type	Description
HttpCodeList	Array of HttpCodeInfo	Statistics list.
StatType	String	Statistics type.
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

https://live.tencentcloudapi.com/?Action=DescribePlayErrorCodeDetailInfoList
&PlayDomains.0=5000.playdomain.com
&StartTime=2019-03-01 00:00:00
&EndTime=2019-03-01 12:00:00
&Granularity=1
&StatType=4xx
&<Common request parameters>

Output Example

{
  "Response": {
    "HttpCodeList": [
      {
        "HttpCode": "4xx",
        "ValueList": [
          {
            "Time": "2019-03-01 00:00:00",
            "Numbers": 20,
            "Percentage": 0.96
          }
        ]
      }
    ],
    "StatType": "4xx",
    "RequestId": "e6628973-db6a-48f1-9fcd-fe0b3ba54bc9"
  }
}

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.