Help Center/ GeminiDB/ API Reference/ APIs v3 (Recommended)/ Task Management/ Querying the Maintenance Period of an Instance
Updated on 2025-11-27 GMT+08:00
View PDF
Share

Querying the Maintenance Period of an Instance

Function

This function is used to query the maintenance period of an instance.

Constraints

This API supports the following types of instances:

  • GeminiDB Influx
  • GeminiDB Redis
  • GeminiDB Mongo
  • GeminiDB Cassandra

Authorization Information

Each account has permissions to call all APIs, but IAM users must have the required permissions specifically assigned.

  • If you are using role/policy-based authorization, see the required permissions in Permissions and Supported Actions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    gaussdbfornosql:instance:maintenanceWindow

    read

    -
    • g:ResourceTag/<tag-key>
    • g:EnterpriseProjectId

    nosql:instance:maintenanceWindow

    -

URI

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

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID of a user in a region

instance_id

Yes

String

Instance ID

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

maintenance_window

String

Maintenance time window of an instance

Example Request

Query the maintenance period of an instance.

GET 
https://{Endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/e73893ef73754465a8bd2e0857bbf13ein02/ops-window

Example Response

Status code: 200

Success

{ 
  "maintenance_window" : "02:00-06:00" 
}

Status Codes

For details, see Status Codes.

Error Codes

For details, see Error Codes.

Parent topic: Task Management