Notebook时长续约
功能介绍
Notebook时长续约接口用于延长运行中的Notebook实例的运行时间。该接口适用于以下场景：用户需要延长Notebook实例的使用时间以完成长时间任务时，可通过此接口延长指定实例的运行时间。使用该接口的前提条件是用户已登录系统并具有操作目标Notebook实例的权限，同时Notebook实例必须处于运行状态。调用该接口后，系统将延长指定Notebook实例的运行时间，用户可继续使用。若用户无权限操作指定实例或Notebook实例未运行，接口将返回相应的错误信息。
接口约束
暂无约束。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
PATCH /v1/{project_id}/notebooks/{id}/lease
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
id |
是 |
String |
参数解释：Notebook实例ID。ID格式为通用唯一识别码（Universally Unique Identifier，简称UUID），可通过调用查询Notebook实例列表接口获取。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 |
|
project_id |
是 |
String |
参数解释：用户项目ID，获取方法请参见获取项目ID和名称。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
duration |
否 |
Long |
参数解释：续订时长，推荐该参数在leaseReq中配置，若请求参数中包含duration，则忽略leaseReq的值，且实例自动停止类别为定时停止。(单位:毫秒)。 约束限制：不涉及。 取值范围：3600000-259200000。 默认取值：3600000。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
duration |
否 |
Long |
参数解释：定时停止，以当前时刻为起点，运行的时长（到期后自动停止）。单位：毫秒。 约束限制：不涉及。 取值范围：3600000-259200000。 默认取值：3600000。 |
|
type |
否 |
String |
参数解释：自动停止类别。 约束限制：不涉及。 取值范围：枚举类型，取值如下：
默认取值：TIMING。 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
create_at |
Long |
参数解释：实例创建的时间，UTC毫秒。 取值范围：不涉及。 |
|
duration |
Long |
参数解释：实例运行时长，以创建时间为起点计算，即“创建时间+duration > 当前时刻”时，系统会自动停止实例。 取值范围：不涉及。 |
|
enable |
Boolean |
参数解释：是否启用自动停止功能。 取值范围：布尔类型：
|
|
type |
String |
参数解释：自动停止类别。 取值范围：枚举类型，取值如下：
|
|
update_at |
Long |
参数解释：实例最后更新（不包括探活心跳）的时间，UTC毫秒。 取值范围：不涉及。 |
状态码：204
No Content。
请求示例
延长运行中的Notebook时长。
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。 |
错误码
请参见错误码。
