All Products
Search
Document Center

Elastic High Performance Computing:GetImage

Last Updated:Dec 16, 2025

Obtains the information about an image.

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:GetImageget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
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
ImageIdstringNo

The image ID.

m-2ze74g5mvy4pjg*****

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

The request ID.

04F0F334-1335-436C-A1D7-6C044FE73368
Successboolean

Indicates whether the request was successful. Valid values:

  • true: The task is successful.
  • false: The error occurred.
true
TotalCountinteger

The total amount of data in this request.

10
Imageobject

The details of the image.

ImageTypestring

The type of the image.

VM
Namestring

The name of the image.

app-image
Versionstring

The version.

v1.0
Descriptionstring

The description of the image.

Sizestring

The size of the image. Unit: GiB.

40 GiB
CreateTimestring

The time when the image was created.

2022-12-23T09:51:39Z
ContainerImageSpecobject

The configuration details of the container image.

RegistryUrlstring

The endpoint of the container image.

registry-vpc.cn-hangzhou.aliyuncs.com/ehpc_open/nginx:latest
IsACRRegistryboolean

Whether it is an Alibaba Cloud image repository.

  • True
  • False
True
IsACREnterpriseboolean

Whether the instance is an Alibaba Cloud image repository Enterprise Edition.

  • True
  • False
True
RegistryCriIdstring

The ID of the Container Registry Enterprise Edition image repository.

cri-xyz795ygf8k9****
RegistryCredentialobject

The authentication of the private image repository.

Serverstring

The registered address of the image repository.

registry-vpc.cn-hangzhou.aliyuncs.com
UserNamestring

The username of the logon user.

username
Passwordstring

The password of the logon user.

userpassword
VMImageSpecobject

The configuration details of the virtual machine image.

ImageIdstring

The image ID.

m-uf60twafjtaart******
OsTagstring

The ID of the specific OS version.

CentOS 7.6 64 bit
Platformstring

The type of the platform.

CentOS
Architecturestring

The type of the architecture.

x86_64

Examples

Sample success responses

JSONformat

{
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368\n",
  "Success": true,
  "TotalCount": 10,
  "Image": {
    "ImageType": "VM",
    "AppId": "",
    "Name": "app-image",
    "Version": "v1.0",
    "Description": "",
    "Size": "40 GiB",
    "CreateTime": "2022-12-23T09:51:39Z",
    "Status": "",
    "ContainerImageSpec": {
      "RegistryUrl": "registry-vpc.cn-hangzhou.aliyuncs.com/ehpc_open/nginx:latest",
      "IsACRRegistry": true,
      "IsACREnterprise": true,
      "RegistryCriId": "cri-xyz795ygf8k9****",
      "RegistryCredential": {
        "Server": "registry-vpc.cn-hangzhou.aliyuncs.com",
        "UserName": "username",
        "Password": "userpassword"
      },
      "OsTag": "",
      "Platform": "",
      "Architecture": ""
    },
    "VMImageSpec": {
      "ImageId": "m-uf60twafjtaart******",
      "OsTag": "CentOS  7.6 64 bit",
      "Platform": "CentOS",
      "Architecture": "x86_64"
    },
    "DocumentInfo": {
      "DocumentId": "",
      "EncodingMode": "",
      "Document": ""
    },
    "AdditionalRegionsInfo": [
      {
        "Status": "",
        "ImageId": "",
        "RegionId": ""
      }
    ]
  }
}

Error codes

HTTP status codeError codeError messageDescription
400InvalidParamsThe specified parameter %s is invalid.The specified parameter %s is invalid.
400NotEnabledYou have not enabled this service.You have not enabled this service
404ImageNotFoundThe specified image does not exist.The specified image does not exist. Please verify the parameter.
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-05The 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