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

查询某个IDE实例的状态 - ShowInstanceStatusInfo

功能介绍

根据实例ID，获取某个IDE实例的状态。

调试

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

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备如下身份策略权限，更多的权限说明请参见权限和授权项。

授权项

访问级别

资源类型（*为必须）

条件键

别名

依赖的授权项

CodeArtsIDEOnline:instance:get

Permission_management

-

-

-

-

URI

GET /v2/instances/{instance_id}/status

表1 路径参数

参数

是否必选

参数类型

描述

instance_id

是

String

参数解释：

CodeArts IDE Online实例的id。

约束限制：

正则表达式：^[a-zA-Z0-9][-_.a-zA-Z0-9]{1,126}[a-zA-Z0-9]$。

取值范围：

长度为3~128。

默认取值：

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

用户Token。

约束限制：

不涉及。

取值范围：

长度为1~100000。

默认取值：

不涉及。

X-Sdk-Date

否

String

参数解释：

请求发起时间。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

host

否

String

参数解释：

请求host地址。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

x-security-token

否

String

参数解释：

IAM 5.0鉴权token。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

Authorization

否

String

参数解释：

AK/SK签名。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

result

InstanceStatusResponse object

参数解释：

返回值。

取值范围：

不涉及。

status

String

参数解释：

请求响应的状态，表明请求是否成功。

取值范围：

  • success：请求响应成功。

  • error：请求响应失败。
表4 InstanceStatusResponse

参数

参数类型

描述

server_url

String

参数解释：

服务链接。

取值范围：

不涉及

status

String

参数解释：

实例状态。

取值范围：

  • DELETED：实例已删除

  • DELETE_FAILED：实例删除失败

  • DELETING：实例删除中

  • READY：热实例就绪

  • RUNNING：实例正在运行

  • STARTING：实例正在启动

  • STOPPED：实例已停止

  • STOPPING：实例停止中

  • UPDATE：更新Schedule信息

  • WAITING：热实例创建初始态

状态码：403

表5 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释：

错误描述信息。详情请参见错误码。

取值范围：

长度为0~255。

error_code

String

参数解释：

错误码。详情请参见错误码。

取值范围：

长度为0~100。

状态码：404

表6 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释：

错误描述信息。详情请参见错误码。

取值范围：

长度为0~255。

error_code

String

参数解释：

错误码。详情请参见错误码。

取值范围：

长度为0~100。

状态码：406

表7 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释：

错误描述信息。详情请参见错误码。

取值范围：

长度为0~255。

error_code

String

参数解释：

错误码。详情请参见错误码。

取值范围：

长度为0~100。

请求示例

查询某个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实例管理

相关文档