更新时间:2024-05-30 GMT+08:00

Notebook时长续约

功能介绍

该接口用于延长运行中的开发环境时长。

接口约束

暂无约束

调试

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

URI

PATCH /v1/{project_id}/notebooks/{id}/lease

表1 路径参数

参数

是否必选

参数类型

描述

id

String

Notebook实例ID。

project_id

String

用户项目ID,获取方法请参见获取项目ID和名称

表2 Query参数

参数

是否必选

参数类型

描述

duration

Long

续订时长,推荐该参数在leaseReq中配置,若请求参数中包含duration,则忽略leaseReq的值,且实例自动停止类别为定时停止。(单位:毫秒)。

请求参数

表3 请求Body参数

参数

是否必选

参数类型

描述

duration

Long

定时停止,以当前时刻为起点,运行的时长(到期后自动停止)。单位:毫秒。

type

String

自动停止类别,默认为timing。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

create_at

Long

实例创建的时间,UTC毫秒。

duration

Long

实例运行时长,以创建时间为起点计算,即“创建时间+duration > 当前时刻”时,系统会自动停止实例。

enable

Boolean

是否启用自动停止功能。

type

String

自动停止类别。

update_at

Long

实例最后更新(不包括保活心跳)的时间,UTC毫秒。

请求示例

延长运行中的开发环境时长。

https://{endpoint}/v1/{project_id}/notebooks/{id}/lease

{
  "duration" : 3600000,
  "type" : "timing"
}

响应示例

状态码: 200

OK

{
  "create_at" : 1638841744515,
  "duration" : 3600000,
  "enable" : true,
  "type" : "TIMING",
  "update_at" : 1638843018759
}

状态码

状态码

描述

200

OK

204

No Content

401

Unauthorized

403

Forbidden

错误码

请参见错误码