产品动态
公告
Domain name for API request: redis.intl.tencentcloudapi.com.
This API is used to query the event information on a TecentDB for Redis instance.
A maximum of 50 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: DescribeInstanceEvents. |
| Version | Yes | String | Common Params. The value used for this API: 2018-04-12. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| ExecutionStartDate | Yes | String | Start date for querying the event execution plan, with a maximum query span of 30 days. |
| ExecutionEndDate | Yes | String | End date for querying the event execution plan, with a maximum query span of 30 days. |
| InstanceId | No | String | Specifies the instance ID. Example: crs-xjhsdj****. Log in to the TencentDB for Redis console and copy the instance ID in the instance list. |
| PageSize | No | Integer | Outputs the number of events displayed per page. - Default value: 10. - Value range: [1, 100]. |
| PageNo | No | Integer | Configures the output page number for querying events. You can query events on a certain page by specifying PageNo (page number) and PageSize (number of output results per page). - Default value: 1. - Value range: positive integers greater than 0. |
| Status.N | No | Array of String | Current status of the event.- Waiting: The event is waiting for execution on the execution date or during the operations period.- Running: The event is being executed during the operations period.- Finished: Execution of the event is completed.- Canceled: Execution of the event is canceled. |
| EventTypes.N | No | Array of String | Event type. Currently, the type can only be related to instance migration, resource movement, and IDC deletion. This parameter can be set only to InstanceMigration. |
| Grades.N | No | Array of String | Configures the level of the queried event. Events are divided into Critical, High, Medium, and Low events according to the severity and urgency.- Critical- High- Medium- Low |
| Parameter Name | Type | Description |
|---|---|---|
| TotalCount | Integer | Total number of events. |
| RedisInstanceEvents | Array of RedisInstanceEvent | Instance event information. |
| 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. |
This example shows you how to query instance events.
POST / HTTP/1.1
Host: redis.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeInstanceEvents
<Common request parameters>
{
"InstanceId": "crs-b6wst31p",
"PageSize": 20,
"PageNo": 1,
"ExecutionStartDate": "2023-10-04",
"ExecutionEndDate": "2023-10-04",
"Grades": [
"Low"
],
"Status": [
"Waiting"
],
"EventTypes": [
"InstanceMigration"
]
}{
"Response": {
"RedisInstanceEvents": [
{
"EffectInfo": "Momentary disconnection that lasts for several seconds will occur after the migration is completed.",
"EndTime": "22:00",
"ExecutionDate": "2023-09-18",
"Grade": "Low",
"ID": 10,
"InitialExecutionDate": "2023-08-19",
"InstanceId": "crs-b6wst31p",
"InstanceName": "benyqhuang8",
"LatestExecutionDate": "2023-09-18",
"StartTime": "21:00",
"Status": "Waiting",
"TaskEndTime": "0000-00-00 00:00:00",
"Type": "InstanceMigration"
}
],
"RequestId": "36a33a3d-f9ce-47c1-87d0-84869a37466d",
"TotalCount": 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.SystemError | Internal system error, which is irrelevant to the business. |
| InternalError.DbOperationFailed | Internal system error with the database operation, which may be update, insert, select, etc. |
| InvalidParameter.ActionNotFound | The corresponding API was not found. |
| InvalidParameter.InvalidParameter | Invalid service parameter. |
| InvalidParameter.PermissionDenied | The API has no CAM permissions. |
| UnauthorizedOperation.NoCAMAuthed | No CAM permissions. |
| UnsupportedOperation.InstanceNotOperation | Unsupported operation |
文档反馈