DescribeImages API Overview for ENS Image Queries - ENS

Queries available images.

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:DescribeImages

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
EnsRegionId	string	No	The ID of the Edge Node Service (ENS) node.	cn-dalian-unicom
ImageId	string	No	The ID of the image. You can specify only one image ID. Custom images and public images are supported.	m-5qm2r6xo7njrpdkx04q1o****
Status	string	No	This parameter is unavailable.	This parameter is not used.
ImageName	string	No	The name of the custom image. The name must be 2 to 128 characters in length The name must start with a letter and cannot start with `acs:` or `aliyun`. The name cannot contain `http://` or `https://`. The name can contain letters, digits, periods (.), colons (:), underscores (_), and hyphens (-). By default, this parameter is left empty, which indicates that the original name is retained.	centos_6_08_64_20G_a****
PageNumber	string	No	The page number. Pages start from page 1. Default value: 1.	1
PageSize	string	No	The number of entries per page. Maximum value: 50. Default value: 10.	50
SnapshotId	string	No	The ID of the snapshot.	mock-clone_snapshot_id

Response elements

Element	Type	Description	Example
	object
Code	integer	The returned service code. 0 indicates that the request was successful.	0
Images	object
Image	array<object>	The information about the images.
	array<object>	The information about the image.
Architecture	string	The architecture of the image. Example: x86_64.	x86_64
CreationTime	string	The time when the image was created. The time follows the ISO 8601 standard.	2017-12-08T12:10:03Z
ImageId	string	The ID of the image.	centos_6_08_64_20G_alibase_2017****
ImageName	string	The name of the image.	Ubuntu_16.04
ImageOwnerAlias	string	The source of the image. Valid values: system: Alibaba Cloud public images self: your custom images others: shared images from other Alibaba Cloud accounts, or community images published by other Alibaba Cloud accounts	system
ImageSize	string	The size of the image. Unit: GiB.	40
Platform	string	The operating system type of the image. Valid values: Linux Windows	centos
SnapshotId	string	The ID of the snapshot.	mock-clone_snapshot_id
DiskDeviceMappings	object
DiskDeviceMapping	array<object>	The mappings between the disk and the snapshot in the image.
	object	The mappings between the disk and the snapshot in the image.
Type	string	The type of the disk. Valid values: system: system disk. data: data disk.	Data
Size	string	The size of the disk. Unit: GiB.	100
Format	string	The format of the image.	Image format. raw qcow2
imageId	string	The ID of image.	i-test
RegionId	string	The region ID.	cn-beijing
PageNumber	integer	The page number.	1
PageSize	integer	The number of entries per page.	10
RequestId	string	The ID of the request.	8331AA01-C16D-5481-BB47-D19CEBAA811E
TotalCount	integer	The total number of images.	4

Examples

Success response

JSON format

{
  "Code": 0,
  "Images": {
    "Image": [
      {
        "Architecture": "x86_64",
        "CreationTime": "2017-12-08T12:10:03Z",
        "ImageId": "centos_6_08_64_20G_alibase_2017****",
        "ImageName": "Ubuntu_16.04",
        "ImageOwnerAlias": "system",
        "ImageSize": "40",
        "Platform": "centos",
        "SnapshotId": "mock-clone_snapshot_id",
        "DiskDeviceMappings": {
          "DiskDeviceMapping": [
            {
              "Type": "Data",
              "Size": "100",
              "Format": "Image format.\nraw\nqcow2",
              "imageId": "i-test"
            }
          ]
        },
        "RegionId": "cn-beijing"
      }
    ]
  },
  "PageNumber": 1,
  "PageSize": 10,
  "RequestId": "8331AA01-C16D-5481-BB47-D19CEBAA811E",
  "TotalCount": 4
}

Error codes

HTTP status code	Error code	Error message
400	MissingParameter	The input parameters that is mandatory for processing this request is not supplied.
400	NoPermission	Permission denied.
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.