ListCustomImages - Elastic High Performance Computing - Alibaba Cloud Documentation Center

Queries custom images and shared images supported by Elastic High Performance Computing (E-HPC).

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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:
- The required resource types are displayed in bold characters.
- 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:ListCustomImages	READ	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
ImageOwnerAlias	string	No	The image source. Valid values: self: custom image others: shared image	self
BaseOsTag	string	No	The image tag of the operating system. The tag is used only for management nodes.	CentOS_7.2_64
InstanceType	string	No	The instance type of the Elastic Compute Service (ECS) instance. If you do not specify the instance type, the community images that are supported by all instance types are queried.	ecs.n1.tiny
ClusterId	string	No	The cluster ID. If you specify a value for this parameter, all community images in the region where the cluster resides are queried. If you do not specify a value for this parameter, the community images that are supported by all clusters are queried.	ehpc-hz-FYUr32****

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	04F0F334-1335-436C-A1D7-6C044FE73368
Images	object []	The list of community images, including custom images and shared images.
Status	string	Note This parameter is not publicly available.	Available
PostInstallScript	string	Note This parameter is not publicly available.	example.sh
Description	string	The description of the image.	ExampleDescription
Size	integer	The size of the image. Unit: GiB.	40
ImageOwnerAlias	string	The type of the image. Valid values: self: custom image others: shared image	self
ImageName	string	The name of the image.	CHESS5V5.0.27
SkuCode	string	Note This parameter is not publicly available.	ECS
PricingCycle	string	Note This parameter is not publicly available.	Month
ImageId	string	The image ID.	m-bp181x855551ww5yq****
ProductCode	string	Note This parameter is not publicly available.	cmjj028279
Uid	string	Note This parameter is not publicly available.	127****
BaseOsTag	object	The image tag of the operating system.
Platform	string	The OS. Valid values: CentOS windows	CentOS
OsTag	string	The tags of the image.	CentOS_7.2_64
Version	string	The version of the operating system.	7.2
Architecture	string	The architecture of the operating system. Valid values: i386 x86_64	i386
OsTag	object	An array of system images that are supported by E-HPC.
Platform	string	The OS.	CentOS
OsTag	string	The tag of the image.	CentOS_7.2_64
Version	string	The version of the operating system.	7.2
Architecture	string	The architecture of the operating system. Valid values: i386 x86_64	x86_64
BaseOsTag	string	The image tag of the operating system.	CentOS_7.2_64

Examples

Sample success responses

JSONformat

{
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368",
  "Images": {
    "ImageInfo": [
      {
        "Status": "Available",
        "PostInstallScript": "example.sh",
        "Description": "ExampleDescription",
        "Size": 40,
        "ImageOwnerAlias": "self",
        "ImageName": "CHESS5V5.0.27",
        "SkuCode": "ECS",
        "PricingCycle": "Month",
        "ImageId": "m-bp181x855551ww5yq****",
        "ProductCode": "cmjj028279",
        "Uid": "127****",
        "BaseOsTag": {
          "Platform": "CentOS",
          "OsTag": "CentOS_7.2_64",
          "Version": "7.2",
          "Architecture": "i386"
        },
        "OsTag": {
          "Platform": "CentOS",
          "OsTag": "CentOS_7.2_64",
          "Version": "7.2",
          "Architecture": "x86_64",
          "BaseOsTag": "CentOS_7.2_64"
        }
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
404	ImageNotFound	The specified image does not exist.	The specified image does not exist. Please verify the parameter.
406	EcsError	An error occurred while calling the ECS API operation.	An error occurred while calling the ECS API operation.
406	DbError	A database service error occurred.	Database request failed.
407	NotAuthorized	You are not authorized by RAM for this request.	The request is not authorized by RAM.
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.