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

Updated on 2025-07-02 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	Explanation: Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID. Constraints: N/A Values: N/A Default value: N/A
instance_id	Yes	String	Explanation: Instance ID Constraints: N/A Values: N/A Default value: N/A

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Explanation: User token Constraints: N/A Values: N/A Default value: N/A

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
start_time	Yes	String	Explanation: Start time Constraints: The value must be a valid UTC time exactly on the hour in the HH:MM format. By default, the end time is four hours later than the start time. Values: N/A Default value: N/A

Response Parameters

Status code: 204

None

Example Request

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" 
}