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

查询集群均衡设置

接口说明

查询DDS集群的数据均衡设置，包括均衡开关和均衡活动时间窗的设置。其中，均衡活动时间窗的信息仅在DDS 4.0及以上版本返回。

约束说明

冻结实例不支持该操作。

URI

  • URI格式

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

表1 路径参数

名称

类型

IN

是否必选

描述

project_id

string

path

是

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

instance_id

string

path

是

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

请求参数

表2 请求Header参数

名称

类型

IN

是否必选

描述

X-Auth-Token

string

header

是

用户Token。

响应参数

表3 查询集群均衡设置响应消息

名称

参数类型

是否必选

描述

is_open

Boolean

是

集群均衡是否打开。

active_window

Object

否

活动时间窗设置。请参见表4。

表4 活动时间窗响应消息

名称

参数类型

是否必选

描述

start_time

String

否

活动时间窗开始时间。

stop_time

String

否

活动时间窗结束时间。

  • 响应示例 
    {
    "is_open": true,
    "active_window": {
        "start_time":"00:00",
        "stop_time":"02:00"
    }
}

状态码

详情请参见状态码。

错误码

详情请参见错误码。