DescribeMaintenanceWindow

Last updated: 2024-04-03 11:33:18

1. API Description

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

This API is used to query instance maintenance window. The maintenance window specifies a time period during which compatible version upgrade, architecture upgrade, backend maintenance, and other operations can be performed to avoid affecting business.

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: DescribeMaintenanceWindow.
Version	Yes	String	Common Params. The value used for this API: 2018-04-12.
Region	No	String	Common Params. This parameter is not required for this API.
InstanceId	Yes	String	Instance ID

3. Output Parameters

Parameter Name	Type	Description
StartTime	String	Start time of the maintenance window, such as 17:00.
EndTime	String	End time of the maintenance window, such as 19:00.
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 Sample

Input Example

https://redis.tencentcloudapi.com/?Action=DescribeMaintenanceWindow
&InstanceId=crs-5a4py64p
&<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

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
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.

tencent cloud

Recent Pages