All Products
Search
Document Center

Elastic High Performance Computing:ListContainerImages

Last Updated:Apr 09, 2024

Queries the list of local images 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:ListContainerImagesREAD
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ClusterIdstringYes

The ID of the E-HPC cluster.

You can call the ListClusters operation to query the cluster ID.

ehpc-hz-FYUr32****
ContainerTypestringNo

The type of the container. Set the value to singularity.

singularity
PageNumberintegerNo

The page number to return.

Pages start from page 1.

Default value: 1.

1
PageSizeintegerNo

The number of entries to return on each page. Valid values: 1 to 50.

Default value: 10.

10

Response parameters

ParameterTypeDescriptionExample
object
PageSizeinteger

The number of entries returned per page.

1
PageNumberinteger

The page number of the returned page.

1
RequestIdstring

The request ID.

04F0F334-1335-436C-A1D7-6C044FE7****
TotalCountinteger

The total number of returned entries.

1
DBInfostring

The information of the database.

mongodb://localhost/
Imagesobject []

The array of images.

Typestring

The type of the container. Set the value to singularity.

docker
Statusstring

The state of the image.

READY
UpdateDateTimestring

The time when the image was updated.

2018-08-02T20:11:36
Repositorystring

The name of the certificate application repository.

busybox
Tagstring

The tags of the image.

latest
Systemstring

The container system of the image.

mycluster
ImageIdstring

The image ID.

centos_7_06_64_20G_alibase_2019071****

Examples

Sample success responses

JSONformat

{
  "PageSize": 1,
  "PageNumber": 1,
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE7****",
  "TotalCount": 1,
  "DBInfo": "mongodb://localhost/",
  "Images": {
    "Images": [
      {
        "Type": "docker",
        "Status": "READY",
        "UpdateDateTime": "2018-08-02T20:11:36",
        "Repository": "busybox",
        "Tag": "latest",
        "System": "mycluster",
        "ImageId": "centos_7_06_64_20G_alibase_2019071****"
      }
    ]
  }
}

Error codes

HTTP status codeError codeError messageDescription
400InvalidParamsThe specified parameter %s is invalid.The specified parameter %s is invalid.
400InvalidContainerTypeUnsupported container type: %s.Unsupported container type: %s.
404LoginNotFoundThe specified login node does not exist.The specified login node does not exist.
406AliyunErrorAn Alibaba Cloud product error occurred.An Alibaba Cloud product error occurred.
406DbErrorA database service error occurred.Database request failed.
406ExecFailFailed to execute the command: %s.Failed to execute the command: %s.
406AgentErrorThe agent service 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.