文档首页/ CodeArts IDE Online/ API参考/ API/ IDE实例管理/ 修改IDE实例
更新时间：2023-06-16 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。

通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。
表3 请求Body参数

参数

是否必选

参数类型

描述

description

否

String

描述

display_name

是

String

实例名。 可以输入中文、数字、字母、下划线、点、破折号。长度介于3-100之间

refresh_interval

是

String

自动休眠时长。arm架构,自动休眠时长只能设置成30，60。x86架构可取值为30，60，240，1440和-1。除-1外，其它值的单位为“分钟”。实例无操作超过自动休眠时长后，将会被暂停（已保存的数据不会被删除）。-1表示实例不会自动停止

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

result

Boolean

返回值

status

String

状态

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

错误码

请求示例

修改名为“testjava”的实例。

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实例管理

相关文档