DescribeVisitTopSumInfoList

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 Params. The value used for this API: DescribeVisitTopSumInfoList.
Version	Yes	String	Common Params. The value used for this API: 2018-08-01.
Region	No	String	Common Params. 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:SS` The 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".

3. Output Parameters

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.

4. Example

Example1 Sample request

Input Example

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>

Output Example

{
  "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
  }
}

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

Tencent Cloud CLI 3.0

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.
ResourceNotFound.ForbidService
ResourceNotFound.FreezeService
ResourceNotFound.StopService	The service has been suspended due to account arrears. Please top up it to a positive balance to activate the service first.
ResourceNotFound.UserDisableService

Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support

tencent cloud

Tencent Cloud Partner Network

Become a Partner

International Partner Academy

Recent Pages