Prolonging a Notebook Instance¶

Function¶

This API is used to prolong the running time of a running notebook instance.

None

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

**Table 1** Path Parameters¶
Parameter	Mandatory	Type	Description
id	Yes	String	Notebook instance ID, which can be obtained by calling the API for querying the notebook instance list.
project_id	Yes	String	Project ID. For details, see Obtaining a Project ID and Name.

**Table 2** Query Parameters¶
Parameter	Mandatory	Type	Description
duration	No	Long	Renewal duration. You are advised to set this parameter in leaseReq. If the request parameter contains duration, the value of leaseReq is ignored and the automatic instance stop type is scheduled stop. (Unit: ms)

**Table 3** Request body parameters¶
Parameter	Mandatory	Type	Description
duration	No	Long	Indicates the running duration starting from the current time. After the running duration expires, the system automatically stops. Unit: ms.
type	No	String	Automatic stop type. The default value is timing.

Status code: 200

**Table 4** Response body parameters¶
Parameter	Type	Description
create_at	Long	Time (UTC) when the instance is created, accurate to millisecond.
duration	Long	Instance running duration, which is calculated based on the instance creation time. If the instance creation time plus the duration is greater than the current time, the system automatically stops the instance.
enable	Boolean	Whether to enable auto stop of the instance.
type	String	Indicates the automatic stop type. timing: The task is automatically stopped. idle: The task is stopped when it is idle.
update_at	Long	Time when the instance is last updated (excluding the heartbeat detection time), in UTC milliseconds.

Prolong the duration of a running notebook instance.

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

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

Status code: 200

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

last updated: 2025-08-26 08:17 UTC - commit: 1ba1873d960563c60759f67898a855d9ba3c3502