ListAvailableImages API Overview for E-HPC-E - HPC

Queries images that are available for Elastic High Performance Computing (E-HPC) clusters.

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.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
ehpc:ListAvailableImages	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
ImageOwnerAlias	string	No	The image source. Valid values: system: system image. self: custom image. others: shared image.	self
InstanceType	string	No	The instance type. Note By default, if you do not specify an instance type, the list of images that are supported by all instance types are queried. For more information, see Instance families.	ecs.c7.large
IsPublic	boolean	No	Specifies whether to return published community images. Valid values: true: returns published community images. If you set the value of this parameter to `true`, the `ImageOwnerAlias` parameter must be set to `others`. false: returns non-community images. The value of the `ImageOwnerAlias` parameter prevails. Default value: false.	true
HPCInterConnect	string	No	The network type of the images that you want to query.	vpc
EnableHT	boolean	No	Specifies whether to return images in which hyper-threading is enabled.	true
Scheduler	object	No	The scheduler information about the images that you want to query.
Type	string	No	The scheduler type.	SLURM
Version	string	No	The scheduler version.	22.05.8
DirectoryService	object	No	The information about the domain account service.
Type	string	No	The type of the domain account.	NIS
Version	string	No	The version of the domain account service.	1.0
PageNumber	integer	No	The page number of the page to return.	1
PageSize	integer	No	The number of entries per page. Valid values: 1 to 50. Default value: 10.	1

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	04F0F334-1335-436C-A1D7-6C044FE73368
TotalCount	string	The total number of entries returned.	1
PageSize	string	The number of entries per page.	20
PageNumber	string	The page number of the returned page. Pages start from page 1. Default value: 1.	1
Success	boolean	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true
Images	array<object>	The information about the images.
Image	object	The information about the image.
ImageId	string	The image ID.	centos_7_06_64_20G_alibase_2019071****
OSNameEn	string	The OS name in English.	CentOS 7.9 64 bit
ImageOwnerAlias	string	The image source. Valid values: system: system image. self: custom image. others: shared image.	self
Description	string	The image description.	ExampleDescription
Size	string	The image size. Unit: GiB	40
Platform	string	The OS. Valid values: CentOS windows	windows
OSName	string	The OS name in Chinese.
Architecture	string	The OS architecture of the image. Valid values: x86_64 arm64	x86_64
BootMode	string	The boot mode of the image. Valid values: BIOS: Basic Input/Output System (BIOS). UEFI: Unified Extensible Firmware Interface (UEFI). Note When you change the OS boot mode of an instance, you must make sure that the boot mode matches the boot mode of the associated image. Otherwise, the instance fails to be booted.	BIOS
ImageName	string	The image name.	CHESS5V5.0.27

Examples

Sample success responses

JSONformat

{
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368",
  "TotalCount": 1,
  "PageSize": 20,
  "PageNumber": 1,
  "Success": true,
  "Images": [
    {
      "ImageId": "centos_7_06_64_20G_alibase_2019071****",
      "OSNameEn": "CentOS  7.9 64 bit",
      "ImageOwnerAlias": "self",
      "Description": "ExampleDescription",
      "Size": 40,
      "Platform": "windows",
      "OSName": "",
      "Architecture": "x86_64",
      "BootMode": "BIOS",
      "ImageName": "CHESS5V5.0.27"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParams	The specified parameter %s is invalid.	The specified parameter %s is invalid.
500	UnknownError	An unknown error occurred.	An unknown error occurred.
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.

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

Change history

Change time	Summary of changes	Operation

No change history