Updated on 2024-06-07 GMT+08:00

Configuring the Maintenance Window

Function

This API is used to change the maintenance window as required. To prevent service interruption, the maintenance window should fall within the off-peak hours.

  • Before calling an API, you need to understand the API in Authentication.

URI

  • URI format

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

  • Parameter description
    Table 1 Parameter description

    Name

    Mandatory

    Description

    project_id

    Yes

    Project ID of a tenant in a region.

    For details about how to obtain the project ID, see Obtaining a Project ID.

    instance_id

    Yes

    Specifies the DB instance ID.

Request

Table 2 Parameter description

Name

Mandatory

Type

Description

start_time

Yes

String

Specifies the start time (UTC).

end_time

Yes

String

Specifies the end time (UTC).

NOTE:
  • For RDS for MySQL and RDS for PostgreSQL databases, the start time and end time must be on the hour, and the interval between them must be one to four hours.
  • For RDS for SQL Server databases, the interval between the start time and end time must be four hours.

Example Request

Set the maintenance window of a DB instance to 22:00-02:00.
PUT https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/ops-window

{
     "start_time": "22:00",
     "end_time":"02:00"
}

Response

Status Code

Error Code

For details, see Error Codes.