解绑公网网关-UnbindingaPublicGateway
功能介绍
为实例下的节点解绑公网网关。
接口约束
- 冻结实例,异常实例不支持该操作。
- 集群实例仅支持mongos节点。
- 副本集实例仅支持Primary或者Secondary节点。
调试
您可以在API Explorer中调试该接口。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
dds:instance:unbindPublicGateway
write
instance
-
- nat:dnatRules:delete
- nat:dnatRules:get
- nat:dnatRules:list
- nat:natGateways:get
- nat:natGateways:list
- nat:natGateways:listTags
- nat:snatRules:list
- eip:publicIps:associateInstance
- eip:publicIps:disassociateInstance
URI
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 租户在某一Region下的项目ID。请参考获取项目ID章节获取项目编号。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
instance_id |
是 |
String |
参数解释: 实例ID,可以调用“查询实例列表和详情-QueryingInstancesandDetails”接口获取。如果未申请实例,可以调用“创建实例-CreatingaDBInstance”接口创建。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
node_id |
是 |
String |
参数解释: 需要解绑公网网关规则的节点ID。 约束限制: 集群实例选择mongos节点,副本集实例选择primary或者secondary节点。 取值范围: 不涉及。 默认取值: 不涉及。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释: 从IAM服务获取的用户Token。请参考认证鉴权。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
instance_id |
String |
参数解释: 实例ID。 取值范围: 不涉及。 |
|
instance_name |
String |
参数解释: 实例名称。 取值范围: 不涉及。 |
|
node_id |
String |
参数解释: 节点ID。 取值范围: 不涉及。 |
|
node_name |
String |
参数解释: 节点名称。 取值范围: 不涉及。 |
状态码:default
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释: 错误码。 取值范围: 不涉及。 |
|
error_msg |
String |
参数解释: 错误信息。 取值范围: 不涉及。 |
请求示例
DELETE https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/9136fd2a9fcd405ea4674276ce36dae8in02/nodes/52a4c096bb1f455d8d866956a959519eno02/public-gateway
响应示例
{
"instance_id" : "9136fd2a9fcd405ea4674276ce36dae8in02",
"instance_name" : "dds-4352",
"node_id" : "52a4c096bb1f455d8d866956a959519eno02",
"node_name" : "dds-4352_replica_node_1"
}
SDK
单击文档数据库服务 DDS SDK,下载SDK或查看SDK文档。SDK的安装、认证方式等在SDK文档中对应语言类型的【使用】目录下。
状态码
详情请参见状态码。
错误码
详情请参见错误码。