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

查询实例状态

功能介绍

查询实例状态

调用方法

请参见如何调用API

URI

GET /v1/{project_id}/instances/{id}/status

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

项目ID

约束限制

不涉及

取值范围

账号的项目ID

默认取值

不涉及

id

String

参数解释

实例ID

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释

调用接口的认证方式分为Token,如果您使用的Token方式,此参数为必填,请填写Token的值

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

state

String

参数解释

实例状态

约束限制

不涉及

取值范围

  • pending:实例正在启动(分配资源/启动操作系统)

  • running:实例正常运行(可接受SSH/RDP连接)

  • stopping:实例正在关闭(停止/休眠过渡状态)

  • stopped: 实例已完全关闭(存储卷保留)

  • reinstalling:实例正在重装中

  • shutting-down:实例正在终止(删除流程中)

  • terminated:实例已终止(资源完全删除,不可恢复)

  • failed:实例处于失败状态,对于reinstall操作可重试,其它操作不可重试并清除相关资源

默认取值

不涉及

error

ErrorStatus object

参数解释

失败时返回的错误对象

约束限制

不涉及

表4 ErrorStatus

参数

参数类型

描述

error_code

String

参数解释

错误码

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

error_msg

String

参数解释

错误描述

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

error_type

String

参数解释

错误类型

约束限制

不涉及

取值范围

  • create_instance_error:创建实例异常

  • delete_instance_error:删除实例异常

  • reinstall_error:重装OS异常

  • modify_ip_error:修改IP异常

  • verify_server_error:验证服务器异常

  • delete_server_error:删除服务器异常

默认取值

不涉及

状态码:401

表5 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

错误码

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

error_msg

String

参数解释

错误描述

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

状态码:429

表6 响应Body参数

参数

参数类型

描述

-

String

-

状态码:500

表7 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

错误码

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

error_msg

String

参数解释

错误描述

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

请求示例

查询实例状态

GET https://{endpoint}/v1/{project_id}/instances/{id}/status

响应示例

状态码:200

实例状态

{
  "status" : "stopped"
}

状态码

状态码

描述

200

实例状态

401

请求未鉴权

429

请求过载

500

服务端内部错误

错误码

请参见错误码

相关文档