设置集群均衡活动时间窗-SettingtheActivityTimeWindowforClusterBalancing
接口说明
设置DDS集群的数据均衡活动时间窗。
设置的是utc时间,需要根据自身时区做时间换算。
约束说明
- 冻结实例不支持该操作。
- 4.0以下版本的DDS实例不支持该操作。
调试
您可以在API Explorer中调试该接口。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
dds:instance:setBalancerWindow
write
instance
dds:instance:balancer
-
URI
|
名称 |
是否必选 |
类型 |
IN |
描述 |
|---|---|---|---|---|
|
project_id |
是 |
string |
path |
参数解释: 租户在某一Region下的项目ID。请参考获取项目ID章节获取项目编号。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
instance_id |
是 |
string |
path |
参数解释: 实例ID,可以调用“查询实例列表和详情-QueryingInstancesandDetails”接口获取。如果未申请实例,可以调用“创建实例-CreatingaDBInstance”接口创建。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
请求消息
|
名称 |
是否必选 |
类型 |
IN |
描述 |
|---|---|---|---|---|
|
X-Auth-Token |
是 |
string |
header |
参数解释: 从IAM服务获取的用户Token。请参考认证鉴权。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
名称 |
参数类型 |
是否必选 |
描述 |
|---|---|---|---|
|
start_time |
String |
否 |
均衡时间窗的开始时间,设置格式为“HH:MM”。 如果设置了start_time,则必须设置stop_time。如果两者都不设置,表示取消均衡时间窗设置。 |
|
stop_time |
String |
否 |
均衡时间窗的结束时间,设置格式为“HH:MM”。 如果设置了stop_time,则必须设置start_time。如果两者都不设置,表示取消均衡时间窗设置。 |
请求示例
- 设置活动时间窗
{ "start_time":"00:00", "stop_time":"02:00" } - 取消活动时间窗设置
{}
响应消息
- 参数说明
表4 参数说明 名称
参数类型
是否必选
描述
job_id
String
是
工作流ID。
- 响应示例
{ "job_id": "3711e2ad-5787-49bc-a47f-3f0b066af9f5" }
SDK
单击文档数据库服务 DDS SDK,下载SDK或查看SDK文档。SDK的安装、认证方式等在SDK文档中对应语言类型的【使用】目录下。
状态码
详情请参见状态码。
错误码
详情请参见错误码。