Enabling or Disabling Cluster Balancing

Description

This API is used to enable or disable cluster balancing.

Restrictions

Frozen instances do not support this operation.

URI

URI format
PUT https://{Endpoint}/v3/{project_id}/instances/{instance_id}/balancer/{action}
URI example
https://dds.ap-southeast-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/cc6345c64cec47499182467ea0dd432ain02/balancer/start

Requests

Parameter description

**Table 1** Request parameters
Name	Type	IN	Mandatory	Description
X-Auth-Token	string	header	Yes	User token obtained from IAM. For details, see Authentication.
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.
action	string	path	Yes	Enable or disable cluster balancer

Responses

Parameter description

**Table 2** Parameter description
Name	Type	Mandatory	Description
job_id	String	Yes	The workflow ID.

Response example

{
    "job_id": "3711e2ad-5787-49bc-a47f-3f0b066af9f5"
}

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.