DescribeDBDiagEvents

Download PDF

Last updated: 2023-10-17 10:51:58

Last updated: 2023-10-17 10:51:58

Download PDF

1. API Description

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

This API is used to obtain the diagnosis event list in a specified time period by risk level, instance ID, etc.

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: DescribeDBDiagEvents.
Version	Yes	String	Common Params. The value used for this API: 2021-05-27.
Region	No	String	Common Params. This parameter is not required for this API.
StartTime	Yes	Timestamp ISO8601	Start time in the format of “2021-05-27 00:00:00”. The earliest time that can be queried is 30 days before the current time.
EndTime	Yes	Timestamp ISO8601	End time in the format of "2021-05-27 01:00:00". The interval between the end time and the start time can be up to 7 days.
Severities.N	No	Array of Integer	Risk level list. Valid values in descending order of severity: `1` (critical), `2` (serious), `3` (alarm), `4` (warning), `5` (healthy).
InstanceIds.N	No	Array of String	Instance ID list.
Offset	No	Integer	Offset. Default value: 0.
Limit	No	Integer	Number of returned results. Default value: 20. Maximum value: 50.

3. Output Parameters

Parameter Name	Type	Description
TotalCount	Integer	Total number of diagnosis events.
Items	Array of DiagHistoryEventItem	Diagnosis event list.
RequestId	String	The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Obtaining diagnosis event list

Input Example

https://dbbrain.tencentcloudapi.com/?Action=DescribeDBDiagEvents
&StartTime=2021-05-27T00:00:00+00:00
&EndTime=2021-05-27T01:00:00+00:00
&<Common request parameters>

Output Example

{
    "Response": {
        "RequestId": "7a9a6ba0-5893-11ec-8ad2-ff04c623cbd9",
        "TotalCount": 1,
        "Items": [
            {
                "InstanceId": "cdb-test",
                "EventId": 330858512,
                "StartTime": "2021-05-27 00:01:10",
                "EndTime": "2021-05-27 00:01:20",
                "DiagItem": "Transaction uncommitted",
                "DiagType": "Transaction uncommitted",
                "Severity": 1,
                "Outline": "There are uncommitted transactions",
                "Metric": "",
                "Region": "ap-guangzhou"
            }
        ]
    }
}

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

Was this page helpful?

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

Yes

tencent cloud