All Products
Search
Document Center

Elastic High Performance Computing:ListImages

Last Updated:Apr 09, 2024

Queries the list of images that can be installed in a cluster.

Debugging

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

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.
OperationAccess levelResource typeCondition keyAssociated operation
ehpc:ListImagesREAD
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
BaseOsTagstringNo

The image tag of the operating system. The tag is used only for management nodes.

CentOS_7.2_64
InstanceTypestringNo

The instance type.

  • If a value is passed to the parameter, the list of images that are supported by the specified instance type is queried.
  • If no value is passed to the parameter, the list of images that are supported by all instance types is queried.
ecs.n1.medium

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

04F0F334-1335-436C-A1D7-6C044FE7****
OsTagsobject []

The list of images that are supported by E-HPC.

Versionstring

The version of the operating system.

7.2
BaseOsTagstring

The image tag of the operating system. The tag is used only for management nodes.

CentOS_7.2_64
Platformstring

The operating system. Valid values:

  • CentOS
  • windows
CentOS
OsTagstring

The tag that is added to the image.

CentOS_7.2_64
ImageIdstring

The ID of the image.

m-bp1h8aoe73p71iow****
Architecturestring

The architecture of the operating system. Valid values:

  • i386
  • x86_64
i386
OSNamestring

The name of the image.

CentOS_7.2_64
OSNameEnstring

The name of the image in English.

CentOS_7.2_64

Examples

Sample success responses

JSONformat

{
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE7****",
  "OsTags": {
    "OsInfo": [
      {
        "Version": "7.2",
        "BaseOsTag": "CentOS_7.2_64",
        "Platform": "CentOS",
        "OsTag": "CentOS_7.2_64",
        "ImageId": "m-bp1h8aoe73p71iow****",
        "Architecture": "i386",
        "OSName": "CentOS_7.2_64",
        "OSNameEn": "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
2023-03-06The Error code has changed. The response structure of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 404
    delete Error Codes: 406
    delete Error Codes: 407
    delete Error Codes: 500
    delete Error Codes: 503
Output ParametersThe response structure of the API has changed.