GetImage - Elastic High Performance Computing - Alibaba Cloud Documentation Center

Get image details.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ehpc:GetImage

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ImageCategory	string	No	Image source. Valid values: Public: public images provided by Alibaba Cloud. Custom: custom images that you added.	Custom
ImageType	string	No	Image type. Valid values: VM: virtual machine image. Container: container image. Default value: VM	VM
ImageId	string	No	Image ID.	m-2ze74g5mvy4pjg*****
AdditionalRegionIds	array	No
	string	No

Response elements

Element	Type	Description	Example
	object	Response schema
RequestId	string	Request ID.	04F0F334-1335-436C-A1D7-6C044FE73368
Success	boolean	Indicates whether the operation succeeded. Valid values: true: succeeded. false: failed.	true
TotalCount	integer	Total number of items returned for this request.	10
Image	object	Image details.
ImageType	string	Image type.	VM
AppId	string
Name	string	Image name.	app-image
Version	string	Version.	v1.0
Description	string	Image description.	应用测试镜像。
Size	string	Image size, in GiB.	40 GiB
CreateTime	string	Image creation time.	2022-12-23T09:51:39Z
Status	string
ContainerImageSpec	object	Container image configuration details.
RegistryUrl	string	Container image registry URL.	registry-vpc.cn-hangzhou.aliyuncs.com/ehpc_open/nginx:latest
IsACRRegistry	boolean	Indicates whether the image is stored in an Alibaba Cloud Container Registry (ACR) instance. Valid values: True: yes. False: no.	True
IsACREnterprise	boolean	Indicates whether the image is stored in an ACR Enterprise Edition instance. Valid values: True: yes. False: no.	True
RegistryCriId	string	ACR Enterprise Edition instance ID.	cri-xyz795ygf8k9****
RegistryCredential	object	Authentication for a private image registry.
Server	string	Registry server address.	registry-vpc.cn-hangzhou.aliyuncs.com
UserName	string	Username to log on to the registry.	username
Password	string	Password for the username.	userpassword
OsTag	string
Platform	string
Architecture	string
VMImageSpec	object	Virtual machine image configuration details.
ImageId	string	Image ID.	m-uf60twafjtaart******
OsTag	string	OS version identifier.	CentOS 7.6 64 bit
Platform	string	Platform type.	CentOS
Architecture	string	Architecture type.	x86_64
DocumentInfo	object
DocumentId	string
EncodingMode	string
Document	string
AdditionalRegionsInfo	array<object>
	object
Status	string
ImageId	string
RegionId	string

Examples

Success response

JSON format

{
  "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 code	Error code	Error message	Description
400	InvalidParams	The specified parameter %s is invalid.	The specified parameter %s is invalid.
400	NotEnabled	You have not enabled this service.	You have not enabled this service
404	ImageNotFound	The specified image does not exist.	The specified image does not exist. Please verify the parameter.
503	ServiceUnavailable	The request has failed due to a temporary failure of the server.	The request has failed due to a temporary failure of the server.
406	EcsError	An error occurred while calling the ECS API operation.	An error occurred while calling the ECS API operation.
406	AliyunError	An Alibaba Cloud product error occurred.	Alibaba Cloud product error. %s
406	DbError	A database error occurred.	A database error occurred.
407	NotAuthorized	No authorization is granted.	No authorization is granted.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.