- Release Notes and Announcements
- Product Introduction
- Purchase Guide
- Operation Guide
- Practical Tutorial
- API Documentation
- History
- Introduction
- API Category
- Making API Requests
- Redis related APIs
- Health Report Email Sending APIs
- Exception Detection APIs
- Session Killing APIs
- Space Analysis APIs
- Slow Log Analysis APIs
- Security Audit APIs
- Database Audit APIs
- Other APIs
- Data Types
- Error Codes
- DBbrain APIs 2019-10-16
- FAQs
- Service Level Agreement
- Glossary
- Contact Us
- Release Notes and Announcements
- Product Introduction
- Purchase Guide
- Operation Guide
- Practical Tutorial
- API Documentation
- History
- Introduction
- API Category
- Making API Requests
- Redis related APIs
- Health Report Email Sending APIs
- Exception Detection APIs
- Session Killing APIs
- Space Analysis APIs
- Slow Log Analysis APIs
- Security Audit APIs
- Database Audit APIs
- Other APIs
- Data Types
- Error Codes
- DBbrain APIs 2019-10-16
- FAQs
- Service Level Agreement
- Glossary
- Contact Us
1. API Description
Domain name for API request: dbbrain.tencentcloudapi.com.
This API is used to get the details of an instance exception diagnosis event.
A maximum of 20 requests can be initiated per second for this API.
Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: dbbrain.ap-shanghai-fsi.tencentcloudapi.com
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: DescribeDBDiagEvent. |
| Version | Yes | String | Common parameter. The value used for this API: 2019-10-16. |
| Region | Yes | String | Common parameter. For more information, please see the list of regions supported by the product. |
| InstanceId | Yes | String | Instance ID. |
| EventId | No | Integer | Event ID, which can be obtained through the DescribeDBDiagHistory API. |
| 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 |
|---|---|---|
| DiagItem | String | Diagnosis item. |
| DiagType | String | Diagnosis type. |
| EventId | Integer | Event ID. |
| Explanation | String | Event details. |
| Outline | String | Summary. |
| Problem | String | Problem found. |
| Severity | Integer | Severity, which can be divided into 5 levels: 1: fatal, 2: severe, 3: warning, 4: notice, 5: healthy. |
| StartTime | Timestamp | Start time |
| Suggestions | String | Suggestion. |
| Metric | String | Reserved field. Note: this field may return null, indicating that no valid values can be obtained. |
| EndTime | Timestamp | End time. |
| 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 details
Input Example
https://dbbrain.tencentcloudapi.com/?Action=DescribeDBDiagEvent
&InstanceId=test
&EventId=5
&<common request parameters>
Output Example
{
"Response": {
"Suggestions": "[]",
"DiagType": "Database snapshot",
"EndTime": "2019-11-06 12:05:50",
"RequestId": "78cf7bb1-0608-11ea-a9ef-2736f0f7f829",
"Explanation": "[]",
"StartTime": "2019-11-06 12:05:40",
"Severity": 4,
"EventId": 5,
"Outline": "1 problem found during database health check",
"Problem": "[{\"DataType\":\"title\",\"Data\":{\"Name\":\"Session snapshot\"}},{\"DataType\":\"title\",\"Data\":{\"Name\":\"Transaction snapshot\"}},{\"DataType\":\"title\",\"Data\":{\"Name\":\"InnoDB status snapshot\"}}]",
"Metric": "",
"DiagItem": "Health inspection"
}
}
5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for NodeJS
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
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 |
|---|---|
| FailedOperation | Operation failed. |
| InvalidParameter | Incorrect parameter. |
| InvalidParameterValue | Incorrect parameter value. |
| OperationDenied.UserHasNoStrategy | Error with CAM authentication. |
| UnauthorizedOperation | The operation is unauthorized. |
Yes
No
Was this page helpful?