All Products
Search
Document Center

ENS:DescribeSelfImages

Last Updated:Nov 18, 2024

Queries custom 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:DescribeSelfImageslist
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
PageNumberintegerNo

The page number to return. Pages start from page 1. Default value: 1.

1
PageSizeintegerNo

The number of entries per page.

Default value: 10.

10
ImageIdstringNo

The ID of the image. Fuzzy search is supported.

centos_6_08_64_20G_a****
ImageNamestringNo

The name of the image. Fuzzy search is supported.

centos_6_08_64_20G_a****
SnapshotIdstringNo

The ID of the snapshot.

sp-5xg63dmojc1oaa3pk****

Response parameters

ParameterTypeDescriptionExample
object
Codeinteger

The HTTP status code that is returned.

0
Imagesarray<object>

The image information.

Imageobject
Architecturestring

The image architecture. Valid values:

  • i386
  • x86_64
x86_64
CreationTimestring

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
ImageIdstring

The ID of the image.

centos_6_08_64_20G_a****
ImageNamestring

The name of the image.

centos_6_08_64_20G_a****
ImageOwnerAliasstring

The source of the image. Valid values:

  • others: a custom image that is shared by other Alibaba Cloud accounts.
  • self: your own custom image.
system
ImageSizestring

The size of the image. Unit: GiB.

20
InstanceIdstring

The ID of the instance.

i-5iqczfxps7csjrxeca****
OsVersionstring

The operating system version.

7.2
Platformstring

The platform.

  • centos
  • ubuntu
  • alios
  • debian
  • rhel
  • windows
centos
Statusstring

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
ComputeTypestring

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
SnapshotIdstring

The snapshot ID.

sp-5yt3bdedxzdz6t6uuw****
ImageStorageSizestring

The size of the image storage.

400
RequestIdstring

The request ID.

A8B8EB73-B4FD-4262-8EF6-680DF39C9BA0

Examples

Sample success responses

JSONformat

{
  "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": "system",
        "ImageSize": "20",
        "InstanceId": "i-5iqczfxps7csjrxeca****",
        "OsVersion": "7.2",
        "Platform": "centos",
        "Status": "Creating",
        "ComputeType": "ens_vm",
        "SnapshotId": "sp-5yt3bdedxzdz6t6uuw****",
        "DiskDeviceMappings": {
          "DiskDeviceMapping": [
            {
              "Type": "",
              "Size": "",
              "Format": "",
              "imageId": ""
            }
          ]
        },
        "ImageStorageSize": "400"
      }
    ]
  },
  "RequestId": "A8B8EB73-B4FD-4262-8EF6-680DF39C9BA0"
}

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-16The Error code has changed. The response structure of the API has changedView Change Details
2024-08-22The Error code has changed. The response structure of the API has changedView Change Details
2023-04-11The 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
2022-09-22Add OperationView Change Details