All Products
Search
Document Center

Elastic High Performance Computing:ListCommunityImages

Last Updated:Apr 09, 2024

Queries a list of community images.

Debugging

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

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
BaseOsTagstringNo

The tag of the base operating system (BOS).

CentOS_7.2_64
InstanceTypestringNo

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
ClusterIdstringNo

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

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

04F0F334-1335-436C-A1D7-6C044FE73368
Imagesobject []

The list of custom images and shared images that are supported by the E-HPC.

Statusstring

The state of the image. Valid values:

  • UnAvailable
  • Available
  • Creating
  • CreateFailed
Available
PostInstallScriptstring

The script that is run after the image is installed.

example.sh
Descriptionstring

The description of the image.

ExampleDescription
Sizeinteger

The size of the image. Unit: GiB.

40
ImageOwnerAliasstring

The image type. Valid values:

  • self: custom image
  • others: shared image
self
ImageNamestring

The image name.

linux_CentOS7.2_OceanBase_OBD_1ECS-3OB_3.0
SkuCodestring

The stock keeping unit (SKU) of the image. Valid values:

  • ECS: pay-as-you-go
  • package: subscription
ECS
PricingCyclestring

The billing unit of the image. Valid values:

  • Hour
  • Month
  • Year
Month
ImageIdstring

The image ID.

m-bp181x855551ww5yq****
ProductCodestring

The product code in Alibaba Cloud Marketplace.

cmjj028279
Uidstring

The owner of the image.

127****
BaseOsTagobject

The tag of the BOS image.

Platformstring

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
OsTagstring

The operating system tag of the image.

CentOS_7.2_64
Versionstring

The version of the operating system.

7.2
Architecturestring

The architecture of the operating system. Valid values:

  • i386
  • x86_64
x86_64
OsTagobject

An array of OS images that are supported by E-HPC.

Platformstring

The OS.

CentOS
OsTagstring

The operating system tag of the image.

CentOS_7.2_64
Versionstring

The version of the operating system.

7.2
Architecturestring

The architecture of the operating system. Valid values:

  • i386
  • x86_64
x86_64
BaseOsTagstring

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 codeError codeError messageDescription
404ImageNotFoundThe specified image does not exist.The specified image does not exist. Please verify the parameter.
406EcsErrorAn error occurred while calling the ECS API operation.An error occurred while calling the ECS API operation.
406DbErrorA database service error occurred.Database request failed.
407NotAuthorizedYou are not authorized by RAM for this request.The request is not authorized by RAM.
500UnknownErrorAn unknown error occurred.An unknown error occurred.
503ServiceUnavailableThe request has failed due to a temporary failure of the serverThe 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 timeSummary of changesOperation
2022-07-15Add Operationsee changesets