Updated on 2026-01-08 GMT+08:00

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}

Request Parameters

Table 1 Parameter description

Parameter

Type

IN

Mandatory

Description

X-Auth-Token

string

header

Yes

User token

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

Response Parameters

Table 2 Parameter description

Parameter

Type

Mandatory

Description

job_id

String

Yes

The workflow ID.

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

Status Code

For details, see Status Code.

Error Code

For details, see Error Code.