Domain name for API request: gaap.tencentcloudapi.com.
This API is used to query the statistics of an origin server's health check results. Origin server status is displayed as 1 (normal) or 0 (exceptional). The queried origin server must be bound to a listener or rule, and the ID of the bound listener or rule must be specified for the query. This API supports displaying origin server status statistics at a 1-minute granularity.
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 parameter. The value used for this API: DescribeRealServerStatistics. |
| Version | Yes | String | Common parameter. The value used for this API: 2018-05-29. |
| Region | No | String | Common parameter. This parameter is not required for this API. |
| RealServerId | Yes | String | Origin server ID |
| ListenerId | No | String | Listener ID |
| RuleId | No | String | Layer-7 rule ID |
| WithinTime | No | Integer | Statistics duration. Unit: hours. It only supports querying statistics for the past 1, 3, 6, 12, and 24 hours. |
| StartTime | No | String | Statistics start time, such as 2020-08-19 00:00:00 |
| EndTime | No | String | Statistics end time, such as 2020-08-19 23:59:59 |
| Granularity | No | Integer | Statistics granularity in seconds. Only 1-minute (60-second) and 5-minute (300-second) granularities are supported. |
| Parameter Name | Type | Description |
|---|---|---|
| StatisticsData | Array of StatisticsDataInfo | Origin server status statistics of specified listener |
| RsStatisticsData | Array of MetricStatisticsInfo | Status statistics of multiple origin servers |
| 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 health check statistics of a bound origin server.
https://gaap.tencentcloudapi.com/?Action=DescribeRealServerStatistics
&RealServerId=rs-rfgt56hy
&ListenerId=listener-gucvb6d
&WithinTime=3
&<Common request parameters>{
"Response": {
"StatisticsData": [
{
"MetricName": "80",
"MetricData": [
{
"Time": 1564736040,
"Data": 2000
},
{
"Time": 1564735980,
"Data": 2001
}
]
},
{
"MetricName": "8080",
"MetricData": [
{
"Time": 1564736040,
"Data": 2000
},
{
"Time": 1564735980,
"Data": 2001
}
]
}
],
"RequestId": "5c680029-66b2-4be8-9630-7bd316ce70dd"
}
}This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.
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. |
| InternalError | Internal error. |
| InvalidParameter | Incorrect parameter. |
| InvalidParameterValue | Incorrect parameter value. |
| MissingParameter | Missing parameter. |
| ResourceNotFound | The resource does not exist. |
Was this page helpful?