Help Center/ TaurusDB/ API Reference/ APIs (Recommended)/ Instance Management/ Changing a Maintenance Window
Updated on 2024-09-11 GMT+08:00
View PDF
Share

Changing a Maintenance Window

Function

This API is used to change a maintenance window. To prevent service interruption, set the maintenance window to off-peak hours. Before calling this API:

URI

PUT /v3/{project_id}/instances/{instance_id}/ops-window

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID of a tenant in a region.

To obtain this value, see Obtaining a Project ID.

instance_id

Yes

String

Instance ID, which is compliant with the UUID format.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

It can be obtained by calling the IAM API used to obtain a user token.

The value of X-Subject-Token in the response header is the token value.

X-Language

No

String

Request language type. The default value is en-us.

Values:

  • en-us
  • zh-cn
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

start_time

Yes

String

Start time for a maintenance window (UTC time).

end_time

Yes

String

End time for a maintenance window (UTC time).

NOTE:

The start time and end time of a maintenance window must be on the hour, and the interval between them must be four hours.

Response Parameters

Status code: 400

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Request

Changing the maintenance window of a DB instance to 22:00-02:00

PUT https://{endpoint}/v3/056538411200d4cd2f79c003c7606412/instances/096c0fc43e804757b59946b80dc27f8bin07/ops-window
{
  "start_time" : "22:00",
  "end_time" : "02:00"
}

Example Response

Status code: 200

Success.

{ }

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.

Parent topic: Instance Management