All Products
Search
Document Center

Elastic High Performance Computing:ListImages

Last Updated:Dec 16, 2025

Queries the image list.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • For mandatory resource types, indicate with a prefix of * .
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
ehpc:ListImagesget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
PageNumberlongNo

The number of the page to return.
Default value: 1.

1
PageSizelongNo

The number of pieces per page.
Default value: 20.

10
ImageCategorystringNo

The source of the image. Valid values:

  • Public: public images provided by Alibaba Cloud.
  • Custom: the custom image that you added.
Custom
ImageTypestringNo

The type of the images. Valid values:

  • VM: virtual machine image.
  • Container: the container image.

Default value: VM

VM
ImageIdsarrayNo

The array of image IDs.

stringNo

The image ID.

m-uf6bzz76jb4ai9******
ImageNamesarrayNo

The array of image names.

stringNo

The name of the image.

appimage
ModestringNo

The query mode. Valid values:

  • List: queries the list of all corresponding image versions.
  • Merge: merges images to query the latest version list.
Merge

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

The request ID.

896D338C-E4F4-41EC-A154-D605E5DE****
Successboolean

Indicates whether the request was successful. Valid values:

  • true
  • false
true
TotalCountinteger

The total number of entries returned.

1
PageSizelong

The number of entries returned per page.

20
PageNumberlong

The page number.

1
Imagesarray<object>

The list of image information.

Imageobject

The information of the image.

ImageTypestring

The type of the image.

VM
ImageIdstring

The image ID.

m-bp181x855551ww5yq****
AppIdstring

The application ID.

ci-vm-kHLPzEWun6zz****
Namestring

The name of the image.

app-image
Versionstring

The version of the image.

v1.0
Descriptionstring

The description of the image.

CreateTimestring

The time when the storage resource was created.

2022-12-09T07:06:34Z
OsTagstring

The ID of the specific OS version.

Ubuntu 22.04 64 bit
UpdateTimestring

The time when the image was updated.

2024-09-25 14:15:28
DocumentIdinteger

The document ID.

30
Weightinteger

The weight.

70

Examples

Sample success responses

JSONformat

{
  "RequestId": "896D338C-E4F4-41EC-A154-D605E5DE****",
  "Success": true,
  "TotalCount": 1,
  "PageSize": 20,
  "PageNumber": 1,
  "Images": [
    {
      "ImageType": "VM",
      "ImageId": "m-bp181x855551ww5yq****",
      "AppId": "ci-vm-kHLPzEWun6zz****",
      "Name": "app-image",
      "Version": "v1.0",
      "Description": "",
      "CreateTime": "2022-12-09T07:06:34Z",
      "OsTag": "Ubuntu  22.04 64 bit",
      "UpdateTime": "2024-09-25 14:15:28",
      "DocumentId": 30,
      "Weight": 70
    }
  ]
}

Error codes

HTTP status codeError codeError messageDescription
400InvalidParamsThe specified parameter %s is invalid.The specified parameter %s is invalid.
400InDebtYour account has overdue payments.Your account has overdue payments.
400NotEnabledYou have not enabled this service.You have not enabled this service
406EcsErrorAn error occurred while calling the ECS API operation.An error occurred while calling the ECS API operation.
406AliyunErrorAn Alibaba Cloud product error occurred.Alibaba Cloud product error. %s
406DbErrorA database error occurred.A database error occurred.
407NotAuthorizedNo authorization is granted.No authorization is granted.
503ServiceUnavailableThe request has failed due to a temporary failure of the server.The request has failed due to a temporary failure of the server.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2024-12-18The Error code has changed. The response structure of the API has changedView Change Details
2024-12-05The Error code has changed. The request parameters of the API has changed. The response structure of the API has changedView Change Details
2024-11-18The Error code has changed. The response structure of the API has changedView Change Details
2024-05-14The Error code has changed. The request parameters of the API has changed. The response structure of the API has changedView Change Details