All Products
Search
Document Center

ENS:DescribeImages

Last Updated:Mar 12, 2024

Queries available images.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

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.

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
Imagesobject []

The information about images.

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"
      }
    ]
  },
  "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-01-22The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
2023-03-02The Error code has changed. The request parameters of the API has changed. The response structure of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: SnapshotId
    delete Input Parameters: product
    delete Input Parameters: Version
Output ParametersThe response structure of the API has changed.