Queries the information about the local image 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 DescribeImage

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

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

The ID of the cluster.

Repository String Yes repo1

The name of the repository.

ImageTag String No latest

The tag of the image. Default value: latest.

ContainerType String No singularity

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

Response parameters

Parameter Type Example Description
ImageInfo Struct

The information of the image.

ImageId String 353506****

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.

Tag String latest

The tag of the image.

Type String docker

The type of the image. Valid values:

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

The time when the image was last updated.

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

The ID of the request.

Examples

Sample requests

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

Sample success responses

XML format

<DescribeImageResponse>
      <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>
      <ImageInfo>
            <System>mycluster</System>
            <Type>docker</Type>
            <Status>READY</Status>
            <ImageId>353506****</ImageId>
            <UpdateDateTime>2018-08-02T20:11:36</UpdateDateTime>
            <Repository>hello-world</Repository>
            <Tag>latest</Tag>
      </ImageInfo>
</DescribeImageResponse>

JSON format

{
    "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368",
    "ImageInfo": {
        "System": "mycluster",
        "Type": "docker",
        "Status": "READY",
        "ImageId": "353506****",
        "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.