DescribeImageInfos for querying available images - ENS - Alibaba Cloud - ENS

Queries available image resources.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ens:DescribeImageInfos

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
OsType	string	No	The operating system type. Only a single type can be specified. If this parameter is not specified, all types are queried. Valid values: Linux windows In practice, passing linux or Linux may return an empty list, whereas omitting this parameter can return images with an OSType of linux. Verify the actual results before relying on this filter.	linux

Response elements

Element	Type	Description	Example
	object
Code	integer	The return code.	0
Images	object
Image	array<object>	The collection of image information.
	array<object>	The list of image information.
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 image version.	6.8
OSName	string	The image type. Valid values: centos, debian, ubuntu, and windows.	centos
OSType	string	The operating system type.	linux
ComputeType	string	The compute type of the image. Valid values: ens_vm: x86 computing arm_vm: ARM computing bare_metal: x86 bare metal pcfarm: heterogeneous computing Valid values: ens_vm : x86 computing. arm_vm : ARM computing. bare_metal : x86 bare metal. pcfarm : heterogeneous computing.	ens_vm
DiskDeviceMappings	object
DiskDeviceMapping	array<object>	The mapping between cloud disks and snapshots in the image.
	object	The mapping between cloud disks and snapshots in the image.
Type	string	The disk type. Valid values: System for system cloud disk and Data for data cloud disk.	Data
Size	string	The size of the image. Unit: GB.	100
Format	string	The format of the image.	Image format. Valid values: raw qcow2
imageId	string	The ID of the image.	i-test
RegionId	string	The region ID.	cn-wulanchabu
ImageOwnerAlias	string		system
RequestId	string	The request ID.	5568A08C-10A9-47F3-902F-647298B463FB

Examples

Success response

JSON format

{
  "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",
        "DiskDeviceMappings": {
          "DiskDeviceMapping": [
            {
              "Type": "Data",
              "Size": "100",
              "Format": "Image format. Valid values:\nraw\nqcow2",
              "imageId": "i-test"
            }
          ]
        },
        "RegionId": "cn-wulanchabu",
        "ImageOwnerAlias": "system"
      }
    ]
  },
  "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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.