Help Center/ Document Database Service/ API Reference (Ally Region)/ APIs V3.0 (Recommended)/ Managing Databases and Users/ Querying Cluster Balancing Settings
Updated on 2026-01-08 GMT+08:00
View PDF
Share

Querying Cluster Balancing Settings

Description

This API is used to query the data balancing settings of a DDS cluster, including whether balancing is enabled and the time window of balancing activities. The balancing activity time window information is returned only in DDS 4.0 and later versions.

Restrictions

Frozen instances do not support this operation.

URI

  • URI format

    GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/balancer

Table 1 Path parameters

Parameter

Type

IN

Mandatory

Description

project_id

string

path

Yes

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

instance_id

string

path

Yes

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.

Request Parameters

Table 2 Request header parameters

Parameter

Type

IN

Mandatory

Description

X-Auth-Token

string

header

Yes

User token

Response Parameters

Table 3 Response to the request for querying the balancing settings of a cluster

Parameter

Type

Mandatory

Description

is_open

Boolean

Yes

Whether cluster balancing is enabled.

active_window

Object

No

The activity time window. For details, see Table 4.
Table 4 Activity time window response message

Parameter

Type

Mandatory

Description

start_time

String

No

The start time of the activity time window.

stop_time

String

No

The end time of the activity time window.
  • Example response 
    {
    "is_open": true,
    "active_window": {
        "start_time":"00:00",
        "stop_time":"02:00"
    }
}

Status Code

For more information, see Status Code.

Error Code

For more information, see Error Code.