Domain name for API request: live.tencentcloudapi.com.
This API is used to query the information of the top n domain names or stream IDs in a certain period of time (top 1,000 is supported currently).
A maximum of 100 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: DescribeVisitTopSumInfoList. |
| 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 in the format of yyyy-mm-dd HH:MM:SS. |
| EndTime | Yes | String | End point in time in the format of yyyy-mm-dd HH:MM:SSThe time span is (0,4 hours]. Data for the last day can be queried. |
| TopIndex | Yes | String | Bandwidth metric. Valid values: "Domain", "StreamId". |
| PlayDomains.N | No | Array of String | Playback domain name. If this parameter is left empty, full data will be queried by default. |
| PageNum | No | Integer | Page number, Value range: [1,1000], Default value: 1. |
| PageSize | No | Integer | Number of entries per page. Value range: [1,1000]. Default value: 20. |
| OrderParam | No | String | Sorting metric. Valid values: "AvgFluxPerSecond", "TotalRequest" (default), "TotalFlux". |
| Parameter Name | Type | Description |
|---|---|---|
| PageNum | Integer | Page number, Value range: [1,1000], Default value: 1. |
| PageSize | Integer | Number of entries per page. Value range: [1,1000]. Default value: 20. |
| TopIndex | String | Bandwidth metric. Valid values: "Domain", "StreamId". |
| OrderParam | String | Sorting metric. Valid values: AvgFluxPerSecond (sort by average traffic per second), TotalRequest (sort by total requests), TotalFlux (sort by total traffic). Default value: TotalRequest. |
| TotalNum | Integer | Total number of results. |
| TotalPage | Integer | Total number of result pages. |
| DataInfoList | Array of PlaySumStatInfo | Data content. |
| RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
https://live.tencentcloudapi.com/?Action=DescribeVisitTopSumInfoList
&StartTime=2019-03-01 00:00:00
&EndTime=2019-03-01 04:00:00
&PageSize=2
&PageNum=2
&TopIndex=StreamId
&OrderParam=TotalFlux
&<Common request parameters>{
"Response": {
"DataInfoList": [
{
"AvgFluxPerSecond": 4.773,
"Name": "CSZFMPP360",
"TotalRequest": 36590,
"TotalFlux": 69023.772
},
{
"AvgFluxPerSecond": 4.634,
"Name": "CSNXMPP360",
"TotalRequest": 88629,
"TotalFlux": 67009.417
}
],
"OrderParam": "TotalFlux",
"PageNum": 2,
"PageSize": 2,
"RequestId": "k54e3deb-f318-4147-8a68-3c959642f9ec",
"TopIndex": "StreamId",
"TotalNum": 1000,
"TotalPage": 500
}
}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. |
| InvalidParameter | Invalid parameter. |
| InvalidParameterValue | Invalid parameter value. |
| MissingParameter | Parameter missing. |
Was this page helpful?