删除分片-DeletingShards
功能介绍
删除分片。
接口约束
- 支持版本为4.0及以上的社区版集群实例。
- 删除分片前请充分阅读使用须知，充分评估后再进行操作。
调试
您可以在API Explorer中调试该接口。
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
- 如果使用身份策略授权，需具备如下身份策略权限。
授权项
访问级别
资源类型（*为必须）
条件键
别名
依赖的授权项
dds:instance:deleteShards
write
instance
-
-
URI
POST /v3/{project_id}/instances/{instance_id}/shards/batch-delete
| 名称 | 是否必选 | 类型 | IN | 描述 |
|---|---|---|---|---|
| project_id | 是 | string | path | 参数解释： 租户在某一Region下的项目ID。请参考获取项目ID章节获取项目编号。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
| instance_id | 是 | string | path | 参数解释： 实例ID，可以调用“查询实例列表和详情-QueryingInstancesandDetails”接口获取。如果未申请实例，可以调用“创建实例-CreatingaDBInstance”接口创建。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
请求参数
| 名称 | 是否必选 | 类型 | IN | 描述 |
|---|---|---|---|---|
| X-Auth-Token | 是 | string | header | 参数解释： 从IAM服务获取的用户Token。请参考认证鉴权。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| ids | 是 | Array of strings | 参数解释： 组ID。可以调用“查询实例列表和详情”接口获取。 约束限制： 只支持shard组。 取值范围： 不涉及。 默认取值： 不涉及。 |
响应参数
状态码：202
| 参数 | 参数类型 | 描述 |
|---|---|---|
| job_id | String | 参数解释： 任务ID，仅按需实例返回该参数。 取值范围： 不涉及。 |
| order_id | String | 参数解释： 订单ID，仅包周期实例返回该参数。 取值范围： 不涉及。 |
请求示例
删除集群e73893ef73754465a8bd2e0857bbf13ein02实例的分片，组ID是51ba2ff4d1194e61ad231aa40d90aeb7gr02。
https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/e73893ef73754465a8bd2e0857bbf13ein02/shards/batch-delete
{ "ids" : [ "51ba2ff4d1194e61ad231aa40d90aeb7gr02" ]
} 响应示例
{
"job_id" : "f6b99612-2e70-4a1d-82cc-285c06726155"
} SDK
单击文档数据库服务 DDS SDK，下载SDK或查看SDK文档。SDK的安装、认证方式等在SDK文档中对应语言类型的【使用】目录下。
状态码
详情请参见状态码。
错误码
详情请参见错误码。
