获取堡垒机实例状态信息
功能介绍
获取堡垒机实例状态信息（未删除实例）。
调用方法
请参见如何调用API。
URI
GET /v2/{project_id}/cbs/instance/{server_id}/status
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
project_id |
是 |
String |
项目ID。 获取方法详见API参考，附录"获取项目ID" |
server_id |
是 |
String |
云堡垒机实例ID，使用UUID格式表示。 获取方法详见用户指南里面的实例"查看实例详情" |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 可参考"IAM获取IAM用户Token"获取 |
响应参数
状态码： 200
参数 |
参数类型 |
描述 |
|---|---|---|
name |
String |
云堡垒机实例名称。 |
status |
String |
堡垒机实例状态。
|
server_id |
String |
云堡垒机实例ID，使用UUID格式表示。 获取方法详见用户指南里面的实例"查看实例详情" |
状态码： 400
参数 |
参数类型 |
描述 |
|---|---|---|
error_code |
String |
错误码 |
error_description |
String |
请求参数错误。 |
状态码： 401
参数 |
参数类型 |
描述 |
|---|---|---|
error_code |
String |
错误码 |
error_description |
String |
校验TOKEN失败。 |
状态码： 403
参数 |
参数类型 |
描述 |
|---|---|---|
error_code |
String |
错误码 |
error_description |
String |
租户无权限操作。 |
状态码： 404
参数 |
参数类型 |
描述 |
|---|---|---|
error_code |
String |
错误码 |
error_description |
String |
没有找到CBH资源。 |
请求示例
无
响应示例
状态码： 200
Search Instance Info Success
{
"name" : "cbh-test",
"status" : "POWERING_ON",
"server_id" : "e113077b-xxxx-xxxx-xxxx-be60289cd258"
}
状态码
状态码 |
描述 |
|---|---|
200 |
Search Instance Info Success |
400 |
Bad Request |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
错误码
请参见错误码。
