1. API Description
Domain name for API request: redis.intl.tencentcloudapi.com.
This API is used to query the instance maintenance window. Instances that require the version or architecture upgrade will undergo time switching during the maintenance window.
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.
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: DescribeMaintenanceWindow. |
| 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. |
| InstanceId |
Yes |
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. |
3. Output Parameters
| Parameter Name |
Type |
Description |
| StartTime |
String |
Start time of the maintenance window. Value range: any time point between 00:00 and 23:00, for example, 03:24. |
| EndTime |
String |
End time of the maintenance window. - Value range: any time point between 00:00 and 23:00, for example, 04:24. - The minimum maintenance duration is 30 minutes and the maximum is 3 hours. - The end time should be later than the start time. |
| 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 Querying an Instance Maintenance Window
This example shows you how to query an instance maintenance window. The query result is 03:00-06:00.
https:
&InstanceId=crs-5a4p****
&<Common request parameters>
Output Example
{
"Response": {
"StartTime": "03:00",
"EndTime": "06:00",
"RequestId": "0e728fa9-c2e5-4bf8-8d6b-c1c4fab7b6db"
}
}
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
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.SystemError |
Internal system error, which is irrelevant to the business. |
| UnauthorizedOperation.NoCAMAuthed |
No CAM permissions. |
| UnauthorizedOperation.UserNotInWhiteList |
The user is not in the allowlist. |
| UnsupportedOperation.ClusterInstanceAccessedDeny |
The Redis cluster edition is not allowed to connect to a security group. |