Compute
Elastic Cloud Server
Huawei Cloud Flexus
Bare Metal Server
Auto Scaling
Image Management Service
Dedicated Host
FunctionGraph
Cloud Phone Host
Huawei Cloud EulerOS
Networking
Virtual Private Cloud
Elastic IP
Elastic Load Balance
NAT Gateway
Direct Connect
Virtual Private Network
VPC Endpoint
Cloud Connect
Enterprise Router
Enterprise Switch
Global Accelerator
Management & Governance
Cloud Eye
Identity and Access Management
Cloud Trace Service
Resource Formation Service
Tag Management Service
Log Tank Service
Config
OneAccess
Resource Access Manager
Simple Message Notification
Application Performance Management
Application Operations Management
Organizations
Optimization Advisor
IAM Identity Center
Cloud Operations Center
Resource Governance Center
Migration
Server Migration Service
Object Storage Migration Service
Cloud Data Migration
Migration Center
Cloud Ecosystem
KooGallery
Partner Center
User Support
My Account
Billing Center
Cost Center
Resource Center
Enterprise Management
Service Tickets
HUAWEI CLOUD (International) FAQs
ICP Filing
Support Plans
My Credentials
Customer Operation Capabilities
Partner Support Plans
Professional Services
Analytics
MapReduce Service
Data Lake Insight
CloudTable Service
Cloud Search Service
Data Lake Visualization
Data Ingestion Service
GaussDB(DWS)
DataArts Studio
Data Lake Factory
DataArts Lake Formation
IoT
IoT Device Access
Others
Product Pricing Details
System Permissions
Console Quick Start
Common FAQs
Instructions for Associating with a HUAWEI CLOUD Partner
Message Center
Security & Compliance
Security Technologies and Applications
Web Application Firewall
Host Security Service
Cloud Firewall
SecMaster
Anti-DDoS Service
Data Encryption Workshop
Database Security Service
Cloud Bastion Host
Data Security Center
Cloud Certificate Manager
Edge Security
Situation Awareness
Managed Threat Detection
Blockchain
Blockchain Service
Web3 Node Engine Service
Media Services
Media Processing Center
Video On Demand
Live
SparkRTC
MetaStudio
Storage
Object Storage Service
Elastic Volume Service
Cloud Backup and Recovery
Storage Disaster Recovery Service
Scalable File Service Turbo
Scalable File Service
Volume Backup Service
Cloud Server Backup Service
Data Express Service
Dedicated Distributed Storage Service
Containers
Cloud Container Engine
SoftWare Repository for Container
Application Service Mesh
Ubiquitous Cloud Native Service
Cloud Container Instance
Databases
Relational Database Service
Document Database Service
Data Admin Service
Data Replication Service
GeminiDB
GaussDB
Distributed Database Middleware
Database and Application Migration UGO
TaurusDB
Middleware
Distributed Cache Service
API Gateway
Distributed Message Service for Kafka
Distributed Message Service for RabbitMQ
Distributed Message Service for RocketMQ
Cloud Service Engine
Multi-Site High Availability Service
EventGrid
Dedicated Cloud
Dedicated Computing Cluster
Business Applications
Workspace
ROMA Connect
Message & SMS
Domain Name Service
Edge Data Center Management
Meeting
AI
Face Recognition Service
Graph Engine Service
Content Moderation
Image Recognition
Optical Character Recognition
ModelArts
ImageSearch
Conversational Bot Service
Speech Interaction Service
Huawei HiLens
Video Intelligent Analysis Service
Developer Tools
SDK Developer Guide
API Request Signing Guide
Terraform
Koo Command Line Interface
Content Delivery & Edge Computing
Content Delivery Network
Intelligent EdgeFabric
CloudPond
Intelligent EdgeCloud
Solutions
SAP Cloud
High Performance Computing
Developer Services
ServiceStage
CodeArts
CodeArts PerfTest
CodeArts Req
CodeArts Pipeline
CodeArts Build
CodeArts Deploy
CodeArts Artifact
CodeArts TestPlan
CodeArts Check
CodeArts Repo
Cloud Application Engine
MacroVerse aPaaS
KooMessage
KooPhone
KooDrive

Querying Supported Images

Updated on 2024-05-30 GMT+08:00

Function

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

Constraints

None

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

Project ID. For details, see Obtaining a Project ID and Name.

Table 2 Query Parameters

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:

  • 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

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 (,).

type

No

String

Image type. Options:

  • BUILD_IN: built-in system image

  • DEDICATED: private image

workspace_id

No

String

Workspace ID. If no workspaces are available, the default value is 0.

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

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

Table 4 ImageResponse

Parameter

Type

Description

arch

String

Processor architecture supported by the image. Enums:

  • X86_64: x86 architecture

  • AARCH64: Arm architecture

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:

  • 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

ID of the image used for creating development environment instances. The ID is in Universally Unique Identifier (UUID) format. For details, see Querying Supported Images.

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:

  • CUSTOMIZE: custom image

  • IMAGE_SAVE: image saved using a development environment instance

resource_categories

Array of strings

Flavors supported by the image. Enums:

  • CPU

  • GPU

  • ASCEND

service_type

String

Supported image types. Options:

  • 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

Specifies the image size, in KB.

status

String

Image status. Options:

  • 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

Build information during image saving

swr_path

String

SWR image address

tag

String

Image tag

type

String

Image type. Options:

  • BUILD_IN: built-in system image

  • DEDICATED: image you have saved

update_at

Long

Time (UTC) when the image was last updated, accurate to millisecond

visibility

String

Image visibility. Options:

  • PRIVATE: private image

  • PUBLIC: All users can perform read-only operations based on the image ID.

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.

We use cookies to improve our site and your experience. By continuing to browse our site you accept our cookie policy. Find out more

Feedback

Feedback

Feedback

0/500

Selected Content

Submit selected content with the feedback