DescribeDBDiagHistory

Last updated: 2022-01-06 14:28:01

1. API Description

Domain name for API request: dbbrain.tencentcloudapi.com.

This API is used to get the list of instance diagnosis events.

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: DescribeDBDiagHistory.
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.
StartTime Yes Timestamp Start time, such as "2019-09-10 12:13:14".
EndTime Yes Timestamp End time, such as "2019-09-11 12:13:14". The interval between the end time and the start time can be up to 2 days.
Product No String Service type. Valid values: mysql (TencentDB for MySQL), cynosdb (TDSQL-C for MySQL). Default value: mysql.

3. Output Parameters

Parameter Name Type Description
Events Array of DiagHistoryEventItem Event description.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Getting instance diagnosis event list

Input Example

https://dbbrain.tencentcloudapi.com/?Action=DescribeDBDiagHistory
&StartTime=2019-01-01 00:00:00
&EndTime=2019-01-01 01:00:00
&InstanceId=cdb-test
&<Common request parameters>

Output Example

{
  "Response": {
    "RequestId": "ed279d8b-a9d9-48d6-9429-e0fde000994a",
    "Events": [
      {
        "DiagType": "Row lock",
        "StartTime": "2019-01-01 00:00:20",
        "EndTime": "2019-01-01 00:00:30",
        "InstanceId": "cdb-test",
        "Region": "ap-beijing",
        "Metric": "",
        "EventId": 5,
        "Severity": 4,
        "Outline": "Monitoring metric \"innodb_row_lock_waits\" triggered an alarm. Current value: 131",
        "DiagItem": "UPDATE statement row lock wait"
      }
    ]
  }
}

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

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.
ResourceNotFound The resource does not exist.
UnauthorizedOperation The operation is unauthorized.
UnknownParameter Unknown parameter.
UnsupportedOperation Unsupported operation.