文档首页/云堡垒机 CBH/API参考/API说明/操作管理/关闭堡垒机实例 - StopInstance
更新时间：2026-03-06 GMT+08:00
在线调试
CLI示例
查看PDF
分享

关闭堡垒机实例 - StopInstance

功能介绍

关闭云堡垒机实例。

调用方法

请参见如何调用API。

授权信息

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

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

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    cbh:instance:stopInstance

    Write

    instance *

    • g:EnterpriseProjectId

    • g:ResourceTag/tag-key

    -

    -

URI

POST /v2/{project_id}/cbs/instance/stop

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID。

获取方法请参见获取项目ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

获取方法请参见获取用户Token。

表3 请求Body参数

参数

是否必选

参数类型

描述

server_id

是

String

实例id

响应参数

状态码：200

Stop Cbh Instance Success

状态码：400

表4 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_description

String

请求参数错误。

状态码：401

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_description

String

校验TOKEN失败。

状态码：403

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_description

String

租户无权限操作。

状态码：404

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_description

String

没有找到CBH资源。

请求示例

{
  "server_id" : "c7277d87-5a0d-4cfc-a418-97acb567cf29"
}

响应示例

无

状态码

状态码

描述

200

Stop Cbh Instance Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

错误码

请参见错误码。

父主题：操作管理

相关文档