Saving a Running Instance as a Container Image

Function

This API is used to save a running instance as a container image.

This API applies to the following scenario: When you need to save the current running environment for future use or development, you can use this API to save an instance as an image. Before using this API, ensure that you have logged in to the system and have the permission to access the target instance. In addition, the instance must be running. After this API is called, the system saves the running instance as a container image, including the installed dependency packages and plug-ins. If you do not have the permission to access the specified instance or the instance is not running, the API will return an error message.

Constraints

No constraints

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

URI

POST /v1/{project_id}/notebooks/{id}/create-image

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
id	Yes	String	Definition: Notebook instance ID. The ID is in the format of a Universally Unique Identifier (UUID). For details about how to obtain the ID, see Querying Notebook Instances. Constraints: N/A Range: N/A Default Value: N/A
project_id	Yes	String	Definition: Project ID. For details, see Obtaining a Project ID and Name. Constraints: N/A Range: N/A Default Value: N/A

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
description	No	String	Definition: Image description. Constraints: N/A Range: Up to 512 characters Default Value: N/A
name	Yes	String	Definition: Image name. Constraints: N/A Range: The value can contain up to 128 characters. Only lowercase letters, digits, hyphens (-), underscores (_), and periods (.) are allowed. The string must start and end with a lowercase letter or digit. Default Value: N/A
namespace	Yes	String	Definition: Organization to which the image belongs. You can create and view an organization on the Organization Management page of the SWR console. Constraints: N/A Range: The value can contain a maximum of 64 characters and must start with a lowercase letter. Only letters, digits, hyphens (-), underscores (_), and periods (.) are allowed. Default Value: N/A
tag	No	String	Definition: Image tag. Constraints: N/A Range: The value can contain a maximum of 64 characters. Letters, digits, hyphens (-), underscores (_), and commas (,) are allowed. Default Value: N/A
workspace_id	No	String	Definition: Workspace ID. For details about how to obtain the ID, see Querying the Workspace List.If no workspaces are available, the default value is 0. If a workspace is created and used, use the actual value. Constraints: N/A Range: N/A Default Value: 0

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
arch	String	Definition: Processor architecture supported by the image. Range: X86_64: x86 architecture AARCH64: Arm architecture
create_at	Long	Definition: UTC time when the image is created, accurate to millisecond. Range: N/A
description	String	Definition: Image description. Range: Up to 512 characters
dev_services	Array of strings	Definition: Services supported by the image. Range: NOTEBOOK: You can access a notebook instance using HTTPS. SSH: You can remotely access a notebook instance from a local IDE through SSH.
id	String	Definition: ID of the image used for creating notebook instances. The ID is in Universally Unique Identifier (UUID) format. For details, see Querying Supported Images. Range: N/A
name	String	Definition: Image name. Range: The name can contain a maximum of 512 characters. Lowercase letters, digits, hyphens (-), underscores (_), and periods (.) are allowed.
namespace	String	Definition: Organization to which the image belongs. You can create and view an organization on the Organization Management page of the SWR console. Range: N/A
origin	String	Definition: Image source. Range: CUSTOMIZE: custom image IMAGE_SAVE: image saved by a notebook instance
resource_categories	Array of strings	Definition: Flavors supported by the image. Range: CPU GPU ASCEND
service_type	String	Definition: Supported image types. Range: COMMON: common image INFERENCE: image used for inference TRAIN: image used for training DEV: image used for development and debugging UNKNOWN: image whose supported services are not specified
size	Long	Definition: Image size, in KB. Range: N/A
status	String	Definition: Image status. Range: INIT: The image is being initialized. CREATING: The image is being saved. In this case, the notebook instance is unavailable. CREATE_FAILED: Saving the image failed. ERROR: An error occurs. DELETED: The image has been deleted. ACTIVE: The image has been saved, which you can view on the SWR console and use to create notebook instances.
status_message	String	Definition: Build information during image saving. Range: N/A
support_res_categories	Array of strings	Definition: Flavors supported by the image. Range: CPU GPU ASCEND
swr_path	String	Definition: SWR image path. Range: N/A
tag	String	Definition: Image tag. Range: N/A
type	String	Definition: Image type. Range: BUILD_IN: built-in system image DEDICATED: image you have saved
update_at	Long	Definition: Time (UTC) when the image was last updated, accurate to millisecond. Range: N/A
visibility	String	Definition: Image visibility. Range: PRIVATE: private image PUBLIC: All users can perform read-only operations based on image_id.
workspace_id	String	Definition: Workspace ID. If no workspaces are available, the default value is 0. If a workspace is created and used, use the actual value. Range: N/A
flavor_type	String	Definition: Resource type of the image. Range: ASCEND_SNT9 ASCEND_SNT9B ASCEND_SNT3

Status code: 201

Created

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

{
  "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"
}