Domain name for API request: dbbrain.intl.tencentcloudapi.com.
This API is used to get the health score and deduction for exceptions in the specified time period (30 minutes) based on the instance ID.
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: DescribeHealthScore. |
| Version | Yes | String | Common Params. The value used for this API: 2021-05-27. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| InstanceId | Yes | String | Instance ID for which to get the health score. |
| Time | Yes | Timestamp ISO8601 | Time to get the health score in the format of 2019-09-10 12:13:14. |
| Product | Yes | String | Service type. Valid values: mysql (TencentDB for MySQL), cynosdb (TDSQL-C for MySQL). Default value: mysql. |
| Parameter Name | Type | Description |
|---|---|---|
| Data | HealthScoreInfo | Health score and deduction for exceptions. |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
POST / HTTP/1.1
Host: dbbrain.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeHealthScore
<Common request parameters>
{
"InstanceId": "cdb-8jawylhf",
"Product": "mysql",
"Time": "2021-02-01T14:30:00+00:00"
}
{
"Response": {
"RequestId": "0736b315-a9be-4991-92e6-28eccf3d31e3",
"Data": {
"IssueTypes": [
{
"TotalCount": 0,
"Events": [],
"IssueType": "AVAILABILITY"
},
{
"TotalCount": 0,
"Events": [],
"IssueType": "MAINTAINABILITY"
},
{
"TotalCount": 0,
"Events": [],
"IssueType": "PERFORMANCE"
},
{
"TotalCount": 0,
"Events": [],
"IssueType": "RELIABILITY"
}
],
"HealthScore": 100,
"EventsTotalCount": 0,
"HealthLevel": "HEALTH"
}
}
}
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 | Error with CAM signature/authentication. |
| FailedOperation | Operation failed. |
| InternalError | Internal error. |
| InvalidParameter | Incorrect parameter. |
| InvalidParameterValue | Incorrect parameter value. |
| LimitExceeded | The quota limit is exceeded. |
| MissingParameter | Missing parameter. |
| OperationDenied | Operation denied. |
| OperationDenied.UserHasNoStrategy | Error with CAM authentication. |
| RequestLimitExceeded | The number of requests exceeds the frequency limit. |
| ResourceNotFound | The resource does not exist. |
| UnauthorizedOperation | The operation is unauthorized. |
| UnknownParameter | Unknown parameter. |
| UnsupportedOperation | Unsupported operation. |
文档反馈