Saving a Running Instance as a Container Image¶
Function¶
A running instance can be saved as a container image. In the saved image, the installed dependency package (pip package) is not lost. In the VS Code remote development scenario, the plug-ins installed on the server are not lost.
Constraints¶
None
URI¶
POST /v1/{project_id}/notebooks/{id}/create-image
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. |
Request Parameters¶
Parameter | Mandatory | Type | Description |
---|---|---|---|
description | No | String | Image description with a maximum of 512 characters |
name | No | String | Image name, which contains a maximum of 512 characters, including lowercase letters, digits, hyphens (-), underscores (_), and periods (.) |
namespace | No | String | Organization to which the image belongs. You can create and view the organization on the Organization Management page of the SWR console. |
tag | No | String | Image tag, which can contain a maximum of 64 characters, including letters, digits, hyphens (-), underscores (_), and periods (.) |
workspace_id | No | String | Workspace ID If no workspace is created, the default value is 0. If a workspace is created and used, the actual value prevails. |
Response Parameters¶
Status code: 200
Parameter | Type | Description |
---|---|---|
arch | String | Processor architecture supported by the image. Enums:
|
create_at | Long | Specifies the time (UTC ms) when the image is created. |
description | String | Image description with a maximum of 512 characters |
dev_services | Array of strings | Services supported by the image. Enums:
|
id | String | Specifies the image ID of the notebook instance to be created. The image ID is in the Universally Unique Identifier (UUID) format. For details about how to obtain the ID of a preset image, see ListImage.xml. |
name | String | Image name, which contains a maximum of 512 characters, including lowercase letters, digits, hyphens (-), underscores (_), and periods (.) |
namespace | String | Organization to which the image belongs. You can create and view the organization on the Organization Management page of the SWR console. |
origin | String | Image source, which defaults to CUSTOMIZE. This parameter is optional. Enums:
|
resource_categories | Array of strings | Flavors supported by the image. Enums:
|
service_type | String | Supported image types. Options:
|
size | Long | Specifies the image size, in KB. |
status | String | Image status. Options:
|
status_message | String | Build information during image saving |
support_res_categories | Array of strings | Flavors supported by the image. Enums:
|
swr_path | String | SWR image address |
tag | String | Image tag |
type | String | Image type. Enums:
|
update_at | Long | Specifies the time (UTC ms) when the image was last updated. |
visibility | String | Image visibility. Enums:
|
workspace_id | String | Workspace ID. If no workspaces are available, the default value is 0. |
Example Requests¶
The following is an example of how to save a running instance as a container image whose image name is pytorch1_4 and organization is atelier-auto.
{
"name" : "pytorch1_4",
"namespace" : "atelier-auto",
"tag" : "20221223",
"description" : "save from notebook-x21d",
"workspace_id" : "0"
}
Example Responses¶
Status code: 200
OK
{
"arch" : "x86_64",
"create_at" : 1671786468811,
"description" : "notebook2.0 20200816",
"dev_services" : [ "SSH", "NOTEBOOK" ],
"id" : "4e0d1854-63e5-4517-b683-a0ee97a692a1",
"name" : "pytorch1_4",
"namespace" : "atelier-auto",
"origin" : "IMAGE_SAVE",
"resource_categories" : [ "CPU", "GPU" ],
"service_type" : "TRAIN",
"status" : "INIT",
"swr_path" : "swr.xxxxx.com/atelier-auto/pytorch1_4:20221223",
"tag" : "20221223",
"type" : "DEDICATED",
"update_at" : 1671786468811,
"visibility" : "PRIVATE",
"workspace_id" : "0"
}
Status Codes¶
Status Code | Description |
---|---|
200 | OK |
201 | Created |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
Error Codes¶
See Error Codes.