Domain name for API request: sqlserver.tencentcloudapi.com.
This API is used to query the list of extended events.
A maximum of 20 requests can be initiated per second for this API.
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: DescribeXEvents. |
Version | Yes | String | Common Params. The value used for this API: 2018-03-28. |
Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
InstanceId | Yes | String | Instance ID |
EventType | Yes | String | Event type. Valid values: slow (Slow SQL event), blocked (blocking event), deadlock` (deadlock event). |
StartTime | Yes | String | Generation start time of an extended file in the format of yyyy-MM-dd HH:mm:ss. |
EndTime | Yes | String | Generation end time of an extended file in the format of yyyy-MM-dd HH:mm:ss. |
Offset | No | Integer | Page number. Default value: 0 |
Limit | No | Integer | Number of entries to be returned per page. Value range: 1-100. Default value: 20 |
Parameter Name | Type | Description |
---|---|---|
Events | Array of Events | List of extended events |
TotalCount | Integer | Total number of extended events |
RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
This example shows you how to query the record of an extended event for an instance, including slow SQL, blocking, and deadlock.
POST / HTTP/1.1
Host: sqlserver.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeXEvents
<Common request parameters>
{
"Offset": 0,
"Limit": 2,
"StartTime": "2023-03-05 11:49:08",
"EndTime": "2023-03-13 11:49:08",
"EventType": "slow",
"InstanceId": "mssql-qp7gu6ch"
}
{
"Response": {
"RequestId": "023a2da2-c152-11ed-b1aa-525400853186",
"TotalCount": 10,
"Events": [
{
"EndTime": "2023-03-10 15:45:05",
"EventType": "slow",
"ExternalAddr": "https://***",
"FileName": "autoed_instance_58001_20230220110419.xel",
"Id": 1004,
"InternalAddr": "https:***",
"Size": 10240,
"StartTime": "2023-03-10 15:44:15",
"Status": 1
}
]
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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.CosError | Failed to access COS. |
FailedOperation.DBError | Database error. |
FailedOperation.GcsError | The operation failed or the network timed out. |
InvalidParameter.InputIllegal | Input error. |
InvalidParameter.ParamsAssertFailed | An error occurred while converting parameter assertion. |
ResourceNotFound.InstanceNotFound | The instance does not exist. |
ResourceNotFound.ParamsNotFound | Parameter not found. |
UnauthorizedOperation.PermissionDenied | CAM authentication error. |
本页内容是否解决了您的问题?