DescribeImageCaches - API reference| Alibaba Cloud Documentation Center

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	No	DescribeImageCaches	The operation that you want to perform. Set the value to DescribeImageCaches.
RegionId	String	Yes	cn-hangzhou	The region ID of the image cache.
ImageCacheId	String	No	imc-bp195erqe9o2pb09****	The ID of the image cache.
ImageCacheName	String	No	testcache	The name of the image cache.
SnapshotId	String	No	s-2zec5oj8e1yhxijt****	The ID of the snapshot of the image cache.
Image	String	No	registry-vpc.cn-hangzhou.aliyuncs.com/eci_open/nginx:1.15.10-perl	The image contained in the image cache.
Tag.N.Key	String	No	imc	The tag key of the image cache. Valid values of N: 1 to 20.
Tag.N.Value	String	No	test	The tag value of the image cache. Valid values of N: 1 to 20.
ResourceGroupId	String	No	rg-2df3isufhi38****	The ID of the resource group.

Response parameters


Parameter	Type	Example	Description
ImageCaches	Array of ImageCache		Details about the image cache. A maximum of 20 records can be returned for a query.
ContainerGroupId	String	eci-bp18oq3m15prd9jb****	The ID of the container group.
CreationTime	String	2021-02-09T02:24:07Z	The time when the image cache was created.
Events	Array of Event		Details about the events of pulling the image when the image cache was being created.
Count	Integer	1	The number of the events.
FirstTimestamp	String	2021-02-09T02:24:48Z	The time when the event started.
LastTimestamp	String	2021-02-09T02:24:48Z	The time when the event ended.
Message	String	Successfully check image cache resource.	The message of the event.
Name	String	imagetest.1661f31f851a****	The name of the event.
Type	String	Normal	The type of the event.
ExpireDateTime	String	2019-11-10T09:00:48Z	The time when the image cache expires.
ImageCacheId	String	imc-bp195erqe9o2pb09****	The ID of the image cache.
ImageCacheName	String	imagetest	The name of the image cache.
ImageCacheSize	Integer	20	The size of the image cache. Unit: GiB.
Images	List	registry-vpc.cn-hangzhou.aliyuncs.com/eci_open/nginx:1.15.10-perl	The images contained in the image cache.
Progress	String	100%	The progress of creating the image cache.
RegionId	String	cn-beijing	The region ID of the image cache.
ResourceGroupId	String	rg-2df3isufhi38****	The ID of the resource group.
SnapshotId	String	s-2zec5oj8e1yhxijt****	The ID of the snapshot.
Status	String	Ready	The status of the image cache.
Tags	Array of Tag		Details about tags of the image cache.
Key	String	imc	The key of the tag.
Value	String	test	The value of the tag.
RequestId	String	39FC2E43-3DD7-4CEF-9EF4-E4AD6E635301	The ID of the request.

Examples

Sample requests

https://eci.aliyuncs.com/?Action=DescribeImageCaches
&RegionId=cn-hangzhou
&<Common request parameters>

Sample success responses

XML format

<DescribeImageCachesResponse>
      <RequestId>39FC2E43-3DD7-4CEF-9EF4-E4AD6E635301</RequestId>
      <ImageCaches>
            <ImageCacheSize>20</ImageCacheSize>
            <Status>Ready</Status>
            <SnapshotId>s-2zec5oj8e1yhxijt****</SnapshotId>
            <Progress>100%</Progress>
            <ResourceGroupId>rg-2df3isufhi38****</ResourceGroupId>
            <ImageCacheId>imc-bp195erqe9o2pb09****</ImageCacheId>
            <ImageCacheName>imagetest</ImageCacheName>
            <CreationTime>2021-02-09T02:24:07Z</CreationTime>
            <ContainerGroupId>eci-bp18oq3m15prd9jb****</ContainerGroupId>
            <RegionId>cn-beijing</RegionId>
            <ExpireDateTime>2019-11-10T09:00:48Z</ExpireDateTime>
            <Events>
                  <Type>Normal</Type>
                  <LastTimestamp>2021-02-09T02:24:48Z</LastTimestamp>
                  <Message>Successfully check image cache resource.</Message>
                  <FirstTimestamp>2021-02-09T02:24:48Z</FirstTimestamp>
                  <Count>1</Count>
                  <Name>imagetest.1661f31f851a****</Name>
            </Events>
            <Tags>
                  <Value>test</Value>
                  <Key>imc</Key>
            </Tags>
            <Images>registry-vpc.cn-hangzhou.aliyuncs.com/eci_open/nginx:1.15.10-perl</Images>
      </ImageCaches>
</DescribeImageCachesResponse>

JSON format

{
    "RequestId": "39FC2E43-3DD7-4CEF-9EF4-E4AD6E635301",
    "ImageCaches": [{
        "ImageCacheSize": "20",
        "Status": "Ready",
        "SnapshotId": "s-2zec5oj8e1yhxijt****",
        "Progress": "100%",
        "ResourceGroupId": "rg-2df3isufhi38****",
        "ImageCacheId": "imc-bp195erqe9o2pb09****",
        "ImageCacheName": "imagetest",
        "CreationTime": "2021-02-09T02:24:07Z",
        "ContainerGroupId": "eci-bp18oq3m15prd9jb****",
        "RegionId": "cn-beijing",
        "ExpireDateTime": "2019-11-10T09:00:48Z",
        "Events": [{
            "Type": "Normal",
            "LastTimestamp": "2021-02-09T02:24:48Z",
            "Message": "Successfully check image cache resource.",
            "FirstTimestamp": "2021-02-09T02:24:48Z",
            "Count": "1",
            "Name": "imagetest.1661f31f851a****"
        }],
        "Tags": [{
            "Value": "test",
            "Key": "imc"
        }],
        "Images": "registry-vpc.cn-hangzhou.aliyuncs.com/eci_open/nginx:1.15.10-perl"
    }]
}

Error codes


HTTP status code	Error code	Error message	Description
400	Account.Arrearage	Your account has an outstanding payment.	The error message returned because your account has an overdue payment.
400	DryRunOperation	Request validation has been passed with DryRun flag set.	The error message returned because the specified dry run passed.
403	Forbidden.SubUser	The specified action is not available for you.	The error message returned because you are not authorized to perform the specified operation.
403	Forbidden.UserBussinessStatus	This operation is not allowed, because you have overdue bills. Pay the overdue bill and try again.	The error message returned because you have an overdue payment. Complete the overdue payment and try again later.
403	Forbidden.UserNotRealNameAuthentication	This operation is not allowed, because you have not passed the real-name verification.	The error message returned because you have not completed real-name verification and the specified operation is not allowed.
400	ServiceNotEnabled	%s	The error message returned because the service required to call the operation is not activated. Activate the service and try again later.

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