查询运行中的Notebook可用时长
功能介绍
查询运行中的Notebook可用时长接口用于获取正在运行的Notebook实例的剩余可用时间。该接口适用于以下场景:用户需要了解Notebook实例的剩余运行时间以合理安排任务时,可通过此接口查询指定实例的可用时长。使用该接口的前提条件是用户已登录系统并具有访问目标Notebook实例的权限,同时Notebook实例必须处于运行状态。调用该接口后,系统将返回指定Notebook实例的可用时长信息。若用户无权限访问指定实例或Notebook实例未运行,接口将返回相应的错误信息。异常情况包括:若指定的Notebook实例不存在,或查询操作失败,接口将返回相应的错误提示。
接口约束
暂无约束。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
GET /v1/{project_id}/notebooks/{id}/lease
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
id |
是 |
String |
参数解释:Notebook实例ID。ID格式为通用唯一识别码(Universally Unique Identifier,简称UUID),可通过调用查询Notebook实例列表接口获取。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 |
project_id |
是 |
String |
参数解释:用户项目ID,获取方法请参见获取项目ID和名称。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 |
请求参数
无
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
create_at |
Long |
参数解释:实例创建的时间,UTC毫秒。 取值范围:不涉及。 |
duration |
Long |
参数解释:实例运行时长,以创建时间为起点计算,即“创建时间+duration > 当前时刻”时,系统会自动停止实例。 取值范围:不涉及。 |
enable |
Boolean |
参数解释:是否启用自动停止功能。 取值范围:布尔类型:
|
type |
String |
参数解释:自动停止类别。 取值范围:枚举类型,取值如下:
|
update_at |
Long |
参数解释:实例最后更新(不包括探活心跳)的时间,UTC毫秒。 取值范围:不涉及。 |
请求示例
GET https://{endpoint}/v1/{project_id}/notebooks/{id}/lease
响应示例
状态码:200
OK。
{ "create_at" : 1638841744515, "duration" : 3600000, "enable" : true, "type" : "TIMING", "update_at" : 1638842905925 }
状态码
状态码 |
描述 |
---|---|
200 |
OK。 |
401 |
Unauthorized。 |
403 |
Forbidden。 |
404 |
Not Found。 |
错误码
请参见错误码。