Updated on 2023-11-24 GMT+08:00

Configuring the Maintenance Window

API Description

This API is used to modify the time range within which you are allowed to start a task that affects the running of database instances, for example, the time window for upgrading the operating system and database software.

URI

  • URI format

    PUT https://{Endpoint}/v3/{project_id}/instances/{instance_id}/maintenance-window

  • URI example
    https://dds.cn-north-1.myhuaweicloud.com/v3/054e292c9880d4992f02c0196d3ea468/instances/054e292c9880d4992f02c0196d3ein02/maintenance-window
    Table 1 Path parameters

    Name

    Mandatory

    Type

    Description

    project_id

    Yes

    String

    Project ID of a tenant in a region. To obtain the project ID, see Obtaining a Project ID.

    instance_id

    Yes

    String

    Instance ID, which can be obtained by calling the API described in Querying Instances and Details. If you do not have an instance, call the API described in Creating a DB Instance to create one.

Requests

  • Parameter description
    Table 2 Request header parameters

    Name

    Mandatory

    Type

    Description

    X-Auth-Token

    Yes

    String

    User token obtained from IAM. For details, see Authentication.

    Table 3 Request body parameters

    Name

    Mandatory

    Type

    Description

    start_time

    Yes

    String

    Start time. The value must be a valid value in the "HH:MM" format. The current time is the UTC time. The value cannot be the same as the end time and must be on the hour.

    end_time

    Yes

    String

    End time. The value must be a valid value in the "HH:MM" format. The current time is the UTC time. The value cannot be the same as the start time and must be on the hour.

Example Request

Configuring the maintenance window

PUT https://dds.cn-north-1.myhuaweicloud.com/v3/054e292c9880d4992f02c0196d3ea468/instances/054e292c9880d4992f02c0196d3ein02/maintenance-window 
{ 
  "start_time" : "14:00",
  "end_time" : "15:00"
}

Response Parameters

None

Response Example

None

Status Code

For details, see Status Code.

Error Code

For details, see Error Code.