DescribeDBDiagHistory

Download PDF

Last updated: 2024-11-19 21:55:39

Last updated: 2024-11-19 21:55:39

Download PDF

1. API Description

Domain name for API request: dbbrain.intl.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 Params. The value used for this API: DescribeDBDiagHistory.
Version	Yes	String	Common Params. The value used for this API: 2019-10-16.
Region	Yes	String	Common Params. 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` (TencentDB for CynosDB (compatible with MySQL)). Default value: `mysql`.

3. Output Parameters

Parameter Name	Type	Description
Events	Array of DiagHistoryEventItem	Event description.
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.

4. Example

Example1 Obtaining the instance diagnosis event list

Input Example

https://dbbrain.intl.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": "",
        "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

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
FailedOperation	Operation failed.
InvalidParameter	Incorrect parameter.
InvalidParameterValue	Incorrect parameter value.
OperationDenied.UserHasNoStrategy	Error with CAM authentication.
UnauthorizedOperation	The operation is unauthorized.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

tencent cloud