刷新IDE实例活跃状态
功能介绍
刷新IDE实例活跃状态,超过该实例设置的过期时间后实例自动关闭。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
PUT /v2/instances/{instance_id}/activity
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
instance_id |
是 |
String |
参数解释: CodeArtsIDEOnline实例id。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
X-Sdk-Date |
否 |
String |
参数解释: 请求发起时间。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
host |
否 |
String |
参数解释: 请求host地址。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
x-security-token |
否 |
String |
参数解释: IAM5.0鉴权token。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
Authorization |
否 |
String |
参数解释: AK/SK签名。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
result |
ExpireVo object |
返回值 |
status |
String |
参数解释: 请求响应的状态,表明请求是否成功。 取值范围:
|
参数 |
参数类型 |
描述 |
---|---|---|
expiration |
Long |
过期时间。UNIX时间戳,单位毫秒。eg:1635905480465 |
instance_id |
String |
CodeArtsIDEOnline实例id |
interval |
Long |
CodeArtsIDEOnline实例自动休眠时长,单位‘分钟’ |
状态码:403
参数 |
参数类型 |
描述 |
---|---|---|
error_msg |
String |
参数解释: 错误描述信息。详情请参见错误码。 取值范围: 不涉及。 |
error_code |
String |
参数解释: 错误码。详情请参见错误码。 取值范围: 不涉及。 |
状态码:404
参数 |
参数类型 |
描述 |
---|---|---|
error_msg |
String |
参数解释: 错误描述信息。详情请参见错误码。 取值范围: 不涉及。 |
error_code |
String |
参数解释: 错误码。详情请参见错误码。 取值范围: 不涉及。 |
状态码:406
请求示例
刷新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 |
错误码
请参见错误码。