查询实例状态 - ShowInstanceStatus
功能介绍
查询实例状态
调用方法
请参见如何调用API。
授权信息
账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。
| 授权项 | 访问级别 | 资源类型(*为必须) | 条件键 | 别名 | 依赖的授权项 |
|---|---|---|---|---|---|
| clouddc:instance:get | Read | - | - | - | - |
URI
GET /v1/{project_id}/instances/{id}/status
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID 约束限制: 不涉及 取值范围: 账号的项目ID 默认取值: 不涉及 |
| id | 是 | String | 参数解释: 实例ID, 创建实例CreateInstance请求响应返回的值 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 调用接口的认证方式分为Token,如果您使用的Token方式,此参数为必填,请填写Token的值 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| state | String | 参数解释: 实例状态 约束限制: 不涉及 取值范围: stateDiagram-v2
[*] --> pending: CreateInstance
pending --> running: CreateInstance Succeed
pending --> shutting_down: DeleteInstance
running --> stopped: PowerOff/PowerReboot
stopped --> running: PowerOn/Provision Succeed
stopped --> stopped: ChangePassword
pending --> error: CreateInstance Failed
stopped --> error: Provision Failed
error --> running: Retry Provision Succeed
stopped --> shutting_down: DeleteInstance
error --> shutting_down: Retry DeleteInstance
shutting_down --> error: DeleteInstance Failed
shutting_down --> terminated: DeleteInstance Succeed 默认取值: 不涉及 |
| operation_state | String | 参数解释: 操作状态 约束限制: 不涉及 取值范围: 默认取值: 不涉及 |
| error | ErrorStatus object | 参数解释: 失败时返回的错误对象 约束限制: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码 |
| error_msg | String | 参数解释: 错误描述 |
| error_type | String | 参数解释: 错误类型 约束限制: 不涉及 取值范围: 默认取值: 不涉及 |
状态码:401
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码 |
| error_msg | String | 参数解释: 错误描述 |
状态码:429
| 参数 | 参数类型 | 描述 |
|---|---|---|
| - | String | - |
状态码:500
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码 |
| error_msg | String | 参数解释: 错误描述 |
请求示例
查询实例状态
GET https://{endpoint}/v1/{project_id}/instances/{id}/status 响应示例
状态码:200
实例状态
{
"state" : "stopped"
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 实例状态 |
| 401 | 请求未鉴权 |
| 429 | 请求过载 |
| 500 | 服务端内部错误 |
错误码
请参见错误码。