All Products
Search
Document Center

ENS:DescribeExportImageInfo

Last Updated:Mar 12, 2024

Queries the export result of an image.

Operation description

  • You can call this operation to query information about all custom images in your account. The information include the image properties, image export status, and the Object Storage Service (OSS) download links.
  • Empty strings are returned for images that are not exported.
  • The download links may become invalid if you delete objects in OSS.

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
ImageIdstringNo

The ID of the image.

m-xxxxx
ImageNamestringNo

The name of the image.

testImageName
PageNumberintegerNo

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

1
PageSizeintegerNo

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

10

Response parameters

ParameterTypeDescriptionExample
object
Imagesobject []

The returned result. For more information, see the Images parameter described in the JSON-formatted sample success response.

Architecturestring

The architecture of the image. Example: x86_64.

x86_64
CreationTimestring

The time when the image was created.

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

The URL of the exported image.

https://user_defined_bucket.oss-cn-beijing.aliyuncs.com/m-xxxxxxxxx1.qcow2
ImageExportStatusstring

The export status of the image. Valid values:

  • Exporting
  • Exported
  • ExportError
  • Unexported
Exported
ImageIdstring

The ID of the image.

m-xxxxxxxxx1
ImageNamestring

The name of the image.

m-xxxxxxxxx1
ImageOwnerAliasstring

The source of the image. Valid values:

  • system: public image
  • self: custom image
system
Platformstring

The OS.

centos
PageNumberinteger

The page number.

1
PageSizeinteger

The number of entries per page.

10
RequestIdstring

The ID of the request.

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
TotalCountinteger

The total number of entries returned.

13

Examples

Sample success responses

JSONformat

{
  "Images": {
    "Image": [
      {
        "Architecture": "x86_64",
        "CreationTime": "2017-12-08T12:10:03Z",
        "ExportedImageURL": "https://user_defined_bucket.oss-cn-beijing.aliyuncs.com/m-xxxxxxxxx1.qcow2",
        "ImageExportStatus": "Exported",
        "ImageId": "m-xxxxxxxxx1",
        "ImageName": "m-xxxxxxxxx1",
        "ImageOwnerAlias": "system",
        "Platform": "centos"
      }
    ]
  },
  "PageNumber": 1,
  "PageSize": 10,
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "TotalCount": 13
}

Error codes

HTTP status codeError codeError messageDescription
400MissingParameterThe input parameter that is mandatory for processing this request is not supplied.-
400NoPermissionPermission denied.-
400InvalidParameter.%sThe specified field %s invalid. Please check it again.-
400InvalidParameterThe errorMessage is %s. Please check it again.-
400ens.interface.errorAn error occurred while calling the API.-
400CallInterfaceCall Interface Happen Error.An error occurred when you call the operation.

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.
    Error Codes 400 change