DescribeProvinceIspPlayInfoList

最后更新时间:2021-05-12 19:14:26

1. API Description

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

This API is used to query the downstream playback data of a specified ISP in a specified district, including bandwidth, traffic, number of requests, and number of concurrent connections.

A maximum of 200 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: DescribeProvinceIspPlayInfoList.
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 point in time (Beijing time).
Example: 2019-02-21 10:00:00.
EndTime Yes String End point in time (Beijing time).
Example: 2019-02-21 12:00:00.
Note: EndTime and StartTime only support querying data for the last day.
Granularity Yes Integer Supported granularities:
1: 1-minute granularity (the query interval should be within 1 day)
StatType Yes String Statistical metric type:
"Bandwidth": bandwidth
"FluxPerSecond": average traffic
"Flux": traffic
"Request": number of requests
"Online": number of concurrent connections
PlayDomains.N No Array of String Playback domain name list.
ProvinceNames.N No Array of String List of the districts to be queried, such as Beijing.
IspNames.N No Array of String List of the ISPs to be queried, such as China Mobile. If this parameter is left empty, the data of all ISPs will be queried.
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.
IpType No String IP type:
"Ipv6": IPv6 data
Data of all IPs will be returned if this parameter is left empty.

3. Output Parameters

Parameter Name Type Description
DataInfoList Array of PlayStatInfo Playback information list.
StatType String Statistics type, which is the same as the input parameter.
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=DescribeProvinceIspPlayInfoList
&PlayDomains.0=5000.playdomain.com
&StartTime=2019-02-01 00:00:00
&EndTime=2019-02-02 00:00:00
&Granularity=1
&StatType=Bandwidth
&<Common request parameters>

Output Example

{
  "Response": {
    "DataInfoList": [
      {
        "Time": "2019-02-01 00:00:00",
        "Value": 500.0
      }
    ],
    "StatType": "Bandwidth",
    "RequestId": "8e50cdb5-56dc-408b-89b0-31818958d424"
  }
}

5. Developer Resources

SDK

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.
InternalError Internal error.
InternalError.HasNotLivingStream No live stream.
InternalError.InvalidRequest Invalid request.
InternalError.QueryProIspPlayInfoError Failed to query the playback information by ISP and district.
InternalError.QueryUploadInfoFailed Failed to query the upload information.
InvalidParameterValue Invalid parameter value.
MissingParameter Parameter missing.