AddTimeWindow

最后更新时间:2021-10-12 17:21:10

1. API Description

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

This API (AddTimeWindow) is used to add a maintenance time window for a TencentDB instance, so as to specify when the instance can automatically perform access switch operations.

A maximum of 100 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 parameter. The value used for this API: AddTimeWindow.
Version Yes String Common parameter. The value used for this API: 2017-03-20.
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
InstanceId Yes String Instance ID in the format of cdb-c1nl9rpv or cdbro-c1nl9rpv. It is the same as the instance ID displayed on the TencentDB Console page.
Monday.N No Array of String Maintenance window on Monday. The format should be 10:00-12:00. You can set multiple time windows on a day. Each time window lasts from half an hour to three hours, and must start and end on the hour or half hour. At least one time window is required in a week. The same rule applies to the following parameters.
Tuesday.N No Array of String Maintenance window on Tuesday. At least one time window is required in a week.
Wednesday.N No Array of String Maintenance window on Wednesday. At least one time window is required in a week.
Thursday.N No Array of String Maintenance window on Thursday. At least one time window is required in a week.
Friday.N No Array of String Maintenance window on Friday. At least one time window is required in a week.
Saturday.N No Array of String Maintenance window on Saturday. At least one time window is required in a week.
Sunday.N No Array of String Maintenance window on Sunday. At least one time window is required in a week.

3. Output Parameters

Parameter Name Type Description
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Adding a maintenance window

Input Example

https://cdb.tencentcloudapi.com/?Action=AddTimeWindow
&InstanceId=cdb-eb2w7dto
&Monday.0=02:00-03:00
&<Common request parameters>

Output Example

{
  "Response": {
    "RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7"
  }
}

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
InvalidParameter Parameter error.
InvalidParameter.InstanceNotFound The instance does not exist.
InvalidParameter.ResourceExists The resource already exists.