Prolonging a Notebook Instance

This API is used to prolong a notebook instance.

None

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
id	Yes	String	Notebook instance ID.
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.
update_at	Long	Time (UTC) when the instance is last updated (excluding the keepalive heartbeat time), accurate to millisecond.

Prolong the available 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
}

Parent topic: DevEnviron Management

Thank you very much for your feedback. We will continue working to improve the documentation.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel