Queries the information about the on-premises 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 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 that you want to manage.

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
RequestId String 04F0F334-1335-436C-A1D7-6C044FE73368

The ID of the request.

ImageInfo Object

The information of the image.

Type String docker

The type of the image. Valid values:

  • shifter
  • docker
Status String READY

The status of the image.

UpdateDateTime String 2018-08-02T20:11:36

The time when the image was last updated.

Repository String hello-world

The name of the repository.

Tag String latest

The tag of the image.

System String mycluster

The container system.

ImageId String 353506****

The ID of the image.

Examples

Sample requests

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

Sample success response

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

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

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

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

Error codes

HttpCode Error code Error message Description
400 InvalidParams The specified parameter %s is invalid. The error message returned because the following parameter is invalid: %s.
400 InvalidContainerType Unsupported container type: %s. The error message returned because the %s type of containerized applications is not supported.
500 UnknownError An unknown error occurred. The error message returned because an unknown error occurred. Try again later. If the error persists, submit a ticket.
404 LoginNotFound The specified login node does not exist. The error message returned because the specified logon node does not exist.
503 ServiceUnavailable The request has failed due to a temporary failure of the server The error message returned because the request failed. The service is temporarily unavailable.
406 AliyunError An Alibaba Cloud product error occurred. The error message returned because the operation failed to call another Alibaba Cloud service.
406 DbError A database service error occurred. The error message returned because the database request failed.
407 NotAuthorized You are not authorized by RAM for this request. The error message returned because you are not authorized by RAM for this request.

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