Use DescribeExportImageInfo to query image export information - ENS

Queries the export result of an image.

Operation description

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.

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:DescribeExportImageInfo

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ImageId	string	No	The ID of the image.	m-xxxxx
ImageName	string	No	The name of the image.	testImageName
PageNumber	integer	No	The page number. Pages start from page 1. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Maximum value: 50. Default value: 10.	10

Response elements

Element	Type	Description	Example
	object
Images	object
Image	array<object>	The returned result. For more information, see the Images parameter described in the JSON-formatted sample success response.
	object
Architecture	string	The architecture of the image. Example: x86_64.	x86_64
CreationTime	string	The time when the image was created.	2017-12-08T12:10:03Z
ExportedImageURL	string	The URL of the exported image.	https://user_defined_bucket.oss-cn-beijing.aliyuncs.com/m-xxxxxxxxx1.qcow2
ImageExportStatus	string	The export status of the image. Valid values: Exporting Exported ExportError Unexported	Exported
ImageId	string	The ID of the image.	m-xxxxxxxxx1
ImageName	string	The name of the image.	m-xxxxxxxxx1
ImageOwnerAlias	string	The source of the image. Valid values: system: public image self: custom image	system
Platform	string	The OS.	centos
PageNumber	integer	The page number.	1
PageSize	integer	The number of entries per page.	10
RequestId	string	The ID of the request.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
TotalCount	integer	The total number of entries returned.	13

Examples

Success response

JSON format

{
  "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 code	Error code	Error message	Description
400	MissingParameter	The input parameter 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.
400	InvalidParameter	The errorMessage is %s. Please check it again.
400	ens.interface.error	An error occurred while calling the API.
400	CallInterface	Call Interface Happen Error.	An error occurred when you call the operation.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.