Help Center/ Document Database Service/ API Reference/ APIs V3.0 (Recommended)/ Managing Databases and Users/ Querying Cluster Balancing Settings
Updated on 2022-12-12 GMT+08:00
View PDF

Querying Cluster Balancing Settings

Description

This API is used to query the data balancing settings of a DDS cluster, including whether balancing is enabled and the time window of balancing activities. The balancing activity time window information is returned only in DDS 4.0 and later versions.

Restrictions

Frozen instances do not support this operation.

URI

  • URI format

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

  • URI example

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

Requests

Parameter description

Table 1 Request parameters

Name

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.

Responses

  • Parameter description
    Table 2 Response to the request for querying the balancing settings of a cluster

    Name

    Type

    Mandatory

    Description

    is_open

    Boolean

    Yes

    Whether cluster balancing is enabled.

    active_window

    Object

    No

    The activity time window. For details, see Table 3.
    Table 3 Activity time window response message

    Name

    Type

    Mandatory

    Description

    start_time

    String

    No

    The start time of the activity time window.

    stop_time

    String

    No

    The end time of the activity time window.
  • Response example 
    {
    "is_open": true,
    "active_window": {
        "start_time":"00:00",
        "stop_time":"02:00"
    }
}

Status Code

For more information, see Status Code.

Error Code

For more information, see Error Code.