DescribeImages

Description

call DescribeImages to query the mirror resources you can use.

Request Method

POST

Request Path

/apsara/route/Ecs/DescribeImages

Request Parameters Common Parameters

Name	Location	Type	Required	Sample value	Description
ImageOwnerAlias	BODY	string	No	self	image source. Value range: system: a public image provided by alibaba cloud. self: the custom image you created. others: images shared with you by other alibaba cloud users. Default value: null, null means to return results with values of system, self, and others.
Tag.N.key	BODY	string	No	null	the tag key of the mirror. Description This parameter is about to be deprecated. To improve compatibility, we recommend that you use the Tag.N.Key parameter as much as possible.
ActionType	BODY	string	No	CreateEcs	Mirror the scene that needs to be used. Value range: CreateEcs (default): create instance ChangeOS: replace system disk/replace operating system
PageSize	BODY	integer	No	1	the number of rows per page set during paging query. Maximum value: 100 default value: 10.
ResourceGroupId	BODY	string	No	rg-bp67acfmxazb4ph***	the ID of the enterprise resource group where the custom image is located.
DryRun	BODY	boolean	No	false	whether to precheck only this request. true: sends a check request and does not query the resource status. Check items include whether the AccessKey is valid, the authorization status of RAM users, and whether required parameters are filled in. If the check fails, the corresponding error is returned. If the check passes, the error code DryRunOperation will be returned. false: sends a normal request, returns a 2XX HTTP status code after checking, and directly queries the resource status. default value: false.
ShowExpired	BODY	boolean	No	false	whether the subscription image has expired. Description This parameter is about to be deprecated. To improve compatibility, please use other parameters as much as possible.
Filter.N.Key	BODY	string	No	CreationStartTime	Specify the key of the filter type.
PageNumber	BODY	integer	No	1	the page number of the mirror resource list. Start value: 1 default value: 1.
Tag.N.Value	BODY	string	No	Test	the tag value of the mirror. The value range of n is 1~20.
ImageId	BODY	string	No	m-bp1g7004ksh0oeuc3***	mirror ID.
InstanceType	BODY	string	No	ecs.g5.large	specifies the image that the instance type can use.
Status	BODY	string	No	Available	query the image in a certain state. Value range: Creating: the image is being created. Waiting: multitasking in queue. Available (default): the image you can use. UnAvailable: a mirror that you cannot use. CreateFailed: create failed image. supports taking multiple values at the same time, and the values are separated by half-width commas (,).
Usage	BODY	string	No	instance	Whether the image is already running in the ECS instance. Value range: instance: The image is running and is used by ECS instances. none: The image is idle and no ECS instance is currently used.
Tag.N.Key	BODY	string	No	Test	the tag key of the mirror. The value range of n is 1~20.
Architecture	BODY	string	No	i386	mirror architecture. Value range: i386 x86_64
version	BODY	string	No	2016-01-01	version of api
IsSupportIoOptimized	BODY	boolean	No	true	Whether the image can run on an I/O optimized instance.
IsSupportCloudinit	BODY	boolean	No	true	whether the image supports Cloud Init.
SnapshotId	BODY	string	No	s-bp17ot2q7x72ggtwr***	a custom image created based on a snapshot ID.
ImageName	BODY	string	No	Test	image name.
Tag.N.value	BODY	string	No	null	the tag value of the mirror. Description This parameter is about to be deprecated. To improve compatibility, it is recommended that you use the Tag.N.Value parameter as much as possible.
regionId	BODY	string	Yes	No sample value for this parameter.	region id
OSType	BODY	string	No	linux	the operating system type of the image. Value range: windows linux
Filter.N.Value	BODY	string	No	2017-12-05T22:40:00Z	specifies the value of the filter type.
RegionId	BODY	string	Yes	cn-qingdao-env17-d01	the region ID to which the instance belongs. You can call the DescribeRegions to view the latest Alibaba Cloud region list.

Return data

Name	Type	Sample value	Description
RequestID	string	1E3D5A1E0-67CA-43DA-24BC-EAF2D5A1E4DC	Request id

Example

Successful Response example

{
 "RequestID":"1E3D5A1E0-67CA-43DA-24BC-EAF2D5A1E4DC"
}

Failed Response example

{
 "errorSample":
 {
  "resultCode":-1,
  "resultMsg":"system error",
  "result":null
 }

}