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
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
Content-Type
Yes
String
Specifies the MIME type of the request body. You are advised to use the default value application/json. For APIs used to upload objects or images, the value can vary depending on the flow type.
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. Gap between "start_time" and "end_time" must be at least 1h.
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. Gap between "start_time" and "end_time" must be at least 1h.
Example request
Configuring the maintenance window
{ "start_time" : "14:00", "end_time" : "15:00" }
Responses¶
None
Status Code¶
Status Code:200.
For more information, see Status Code.
Error Code¶
For details, see Error Code.