更新时间:2025-11-25 GMT+08:00
分享

删除mongos节点-DeletingmongosNodes

接口说明

当集群实例需要缩减mongos节点时,需要调用此API。

调试

您可以在API Explorer中调试该接口。

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,需具备如下身份策略权限。

    授权项

    访问级别

    资源类型(*为必须)

    条件键

    别名

    依赖的授权项

    dds:instance:reduceNode

    write

    instance

    g:EnterpriseProjectId

    -

    -

URI

  • URI格式

    DELETE /v3/{project_id}/instances/{instance_id}/mongos-node

表1 请求参数

名称

类型

IN

是否必选

描述

X-Auth-Token

string

header

参数解释:

从IAM服务获取的用户Token。请参考认证鉴权

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

project_id

string

path

参数解释:

租户在某一Region下的项目ID。请参考获取项目ID章节获取项目编号。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

instance_id

string

path

参数解释:

实例ID,可以调用“查询实例列表和详情-QueryingInstancesandDetails”接口获取。如果未申请实例,可以调用“创建实例-CreatingaDBInstance”接口创建。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

请求消息

  • 参数说明
    表2 请求Body参数

    参数

    是否必选

    参数类型

    描述

    node_list

    Array of strings

    参数解释:

    所有需要删除的mongos节点ID,至少保留两个mongos节点。

    约束限制:

    不涉及。

    取值范围:

    不涉及。

    默认取值:

    不涉及。

  • 请求示例:
    删除实例520c58ba00a3497e97ce0b9604874dd6in02的mongos节点fea413b892214c53a58e5a529096ed75no02
    DELETE https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/520c58ba00a3497e97ce0b9604874dd6in02/mongos-node    
    {  
      "node_list" : [ "fea413b892214c53a58e5a529096ed75no02" ] 
     }

响应消息

  • 参数说明

    状态码:202

    表3 响应Body参数

    参数

    参数类型

    说明

    job_id

    String

    参数解释:

    任务ID,仅按需实例返回该参数。

    取值范围:

    不涉及。

    order_id

    String

    参数解释:

    订单ID,仅包周期实例返回该参数。

    取值范围:

    不涉及。

    状态码:default

    表4 ErrorResponse

    参数

    参数类型

    说明

    error_code

    String

    参数解释:

    提交任务异常时返回的错误编码。

    取值范围:

    不涉及。

    error_msg

    String

    参数解释:

    提交任务异常时返回的错误描述信息。

    取值范围:

    不涉及。

  • 响应示例

    状态码: 202

    Accepted.
    { 
      "job_id" : "6ad4eb1f-73bd-4876-aa31-aa9a1e41c4bc"  
    }

状态码

详情请参见状态码

错误码

详情请参见错误码

相关文档