DescribeExportImageInfo - ENS - Alibaba Cloud Documentation Center

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

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.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
ens:DescribeExportImageInfo	get	All Resources ``	none	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 parameters

Parameter	Type	Description	Example
	object
Images	array<object>	The returned result. For more information, see the Images parameter described in the JSON-formatted sample success response.
Image	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

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 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.

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

Change history

Change time	Summary of changes	Operation
2024-01-22	The Error code has changed	View Change Details