Domain name for API request: gaap.tencentcloudapi.com.
This API is used to query listener statistics, including inbound/outbound bandwidth, inbound/outbound packets, and concurrence data. It supports granularities of 300, 3,600, and 86,400. Default value is the highest within the granularity range.
A maximum of 20 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 Params. The value used for this API: DescribeListenerStatistics. |
Version | Yes | String | Common Params. The value used for this API: 2018-05-29. |
Region | No | String | Common Params. This parameter is not required. |
ListenerId | Yes | String | Listener ID |
StartTime | Yes | Timestamp | Start time |
EndTime | Yes | Timestamp | End time |
MetricNames.N | Yes | Array of String | Statistical metric name list. It supports:["InBandwidth", "OutBandwidth", "Concurrent", "InPackets", "OutPackets"] |
Granularity | Yes | Integer | Monitoring granularity. It currently supports: 300, 3,600, and 86,400. Unit: seconds. Time range: <= 1 day, supported minimum granularity: 300 seconds; Time range: <= 7 days, supported minimum granularity:3,600 seconds; Time range: > 7 days, supported minimum granularity:86,400 seconds; |
Parameter Name | Type | Description |
---|---|---|
StatisticsData | Array of MetricStatisticsInfo | Connection group statistics |
RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
This example shows you how to query the listener statistics.
POST / HTTP/1.1
Host: gaap.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeListenerStatistics
<Common request parameters>
{
"EndTime": "2019-03-26 12:00:00",
"Granularity": "300",
"ListenerId": "listener-rfgt56hy",
"StartTime": "2019-03-25 12:00:00",
"MetricNames": [
"OutputBandwidth",
"InputBandwidth"
]
}
{
"Response": {
"StatisticsData": [
{
"MetricName": "InputBandwidth",
"MetricData": [
{
"Time": 1564736040,
"Data": 2000
},
{
"Time": 1564735980,
"Data": 2001
}
]
}
],
"RequestId": "5c680029-66b2-4be8-9630-7bd316ce70dd"
}
}
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 |
---|---|
AuthFailure | CAM signature/authentication error. |
AuthFailure.NotEnterpriseAuthorization | Not an organizational customer. |
AuthFailure.UnauthorizedOperation | The sub-account is not authorized for this operation. |
FailedOperation | Operation failed. |
FailedOperation.ResourceCanNotAccess | This resource is not accessible. |
FailedOperation.UserNotConfirmProtocol | Protocol not activated. |
InternalError | Internal error. |
InvalidParameter | Incorrect parameter. |
InvalidParameterValue | Incorrect parameter value. |
MissingParameter | Missing parameter. |
ResourceNotFound | The resource does not exist. |
ResourceUnavailable | The resource is unavailable. |
ResourceUnavailable.AccountViolation | Restricted resources found in your account. Check your inbox and email for details. |
Was this page helpful?