Export a custom image to an OSS bucket with ExportImage - ENS

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ImageId	string	Yes	The ID of the image.	m-5ragaz3s74b7go8ks7jp9****
OSSBucket	string	Yes	The OSS bucket to which you want to export the image.	whxyl****
OSSRegionId	string	Yes	The region ID.	cn-beijing
OSSPrefix	string	No	The prefix of the object as which you want to store the image in the OSS bucket. The prefix must be 1 to 30 characters in length and can contain digits and letters.	dataCenter/972****/
RoleName	string	No	The name of the Resource Access Management (RAM) role.	AliyunMNSLoggingRole

Response elements

Element	Type	Description	Example
	object
ExportedImageURL	string	The URL that points to the exported image.	http://oss.url
RequestId	string	The ID of the request.	43A426AD-3F2E-5DD9-9C08-D4DBDCA48D85

Examples

Success response

JSON format

{
  "ExportedImageURL": "http://oss.url",
  "RequestId": "43A426AD-3F2E-5DD9-9C08-D4DBDCA48D85"
}

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	InvalidSecurityGroupId.NotFound	The specified SecurityGroupId does not exist.	The specified security group ID does not exist.
400	SecurityGroupRuleConflict.Duplicated	The SecurityGroup rule already exists.	duplicate security group rules.
400	AuthorizationLimitExceed	The limit of authorization records in the security group reaches.	The number of security group rules exceeds the limit.
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.
400	InvalidImageType.NotSupported	The specified image type is not supported.	The specified image does not support sharing or exporting.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.