Querying Cluster Balancing Settings
Function
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.
Constraints
Frozen instances do not support this operation.
|
Name |
Mandatory |
Type |
IN |
Description |
|---|---|---|---|---|
|
project_id |
Yes |
string |
path |
Explanation: Project ID of a tenant in a region. To obtain the project ID, see Obtaining a Project ID. Constraints: N/A Value range: N/A Default value: N/A |
|
instance_id |
Yes |
string |
path |
Explanation: 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. Constraints: N/A Value range: N/A Default value: N/A |
Request Parameters
|
Name |
Mandatory |
Type |
IN |
Description |
|---|---|---|---|---|
|
X-Auth-Token |
Yes |
string |
header |
Definition User token obtained from IAM. For details, see Authentication. Constraints N/A Range N/A Default Value N/A |
Response Parameters
|
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 4. |
Example Requests
https://{Endpoint}/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/cc6345c64cec47499182467ea0dd432ain02/balancer
Example Responses
{
"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.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.
