文档首页/ CodeArts IDE Online/ API参考/ API/ IDE实例管理/ 查询某个IDE实例的状态
更新时间：2023-06-16 GMT+08:00
查看PDF
分享

查询某个IDE实例的状态

功能介绍

查询某个IDE实例的状态

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

GET /v2/instances/{instance_id}/status

表1 路径参数

参数

是否必选

参数类型

描述

instance_id

是

String

CodeArtsIDEOnline实例id

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

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

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

result

InstanceStatusResponse object

返回值

status

String

状态
表4 InstanceStatusResponse

参数

参数类型

描述

server_url

String

服务链接

status

String

实例状态。

  • DELETED 已删除

  • DELETE_FAILED 删除失败

  • DELETING 删除中

  • READY 热实例就绪状态

  • RUNNING 正在运行

  • STARTING 正在启动

  • STOPPED 已停止

  • STOPPING 停止中

  • UPDATE 更新Schdule信息

  • WAITING 热实例创建初始态

枚举值：

  • DELETED

  • DELETE_FAILED

  • DELETING

  • READY

  • RUNNING

  • STARTING

  • STOPPED

  • STOPPING

  • UPDATE

  • WAITING

状态码： 403

表5 响应Body参数

参数

参数类型

描述

error_msg

String

错误描述

error_code

String

错误码

状态码： 404

表6 响应Body参数

参数

参数类型

描述

error_msg

String

错误描述

error_code

String

错误码

状态码： 406

表7 响应Body参数

参数

参数类型

描述

error_msg

String

错误描述

error_code

String

错误码

请求示例

查询某个IDE实例的状态

GET https://{endpoint}/v2/instances/zhkfjt/status

响应示例

状态码： 200

OK

{
  "result" : {
    "server_url" : "xxxx",
    "status" : "STARTING"
  },
  "status" : "success"
}

状态码

状态码

描述

200

OK

403

Forbidden

404

Not Found

406

Not Acceptable

错误码

请参见错误码。

父主题： IDE实例管理

相关文档