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

查询集群均衡设置

接口说明

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

约束说明

冻结实例不支持该操作。

URI

  • URI格式

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

  • URI样例

    https://dds.ap-southeast-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/cc6345c64cec47499182467ea0dd432ain02/balancer

请求消息

参数说明

表1 请求参数

名称

类型

IN

是否必选

描述

X-Auth-Token

string

header

是

从IAM服务获取的用户Token。请参考认证鉴权。

project_id

string

path

是

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

instance_id

string

path

是

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

响应消息

  • 参数说明
    表2 查询集群均衡设置响应消息

    名称

    参数类型

    是否必选

    描述

    is_open

    Boolean

    是

    集群均衡是否打开。

    active_window

    Object

    否

    活动时间窗设置。请参见表3。
    表3 活动时间窗响应消息

    名称

    参数类型

    是否必选

    描述

    start_time

    String

    否

    活动时间窗开始时间。

    stop_time

    String

    否

    活动时间窗结束时间。
  • 响应示例 
    {
    "is_open": true,
    "active_window": {
        "start_time":"00:00",
        "stop_time":"02:00"
    }
}

SDK

单击文档数据库服务 DDS SDK，下载SDK或查看SDK文档。SDK的安装、认证方式等在SDK文档中对应语言类型的【使用】目录下。

状态码

详情请参见状态码。

错误码

详情请参见错误码。