Help Center/ Document Database Service/ API Reference (Ally Region)/ APIs V3.0 (Recommended)/ Managing Databases and Users/ Setting the Activity Time Window for Cluster Balancing
Updated on 2026-01-08 GMT+08:00
View PDF
Share

Setting the Activity Time Window for Cluster Balancing

Description

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

Restrictions

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

URI

  • URI format

    PUT https://{Endpoint}/v3/{project_id}/instances/{instance_id}/balancer/active-window

Table 1 Path parameters

Name

Type

IN

Mandatory

Description

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.

Request Parameters

Table 2 Request header parameters

Parameter

Type

IN

Mandatory

Description

X-Auth-Token

string

header

Yes

User token
Table 3 Parameter description

Parameter

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.
  • Request example
    1. Setting the activity time window 
      {
    "start_time":"00:00",
    "stop_time":"02:00"
}
    2. Canceling the activity time window setting 
      {}

Response Parameters

Table 4 Parameter description

Parameter

Type

Mandatory

Description

job_id

String

Yes

The workflow ID.
  • Example response 
    {
    "job_id": "3711e2ad-5787-49bc-a47f-3f0b066af9f5"
}

Status Code

For details, see Status Code.

Error Code

For details, see Error Code.