更新时间：2025-10-23 GMT+08:00
查询集群均衡设置
功能介绍
查询DDS集群的数据均衡设置，包括均衡开关和均衡活动时间窗的设置。其中，均衡活动时间窗的信息仅在DDS 4.0及以上版本返回。
接口约束
冻结实例不支持该操作。
调试
您可以在API Explorer中调试该接口。
|
名称 |
是否必选 |
类型 |
IN |
描述 |
|---|---|---|---|---|
|
project_id |
是 |
string |
path |
参数解释： 租户在某一Region下的项目ID。请参考获取项目ID章节获取项目编号。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
instance_id |
是 |
string |
path |
参数解释： 实例ID，可以调用“查询实例列表和详情”接口获取。如果未申请实例，可以调用“创建实例”接口创建。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
请求参数
|
名称 |
是否必选 |
类型 |
IN |
描述 |
|---|---|---|---|---|
|
X-Auth-Token |
是 |
string |
header |
参数解释： 从IAM服务获取的用户Token。请参考认证鉴权。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
响应参数
|
名称 |
参数类型 |
是否必选 |
描述 |
|---|---|---|---|
|
is_open |
Boolean |
是 |
集群均衡是否打开。 |
|
active_window |
Object |
否 |
活动时间窗设置。请参见表4。 |
请求示例
https://{Endpoint}/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/cc6345c64cec47499182467ea0dd432ain02/balancer
响应示例
{
"is_open": true,
"active_window": {
"start_time":"00:00",
"stop_time":"02:00"
}
}
SDK
单击文档数据库服务 DDS SDK，下载SDK或查看SDK文档。SDK的安装、认证方式等在SDK文档中对应语言类型的【使用】目录下。
状态码
详情请参见状态码。
错误码
详情请参见错误码。
父主题： 管理数据库和用户
