DescribeImageInfos - ENS - Alibaba Cloud Documentation Center

Queries available images.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
ens:DescribeImageInfos	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
OsType	string	No	The operating system (OS). You can specify only one OS in a request. If you do not specify a value for this parameter, images for all supported OSs are queried. Valid values: linux windows	linux

Response parameters

Parameter	Type	Description	Example
	object
Code	integer	The HTTP status code that is returned.	0
Images	array<object>	The information about images.
Image	object
Description	string	The description of the image.	centos_6_08_64_20G_alibase_2017****
ImageId	string	The ID of the image.	centos_6_08_64_20G_alibase_2017****
ImageSize	string	The size of the image. Unit: GiB.	20
ImageVersion	string	The version of the image.	6.8
OSName	string	The type of the image. Valid values: centos, debian, ubuntu, and windows.	centos
OSType	string	The type of the operating system.	linux
ComputeType	string	The computing type of the image. Valid values: ens_vm: x86 computing. arm_vm: ARM computing. bare_metal: x86 bare machine. pcfarm: heterogeneous computing.	ens_vm
RequestId	string	The request ID.	5568A08C-10A9-47F3-902F-647298B463FB

Examples

Sample success responses

JSONformat

{
  "Code": 0,
  "Images": {
    "Image": [
      {
        "Description": "centos_6_08_64_20G_alibase_2017****",
        "ImageId": "centos_6_08_64_20G_alibase_2017****",
        "ImageSize": "20",
        "ImageVersion": "6.8",
        "OSName": "centos",
        "OSType": "linux",
        "ComputeType": "ens_vm"
      }
    ]
  },
  "RequestId": "5568A08C-10A9-47F3-902F-647298B463FB"
}

Error codes

HTTP status code	Error code	Error message	Description
400	MissingParameter	The input parameter domainName that is mandatory for processing this request is not supplied.	-
400	InstanceIdNotFound	The input parameter instancdId that is not found.	The specified instance ID does not exist.
400	NoPermission	Permission denied.	-
400	CallInterface	Call Interface Happen Error.	An error occurred when you call the operation.
400	InvalidParameter.%s	The specified field %s invalid. Please check it again.	-

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-10-16	The Error code has changed. The response structure of the API has changed	View Change Details
2023-05-09	API Description Update. The Error code has changed	View Change Details