Help Center/ GeminiDB/ API Reference/ APIs v3 (Recommended)/ Instances/ Setting the Maintenance Period of an Instance

Updated on 2024-10-30 GMT+08:00

View PDF

Setting the Maintenance Period of an Instance

Function

This API is used to set the maintenance period of a specified instance.

Constraints

This API supports the following types of instances:

GeminiDB Influx
GeminiDB Redis
GeminiDB Mongo
GeminiDB Cassandra

URI

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

**Table 1** Path 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

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token

**Table 3** Request body parameters
Parameter	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 and must be on the hour. By default, the interval between the end time and the start time is four hours.

Response Parameters

Status code: 204

None

Example Requests

Set the maintenance window of an instance to 02:00-06:00.

PUT https://gaussdb-nosql.cn-north-7.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/b0965c9010f44ffca9af4ee00746aa8din12/maintenance-window 
 
{ 
  "start_time" : "02:00" 
}