文档首页/ 文档数据库服务 DDS/ API参考（联盟区域）/ API v3（推荐）/ 管理数据库和用户/ 设置集群均衡开关
更新时间：2026-01-07 GMT+08:00
查看PDF
分享

设置集群均衡开关

接口说明

设置DDS集群的数据均衡开关。

约束说明

冻结实例不支持该操作。

URI

  • URI格式

    PUT https://{Endpoint}/v3/{project_id}/instances/{instance_id}/balancer/{action}

请求参数

表1 参数说明

名称

类型

IN

必选

描述

X-Auth-Token

string

header

是

用户Token。

project_id

string

path

是

租户在某一region下的project ID。请参考获取项目ID章节获取项目编号。

instance_id

string

path

是

实例ID，可以调用“查询实例列表和详情”接口获取。如果未申请实例，可以调用“创建实例”接口创建。

action

string

path

是

开启或关闭集群均衡。

响应参数

表2 参数说明

名称

参数类型

是否必选

描述

job_id

String

是

工作流ID。
  • 响应示例 
    {
    "job_id": "3711e2ad-5787-49bc-a47f-3f0b066af9f5"
}

状态码

详情请参见状态码。

错误码

详情请参见错误码。