Setting the Activity Time Window for Cluster Balancing

Description

This API is used to set the activity time window for DDS cluster balancing.

The UTC time is used. You need to convert the local time based on the time zone.

Constraints

Frozen instances do not support this operation.

DDS instances of versions earlier than 4.0 do not support this operation.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.

If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
dds:instance:setBalancerWindow	write	instance	g:EnterpriseProjectId	dds:instance:balancer	-

URI

URI format
PUT /v3/{project_id}/instances/{instance_id}/balancer/active-window
URI example
https://dds.ap-southeast-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/cc6345c64cec47499182467ea0dd432ain02/balancer/active-window

**Table 1** URI parameters
Name	Mandatory	Type	IN	Description
project_id	Yes	string	path	Definition Project ID of a tenant in a region. To obtain the project ID, see Obtaining a Project ID. Constraints N/A Range N/A Default Value N/A
instance_id	Yes	string	path	Definition 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 Range N/A Default Value N/A

Request

**Table 2** Request header 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

**Table 3** Parameter description
Name	Type	Mandatory	Description
start_time	String	No	The start time of the balancing activity time window. The format is HH:MM. If start_time is set, stop_time must be set. If neither of them is set, the setting of time window is canceled.
stop_time	String	No	The end time of the balancing activity time window. The format is HH:MM. If stop_time is set, start_time must be set. If neither of them is set, the setting of time window is canceled.

Example Request

Setting the activity time window

{
    "start_time":"00:00",
    "stop_time":"02:00"
}

Canceling the activity time window setting
```
{}
```

Response

Parameter description

**Table 4** Parameter description
Name	Type	Mandatory	Description
job_id	String	Yes	The workflow ID.

Example Response

{
    "job_id": "3711e2ad-5787-49bc-a47f-3f0b066af9f5"
}

SDK

Click Document Database Service DDS SDK to download the SDK or view the SDK document. To learn how to install and authenticate an SDK, read the Usage section.