Use DescribeSelfImages to query custom images - ENS

Queries custom 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:DescribeSelfImages

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
PageNumber	integer	No	The page number to return. Pages start from page 1. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Default value: 10.	10
ImageId	string	No	The ID of the image. Fuzzy search is supported.	centos_6_08_64_20G_a****
ImageName	string	No	The name of the image. Fuzzy search is supported.	centos_6_08_64_20G_a****
SnapshotId	string	No	The ID of the snapshot.	sp-5xg63dmojc1oaa3pk****

Response elements

Element	Type	Description	Example
	object
Code	integer	The HTTP status code that is returned.	0
Images	object
Image	array<object>	The image information.
	array<object>
Architecture	string	The image architecture. Valid values: i386 x86_64	x86_64
CreationTime	string	The image creation time. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2017-12-08T12:10:03Z
ImageId	string	The ID of the image.	centos_6_08_64_20G_a****
ImageName	string	The name of the image.	centos_6_08_64_20G_a****
ImageOwnerAlias	string	The source of the image. Valid values: others: a custom image that is shared by other Alibaba Cloud accounts. self: your own custom image.	self
ImageSize	string	The size of the image. Unit: GiB.	20
InstanceId	string	The ID of the instance.	i-5iqczfxps7csjrxeca****
OsVersion	string	The operating system version.	7.2
Platform	string	The platform. centos ubuntu alios debian rhel windows	centos
Status	string	The state of the image. Creating. Packing. Uploading. Pack_failed. Upload_failed. Available: Only images in the Available state can be used and operated. Unavailable. Copying.	Creating
ComputeType	string	Computing type. ens_vm/ens: x86 computing. bare_metal: x86 bare machine or x86 bare metal. arm_vm: ARM computing. arm_bare_metal: ARM bare machine or ARM bare metal. pcfarm: heterogeneous computing.	ens_vm
SnapshotId	string	The snapshot ID.	sp-5yt3bdedxzdz6t6uuw****
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
ImageStorageSize	string	The size of the image storage.	400
RegionId	string	The ID of the region.	cn-wulanchabu
RequestId	string	The request ID.	A8B8EB73-B4FD-4262-8EF6-680DF39C9BA0
PageSize	string	The number of entries per page. Maximum value: 50. Default value: 10.	10
PageNumber	string	The page number.	1
TotalCount	string	The total number of entries returned.	1

Examples

Success response

JSON format

{
  "Code": 0,
  "Images": {
    "Image": [
      {
        "Architecture": "x86_64",
        "CreationTime": "2017-12-08T12:10:03Z",
        "ImageId": "centos_6_08_64_20G_a****",
        "ImageName": "centos_6_08_64_20G_a****",
        "ImageOwnerAlias": "self",
        "ImageSize": "20",
        "InstanceId": "i-5iqczfxps7csjrxeca****",
        "OsVersion": "7.2",
        "Platform": "centos",
        "Status": "Creating",
        "ComputeType": "ens_vm",
        "SnapshotId": "sp-5yt3bdedxzdz6t6uuw****",
        "DiskDeviceMappings": {
          "DiskDeviceMapping": [
            {
              "Type": "Data",
              "Size": "100",
              "Format": "Image format.\nraw\nqcow2",
              "imageId": "i-test"
            }
          ]
        },
        "ImageStorageSize": "400",
        "RegionId": "cn-wulanchabu"
      }
    ]
  },
  "RequestId": "A8B8EB73-B4FD-4262-8EF6-680DF39C9BA0",
  "PageSize": "10",
  "PageNumber": "1",
  "TotalCount": "1"
}

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.