DescribeHealthScore

Prev Next

search by keyword

Recent Pages

Documentation

Download PDF

Last updated: 2022-01-06 14:27:54

Download PDF

1. API Description

Domain name for API request: dbbrain.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.

We recommend you to use API Explorer

Try it

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 parameter. The value used for this API: DescribeHealthScore.
Version	Yes	String	Common parameter. The value used for this API: 2021-05-27.
Region	Yes	String	Common parameter. 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.

3. Output Parameters

Parameter Name	Type	Description
Data	HealthScoreInfo	Health score and deduction for exceptions.
RequestId	String	The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Requesting health score

Input Example

POST / HTTP/1.1
Host: dbbrain.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"
}

Output Example

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

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
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.

Recent Pages