删除集群的Shard/Config IP
接口说明
删除集群的Shard/Config IP。
约束说明
- 冻结实例不支持该操作。
- 在删除期间,对应节点的IP不可访问。
- 在删除期间,对应shard或config的节点会进行重启,文档数据库实例重启过程中将不可用,请谨慎操作。
- 支持版本为4.0及以上的社区版集群实例。
调试
您可以在API Explorer中调试该接口。
URI
请求消息
- 参数说明
表2 请求Header参数 名称
类型
IN
是否必选
描述
X-Auth-Token
string
header
是
参数解释:
从IAM服务获取的用户Token。请参考认证鉴权。
约束限制:
不涉及。
取值范围:
不涉及。
默认取值:
不涉及。
请求Body参数名称
参数类型
是否必选
描述
type
String
是
参数解释:
需要删除IP的组类型。
约束限制:
不涉及。
取值范围:
- shard:表示删除所有Shard组IP。
- config:表示删除Config组IP。
默认取值:
不涉及。
请求示例
- 删除实例520c58ba00a3497e97ce0b9604874dd6in02的config IP:
DELETE https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/520c58ba00a3497e97ce0b9604874dd6in02/ip { "type" : "config" }
- 删除实例520c58ba00a3497e97ce0b9604874dd6in02所有的shard IP:
DELETE https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/520c58ba00a3497e97ce0b9604874dd6in02/ip { "type" : "shard" }
响应消息
参数 |
参数类型 |
是否必选 |
描述 |
---|---|---|---|
job_id |
String |
是 |
参数解释: 任务ID。 取值范围: 不涉及。 |
响应示例
无。
SDK
单击文档数据库服务 DDS SDK,下载SDK或查看SDK文档。SDK的安装、认证方式等在SDK文档中对应语言类型的【使用】目录下。
状态码
详情请参见状态码。
错误码
详情请参见错误码。