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

刷新IDE实例活跃状态 - UpdateInstanceActivity

功能介绍

刷新IDE实例活跃状态，超过该实例设置的过期时间后实例自动关闭。

调试

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

授权信息

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

授权项

访问级别

资源类型（*为必须）

条件键

别名

依赖的授权项

CodeArtsIDEOnline:instance:access

Permission_management

-

-

-

-

URI

PUT /v2/instances/{instance_id}/activity

表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。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

X-Sdk-Date

否

String

参数解释：

请求发起时间。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

host

否

String

参数解释：

请求host地址。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

x-security-token

否

String

参数解释：

IAM 5.0鉴权token。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

Authorization

否

String

参数解释：

AK/SK签名。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

result

ExpireVo object

返回值

status

String

参数解释：

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

取值范围：

  • success：请求响应成功。

  • error：请求响应失败。

表4 ExpireVo

参数

参数类型

描述

expiration

Long

参数解释：

过期时间。UNIX时间戳，单位毫秒。

取值范围：

不涉及

instance_id

String

参数解释：

CodeArts IDE Online的实例id。

取值范围：

长度为3~128，满足正则表达式^[a-zA-Z0-9][-_.a-zA-Z0-9]{1,126}[a-zA-Z0-9]$。

interval

Long

CodeArtsIDEOnline实例自动休眠时长，单位‘分钟’

状态码：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实例活跃状态

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

响应示例

状态码：200

OK

{
  "result" : {
    "instance_id" : "zhkfjt",
    "expiration" : 1635837203706,
    "interval" : 30
  },
  "status" : "success"
}

状态码：403

Forbidden

{
  "error_code" : "IDE.00010129",
  "error_msg" : "Instance does not belong to the user or tenant"
}

状态码：404

Not Found

{
  "error_code" : "IDE.00010030",
  "error_msg" : "instance not exist"
}

状态码：406

Not Acceptable

{
  "error_code" : "IDE.00010048",
  "error_msg" : "active error:instance status error"
}

状态码

状态码

描述

200

OK

403

Forbidden

404

Not Found

406

Not Acceptable

错误码

请参见错误码。

父主题：IDE实例管理

相关文档