Querying Cluster Balancing Settings

Function

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.

Constraints

Frozen instances do not support this operation.

Authorization Information

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

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.

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
dds:instance:getShardingBalancer	read	instance	g:EnterpriseProjectId	dds:instance:balancer	-

URI

URI format
GET /v3/{project_id}/instances/{instance_id}/balancer

**Table 1** URI parameters
Name	Mandatory	Type	IN	Description
project_id	Yes	string	path	Definition Project ID of a tenant in a region. To obtain the project ID, see Obtaining a Project ID. Constraints N/A Range N/A Default Value N/A
instance_id	Yes	string	path	Definition 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. Constraints N/A Range N/A Default Value N/A

Request Parameters

**Table 2** Request header parameters
Name	Mandatory	Type	IN	Description
X-Auth-Token	Yes	string	header	Definition User token obtained from IAM. For details, see Authentication. Constraints N/A Range N/A Default Value N/A

Response Parameters

**Table 3** Response to the request for querying the balancing settings of a cluster
Name	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
Name	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 Request

https://{Endpoint}/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/cc6345c64cec47499182467ea0dd432ain02/balancer

Example Response

{
    "is_open": true,
    "active_window": {
        "start_time":"00:00",
        "stop_time":"02:00"
    }
}

SDK

Click Document Database Service DDS SDK to download the SDK or view the SDK document. To learn how to install and authenticate an SDK, read the Usage section.