Querying Supported Images¶
Function¶
This API is used to query all images by page based on specified conditions.
Constraints¶
None
URI¶
GET /v1/{project_id}/images
Parameter | Mandatory | Type | Description |
---|---|---|---|
project_id | Yes | String | Project ID. For details, see Obtaining a Project ID and Name. |
Parameter | Mandatory | Type | Description |
---|---|---|---|
limit | No | Integer | Number of records on each page. The default value is 200. |
name | No | String | Image name, which contains a maximum of 512 characters, including lowercase letters, digits, hyphens (-), underscores (_), and periods (.) |
name_fuzzy_match | No | Boolean | Whether the image name is used for fuzzy match. The default value is true. |
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. |
offset | No | Integer | Start offset of the records on each page. The default value is 0. |
service_type | No | String | Supported image types. Options:
|
sort_dir | No | String | Sorting mode. The options are ASC (ascending order) and DESC (descending order). The default value is DESC. |
sort_key | No | String | Sorting fields. Separate multiple fields with commas (,). For example, updateTime indicates sorting by update time. |
type | No | String | Image type. Enums:
|
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. |
Request Parameters¶
None
Response Parameters¶
Status code: 200
Parameter | Type | Description |
---|---|---|
current | Integer | Current page |
data | Array of ImageResponse objects | Data |
pages | Integer | Total pages |
size | Integer | Number of records on each page |
total | Long | Total records |
Parameter | Type | Description |
---|---|---|
arch | String | Processor architecture supported by the image. Enums:
|
create_at | Long | Time (UTC) when the image is created, accurate to millisecond |
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 |
swr_path | String | SWR image address |
tag | String | Image tag |
type | String | Image type. Enums:
|
update_at | Long | Time (UTC) when the image was last updated, accurate to millisecond |
visibility | String | Image visibility. Options:
|
workspace_id | String | Workspace ID. If no workspaces are available, the default value is 0. |
Example Requests¶
GET https://{endpoint}/v1/{project_id}/images
Example Responses¶
Status code: 200
OK
{
"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
}
Status Codes¶
Status Code | Description |
---|---|
200 | OK |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
Error Codes¶
See Error Codes.