Queries the on-premises images of a specified cluster.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes ListContainerImages

The operation that you want to perform. Set the value to ListContainerImages.

ClusterId String Yes ehpc-hz-FYUr32****

The ID of the cluster.

ContainerType String No singularity

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

PageNumber Integer No 1

The number of the page to return.

Pages start from page 1.

Default value: 1

PageSize Integer No 10

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

Default value: 10

Response parameters

Parameter Type Example Description
DBInfo String mongodb://localhost/

The information of the database.

Images Array of Images

The array of on-premises images.

Images
ImageId String centos_7_06_64_20G_alibase_2019071****

The ID of the image.

Repository String hello-world

The name of the repository.

Status String READY

The status of the image.

System String mycluster

The container system of the image.

Tag String latest

The tag of the image.

Type String docker

The container type of the image. Valid values:

  • shifter
  • docker
UpdateDateTime String 2018-08-02T20:11:36

The time when the image was updated.

PageNumber Integer 1

The page number of the returned page.

PageSize Integer 1

The number of entries returned per page.

RequestId String 04F0F334-1335-436C-A1D7-6C044FE73368

The ID of the request.

TotalCount Integer 1

The total number of entries.

Examples

Sample requests

https://ehpc.cn-hangzhou.aliyuncs.com/?Action=ListContainerImages
&ClusterId=ehpc-hz-FYUr32****
&<Common request parameters>

Sample success responses

XML format

<ListContainerImagesResponse>
      <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>
      <TotalCount>1</TotalCount>
      <PageNumber>1</PageNumber>
      <PageSize>1</PageSize>
      <DBInfo>mongodb://localhost/</DBInfo>
      <Images>
            <ImageInfo>
                  <System>mycluster</System>
                  <Type>docker</Type>
                  <Status>READY</Status>
                  <ImageId>centos_7_06_64_20G_alibase_2019071****</ImageId>
                  <UpdateDateTime>2018-08-02T20:11:36</UpdateDateTime>
                  <Repository>hello-world</Repository>
                  <Tag>latest</Tag>
            </ImageInfo>
      </Images>
</ListContainerImagesResponse>

JSON format

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

Error codes

HttpCode Error code Error message Description
503 ServiceUnavailable The request has failed due to a temporary failure of the server The error message returned because the request has failed. The server is temporarily unavailable.

For a list of error codes, visit the API Error Center.