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
RegionId	String	Yes	cn-beijing	The region ID of the image cache.
Action	String	No	DescribeImageCaches	The operation that you want to perform. Set the value to DescribeImageCaches.
Image	String	No	registry-vpc.cn-beijing.aliyuncs.com/eci_open/busybox:1.3	The name of the image. You can use the image name to query the image caches.
ImageCacheId	String	No	imc-2zebxkiifuyzzlhl199f	The ID of the image cache.
ImageCacheName	String	No	liu-test-cache2	The name of the image cache.
SnapshotId	String	No	s-2zec5oj8e1yhxijtkfrr	The ID of the snapshot.

Response parameters


Parameter	Type	Example	Description
ImageCaches	Array	N/A	The image caches returned. A maximum of 20 records can be returned for a query.
ContainerGroupId	String	eci-bp18oq3m15prd9jbcznm	The ID of the container group.
CreationTime	String	2019-11-10T10:21:13Z	The time when the image cache was created.
Events	Array	N/A	The events returned.
Count	Integer	1	The number of returned events.
FirstTimestamp	String	2019-11-12T14:52:56Z	The beginning of the time range to query.
LastTimestamp	String	2019-11-12T14:52:56Z	The end of the time range to query.
Message	String	Success pull image nginx	The message of the event.
Name	String	nginx	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-2zebxkiifuyzzlhl199f	The ID of the image cache.
ImageCacheName	String	liu-test-cache1	The name of the image cache.
Images	List	registry-vpc.cn-beijing.aliyuncs.com/eci_open/busybox:1.3	The images in the image cache.
Progress	String	100%	The progress of creating the image cache.
SnapshotId	String	s-2zec5oj8e1yhxijtkfrr	The ID of the snapshot.
Status	String	Ready	The status of the image cache.
RequestId	String	B34CDB47-2F2B-41F5-B6A2-9DE802C22C83	The unique ID of the request.

Examples

Sample requests


http(s)://eci.aliyuncs.com/? Action=DescribeImageCaches
&RegionId=cn-beijing
&<Common request parameters>

Sample success responses

XML format

<ImageCaches>
    <CreationTime>2019-09-19T09:12:52Z</CreationTime>
    <Status>Failed</Status>
    <ContainerGroupId>eci-uf6amgvixmldxely9bn8</ContainerGroupId>
    <ImageCacheId>imc-uf6amgvixmldxely9bn8</ImageCacheId>
    <ImageCacheName>liu-test-cache</ImageCacheName>
    <SnapshotId/>
    <ExpireDateTime/>
    <Images>registry-vpc.cn-beijing.aliyuncs.com/eci_open/centos:7</Images>
    <Images>registry-vpc.cn-beijing.aliyuncs.com/eci_open/jenkins:2.60.3</Images>
    <Images>registry-vpc.cn-beijing.aliyuncs.com/liumi/redis:1.0</Images>
    <Progress>0%</Progress>
</ImageCaches>
<ImageCaches>
    <CreationTime>2019-09-18T12:39:57Z</CreationTime>
    <Status>Ready</Status>
    <ContainerGroupId>eci-uf69bpjhcmcot7kjkj9d</ContainerGroupId>
    <ImageCacheId>mc-uf69bpjhcmcot7kjkj9d</ImageCacheId>
    <ImageCacheName>liu-test-cache</ImageCacheName>
    <SnapshotId>s-uf60qp141knaik8ps6ra</SnapshotId>
    <ExpireDateTime/>
    <Images>registry-vpc.cn-shanghai.aliyuncs.com/eci_open/centos:7</Images>
    <Images>registry-vpc.cn-shanghai.aliyuncs.com/eci_open/jenkins:2.60.3</Images>
    <Images>registry-vpc.cn-shanghai.aliyuncs.com/liumi/redis:1.0</Images>
    <Progress>100%</Progress>
</ImageCaches>
<ImageCaches>
    <CreationTime>2019-09-19T01:56:33Z</CreationTime>
    <Status>Failed</Status>
    <ContainerGroupId>eci-uf6csmmw6sf9zp9lnhu5</ContainerGroupId>
    <ImageCacheId>mc-uf6csmmw6sf9zp9lnhu5</ImageCacheId>
    <ImageCacheName>liu-test-cache</ImageCacheName>
    <SnapshotId/>
    <ExpireDateTime/>
    <Images>registry-vpc.cn-shanghai.aliyuncs.com/eci_open/centos:7</Images>
    <Images>registry-vpc.cn-shanghai.aliyuncs.com/eci_open/jenkins:2.60.3</Images>
    <Images>registry-vpc.cn-shanghai.aliyuncs.com/liumi/redis:1.0</Images>
    <Progress>0%</Progress>
</ImageCaches>
<RequestId>C09C4B30-6EB3-4621-9F24-7267D753E928</RequestId>

JSON format

{
	"ImageCaches":[
		{
			"CreationTime":"2019-09-19T09:12:52Z",
			"ContainerGroupId":"eci-uf6amgvixmldxely9bn8",
			"Status":"Failed",
			"ImageCacheId":"imc-uf6amgvixmldxely9bn8",
			"ImageCacheName":"liu-test-cache",
			"SnapshotId":"",
			"Events":[],
			"Images":[
				"registry-vpc.cn-beijing.aliyuncs.com/eci_open/centos:7",
				"registry-vpc.cn-beijing.aliyuncs.com/eci_open/jenkins:2.60.3",
				"registry-vpc.cn-beijing.aliyuncs.com/liumi/redis:1.0"
			],
			"ExpireDateTime":"",
			"Progress":"0%"
		},
		{
			"CreationTime":"2019-09-18T12:39:57Z",
			"ContainerGroupId":"eci-uf69bpjhcmcot7kjkj9d",
			"Status":"Ready",
			"ImageCacheId":"mc-uf69bpjhcmcot7kjkj9d",
			"ImageCacheName":"liu-test-cache",
			"SnapshotId":"s-uf60qp141knaik8ps6ra",
			"Events":[],
			"Images":[
				"registry-vpc.cn-shanghai.aliyuncs.com/eci_open/centos:7",
				"registry-vpc.cn-shanghai.aliyuncs.com/eci_open/jenkins:2.60.3",
				"registry-vpc.cn-shanghai.aliyuncs.com/liumi/redis:1.0"
			],
			"ExpireDateTime":"",
			"Progress":"100%"
		},
		{
			"CreationTime":"2019-09-19T01:56:33Z",
			"ContainerGroupId":"eci-uf6csmmw6sf9zp9lnhu5",
			"Status":"Failed",
			"ImageCacheId":"mc-uf6csmmw6sf9zp9lnhu5",
			"ImageCacheName":"liu-test-cache",
			"SnapshotId":"",
			"Events":[],
			"Images":[
				"registry-vpc.cn-shanghai.aliyuncs.com/eci_open/centos:7",
				"registry-vpc.cn-shanghai.aliyuncs.com/eci_open/jenkins:2.60.3",
				"registry-vpc.cn-shanghai.aliyuncs.com/liumi/redis:1.0"
			],
			"ExpireDateTime":"",
			"Progress":"0%"
		}
	],
	"RequestId":"C09C4B30-6EB3-4621-9F24-7267D753E928"
}

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 the current user cannot 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 overdue payments. Settle the overdue payments 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.
403	NoPermission	The RAM role does not belong to ECS.	The error message returned because the RAM role does not belong to ECS.