All Products
Search
Document Center

ENS:DescribeImages

Last Updated:Nov 18, 2024

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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
ens:DescribeImageslist
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
EnsRegionIdstringNo

The ID of the Edge Node Service (ENS) node.

cn-dalian-unicom
ImageIdstringNo

The ID of the image. You can specify only one image ID.

Custom images and public images are supported.

m-5qm2r6xo7njrpdkx04q1o****
StatusstringNo

This parameter is unavailable.

This parameter is not currently in use.
ImageNamestringNo

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****
PageNumberstringNo

The page number. Pages start from page 1.

Default value: 1.

1
PageSizestringNo

The number of entries per page. Maximum value: 50.

Default value: 10.

50
SnapshotIdstringNo

The ID of the snapshot.

mock-clone_snapshot_id

Response parameters

ParameterTypeDescriptionExample
object
Codeinteger

The returned service code. 0 indicates that the request was successful.

0
Imagesarray<object>

The information about images.

Imageobject

The information about the image.

Architecturestring

The architecture of the image. Example: x86_64.

x86_64
CreationTimestring

The time when the image was created. The time follows the ISO 8601 standard.

2017-12-08T12:10:03Z
ImageIdstring

The ID of the image.

centos_6_08_64_20G_alibase_2017****
ImageNamestring

The name of the image.

Ubuntu_16.04
ImageOwnerAliasstring

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
ImageSizestring

The size of the image. Unit: GiB.

40
Platformstring

The operating system type of the image. Valid values:

  • Linux
  • Windows
centos
SnapshotIdstring

The ID of the snapshot.

mock-clone_snapshot_id
PageNumberinteger

The page number.

1
PageSizeinteger

The number of entries per page.

10
RequestIdstring

The ID of the request.

8331AA01-C16D-5481-BB47-D19CEBAA811E
TotalCountinteger

The total number of images.

4

Examples

Sample success responses

JSONformat

{
  "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": "",
              "Size": "",
              "Format": "",
              "imageId": ""
            }
          ]
        }
      }
    ]
  },
  "PageNumber": 1,
  "PageSize": 10,
  "RequestId": "8331AA01-C16D-5481-BB47-D19CEBAA811E",
  "TotalCount": 4
}

Error codes

HTTP status codeError codeError message
400MissingParameterThe input parameters that is mandatory for processing this request is not supplied.
400NoPermissionPermission denied.
400InvalidParameter.%sThe specified field %s invalid. Please check it again.

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

Change history

Change timeSummary of changesOperation
2024-10-16API Description Update. The Error code has changed. The response structure of the API has changedView Change Details
2024-01-22The Error code has changedView Change Details
2023-03-02The Error code has changed. The request parameters of the API has changed. The response structure of the API has changedView Change Details