ListCommunityImages - Elastic High Performance Computing

Queries a list of community images.

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:ListCommunityImages		All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
BaseOsTag	string	No	The tag of the base operating system (BOS).	CentOS_7.2_64
InstanceType	string	No	The 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 ID of the cluster. If the cluster supports multiple operating systems, all community images in the region where the cluster resides are queried. If you do not specify the cluster ID, 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	array<object>	The list of custom images and shared images that are supported by the E-HPC.
ImageInfo	object
Status	string	The state of the image. Valid values: UnAvailable Available Creating CreateFailed	Available
PostInstallScript	string	The script that is run after the image is installed.	example.sh
Description	string	The description of the image.	ExampleDescription
Size	integer	The size of the image. Unit: GiB.	40
ImageOwnerAlias	string	The image type. Valid values: self: custom image others: shared image	self
ImageName	string	The image name.	linux_CentOS7.2_OceanBase_OBD_1ECS-3OB_3.0
SkuCode	string	The stock keeping unit (SKU) of the image. Valid values: ECS: pay-as-you-go package: subscription	ECS
PricingCycle	string	The billing unit of the image. Valid values: Hour Month Year	Month
ImageId	string	The image ID.	m-bp181x855551ww5yq****
ProductCode	string	The product code in Alibaba Cloud Marketplace.	cmjj028279
Uid	string	The owner of the image.	127****
BaseOsTag	object	The tag of the BOS image.
Platform	string	The distribution of the operating system. Valid values: CentOS Ubuntu SUSE OpenSUSE Debian CoreOS Aliyun Windows Server 2003 Windows Server 2008 Windows Server 2012 Others Linux Customized Linux	CentOS
OsTag	string	The operating system 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
OsTag	object	An array of OS images that are supported by E-HPC.
Platform	string	The OS.	CentOS
OsTag	string	The operating system 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 tag of the BOS image.	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": "linux_CentOS7.2_OceanBase_OBD_1ECS-3OB_3.0",
        "SkuCode": "ECS",
        "PricingCycle": "Month",
        "ImageId": "m-bp181x855551ww5yq****",
        "ProductCode": "cmjj028279",
        "Uid": "127****",
        "BaseOsTag": {
          "Platform": "CentOS",
          "OsTag": "CentOS_7.2_64",
          "Version": "7.2",
          "Architecture": "x86_64"
        },
        "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.	ECS API call error. %s
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.

Change history

Change time	Summary of changes	Operation
2022-07-15	Add Operation	View Change Details