All Products
Search
Document Center

ENS:ExportImage

Last Updated:Jul 26, 2024

Exports a custom image to an Object Storage Service (OSS) bucket in the same region.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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:ExportImage
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ImageIdstringYes

The ID of the image.

m-5ragaz3s74b7go8ks7jp9****
OSSBucketstringYes

The OSS bucket to which you want to export the image.

whxyl****
OSSRegionIdstringYes

The ID of the region.

Valid values:

  • cn-beijing
cn-beijing
OSSPrefixstringNo

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****/
RoleNamestringNo

The name of the Resource Access Management (RAM) role.

AliyunMNSLoggingRole

Response parameters

ParameterTypeDescriptionExample
object
ExportedImageURLstring

The URL that points to the exported image.

http://oss.url
RequestIdstring

The ID of the request.

43A426AD-3F2E-5DD9-9C08-D4DBDCA48D85

Examples

Sample success responses

JSONformat

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

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.-
400InvalidSecurityGroupId.NotFoundThe specified SecurityGroupId does not exist.-
400SecurityGroupRuleConflict.DuplicatedThe SecurityGroup rule already exists.-
400AuthorizationLimitExceedThe limit of authorization records in the security group reaches.-
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
2023-12-07The Error code has changedView Change Details