Query community images by using the ListCommunityImages API - Elastic High Performance Computing - Alibaba Cloud - Elastic High Performance Computing

Queries a list of community images.

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:ListCommunityImages

*All Resource

*

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 Elastic Compute Service (ECS) instance type. If not specified, community images supported by all instance types are returned.	ecs.n1.tiny
ClusterId	string	No	The cluster ID. If the cluster supports multiple operating systems, all community images in its region are returned. If not specified, community images supported by all clusters are returned.	ehpc-hz-FYUr32****

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	04F0F334-1335-436C-A1D7-6C044FE73368
Images	object
ImageInfo	array<object>	The list of custom and shared images supported by E-HPC.
	array<object>
Status	string	The state of the image. Valid values: UnAvailable Available Creating CreateFailed	Available
PostInstallScript	string	The post-installation script for the image.	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	The OS images supported by E-HPC.
Platform	string	The operating system.	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

Success response

JSON format

{
  "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
500	UnknownError	An unknown error occurred.	An unknown error occurred.
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.	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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.