Querying Supported Images

Function

This API is used to query all images by page based on specified conditions.

This API applies to the following scenarios: When you need to search for a specific image, manage the image repository, or select an appropriate image version for deployment, you can use this API to obtain the image list that meets the conditions. Before using this API, ensure that there is an image repository and you have the access permission. After a query operation is complete, you can obtain an image list that meets the search criteria. Details about the images can be obtained, including the image ID, name, version, type, status, size, and creation time. If there is no image repository, you have no access permission, or the search criteria are incorrect, 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

GET /v1/{project_id}/images

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
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

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
limit	No	Integer	Description: Number of image instances displayed on each page Constraints: N/A Range: Positive integers Default Value: 200
name	No	String	Description: Image name Constraints: N/A Range: The name can contain a maximum of 512 characters. Lowercase letters, digits, hyphens (-), underscores (_), and periods (.) are allowed. Default Value: N/A
name_fuzzy_match	No	Boolean	Definition: Whether the image name is used for fuzzy match Constraints: N/A Range: The value is of the Boolean type. true: Fuzzy match is supported. false: Fuzzy match is not supported. Default Value: true
namespace	No	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
offset	No	Integer	Definition: Start offset of the records on each page Constraints: N/A Range: Non-negative integers Default Value: 0
service_type	No	String	Definition: Supported image types Constraints: N/A Range: Enums: 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 Default Value: UNKNOWN
sort_dir	No	String	Definition: Instance sorting mode Constraints: N/A Range: Enums: ASC: ascending order DESC: descending order Default Value: DESC
sort_key	No	String	Definition: Sorting field. Separate multiple fields with commas (,). Constraints: N/A Range: The value can contain a maximum of 128 characters. Letters, digits, hyphens (-), underscores (_), and commas (,) are allowed. Default Value: N/A
type	No	String	Definition: Image type Constraints: N/A Range: Enums: BUILD_IN: built-in system image DEDICATED: image you have saved Default Value: BUILD_IN
workspace_id	No	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. Constraints: N/A Range: This value contains 0 or 32 characters. Only digits (0 to 9) or lowercase letters (a to z) are allowed. Default Value: 0

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
current	Integer	Definition: Current page number. Range: Positive integers
data	Array of ImageResponse objects	Definition: Image data that meets the search criteria.
pages	Integer	Definition: Total number of pages. Range: Positive integers
size	Integer	Definition: Number of records on each page Range: Positive integers
total	Long	Definition: Total number of records. Range: Non-negative integers

**Table 4** ImageResponse
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 with a maximum of 512 characters. Range: N/A
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
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: 401

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Definition: ModelArts error code. Range: N/A
error_msg	String	Definition: Error message. Range: N/A

Status code: 403

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Definition: ModelArts error code. Range: N/A
error_msg	String	Definition: Error message. Range: N/A

Status code: 404

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Definition: ModelArts error code. Range: N/A
error_msg	String	Definition: Error message. Range: N/A

Example Requests

GET https://{endpoint}/v1/{project_id}/images

Example Responses

Status code: 200

{
  "current" : 4,
  "data" : [ {
    "arch" : "x86_64",
    "create_at" : 1638841805439,
    "description" : "AI inference application development, preconfigured ModelBox and AI engine LibTorch, only SSH connection supported.",
    "dev_services" : [ "AI_FLOW", "SSH" ],
    "id" : "e1a07296-22a8-4f05-8bc8-e936c8e54103",
    "name" : "modelbox1.3.0-libtorch1.9.1-cuda10.2-cudnn8-euler2.9.6",
    "resource_categories" : [ "GPU" ],
    "service_type" : "TRAIN",
    "status" : "ACTIVE",
    "swr_path" : "swr.xxx.com/atelier/modelarts-modelbox-libtorch-gpu-x86:1.3.0-20221027202714-160a680",
    "tag" : "1.3.0-20221027202714-160a680",
    "type" : "BUILD_IN",
    "update_at" : 1638234504492,
    "workspace_id" : "0"
  }, {
    "arch" : "x86_64",
    "create_at" : 1638841805439,
    "description" : "CPU and GPU general algorithm development and training, preconfigured with AI engine PyTorch1.8",
    "dev_services" : [ "NOTEBOOK", "SSH" ],
    "id" : "278e88d1-5b71-4766-8502-b3ba72e824d9",
    "name" : "pytorch1.8-cuda10.2-cudnn7-ubuntu18.04",
    "resource_categories" : [ "GPU", "CPU" ],
    "service_type" : "COMMON",
    "status" : "ACTIVE",
    "swr_path" : "swr.xxx.com/atelier/pytorch_1_8:pytorch_1.8.0-cuda_10.2-py_3.7-ubuntu_18.04-x86_64-20220926104358-041ba2e",
    "tag" : "pytorch_1.8.0-cuda_10.2-py_3.7-ubuntu_18.04-x86_64-20220926104358-041ba2e",
    "type" : "BUILD_IN",
    "update_at" : 1638234504492,
    "workspace_id" : "0"
  } ],
  "pages" : 54,
  "size" : 2,
  "total" : 107
}