文档首页/ CodeArts IDE Online/ API参考/ API/ IDE实例管理/ 修改IDE实例
更新时间：2025-08-15 GMT+08:00
查看PDF
分享

修改IDE实例

功能介绍

修改IDE实例 （修改描述和展示名）。

调试

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

URI

PUT /v2/instances/{instance_id}

表1 路径参数

参数

是否必选

参数类型

描述

instance_id

是

String

参数解释：

实例id

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

用户Token。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

X-Sdk-Date

否

String

参数解释：

请求发起时间。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

host

否

String

参数解释：

请求host地址。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

x-security-token

否

String

参数解释：

IAM 5.0鉴权token。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

Authorization

否

String

参数解释：

AK/SK签名。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。
表3 请求Body参数

参数

是否必选

参数类型

描述

description

否

String

参数解释：

IDE实例描述。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

display_name

是

String

参数解释：

IDE实例名。

约束限制：

输入中文、数字、字母、下划线、点、破折号。

取值范围：

3~100

默认取值：

不涉及。

refresh_interval

是

String

参数解释：

自动休眠时长。实例无操作超过自动休眠时长后，将会被暂停（已保存的数据不会被删除）。

约束限制：

除-1外，其它值的单位为“分钟”。

取值范围：

  • arm架构：可以设置成30，60。
  • x86架构：可以设置为30，60，240，1440和-1。其中-1表示实例不会自动停止。

默认取值：

不涉及。

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

result

Boolean

参数解释：

返回IDE实例名，查看实例名状态。

取值范围：

不涉及

status

String

参数解释：

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

取值范围：

  • success：请求响应成功。

  • error：请求响应失败。

状态码：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

参数解释：

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

取值范围：

不涉及。

状态码：500

表8 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释：

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

取值范围：

不涉及。

error_code

String

参数解释：

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

取值范围：

不涉及。

请求示例

修改IDE实例

PUT https://{endpoint}/v2/instances/zhkfjt

{
  "display_name" : "testjava",
  "description" : "test",
  "refresh_interval" : "30"
}

响应示例

状态码：200

OK

{
  "result" : true,
  "status" : "success"
}

状态码

状态码

描述

200

OK

403

Forbidden

404

Not Found

406

Not Acceptable

500

Internal Server Error

错误码

请参见错误码。

父主题： IDE实例管理

相关文档