ExportImage - Key Management Service - Alibaba Cloud Documentation Center

Exports the image of a specified Hardware Security Module (HSM).

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

yundun-hsm:ExportImage

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the HSM instance.	hsm-cn-vj30bil8****
ImageId	string	Yes	The ID of the image.	image-8vbdd5uc6v10ecn5****

Response parameters

Parameter	Type	Description	Example
	object	The response.
RequestId	string	The ID of the request. Alibaba Cloud generates this unique ID for each request. You can use this ID to troubleshoot issues.	4C467B38-3910-447D-87BC-AC049166F216
Job	object	The information about the asynchronous task.
JobId	string	The ID of the task.	b1748ca6-6b55-49f4-a6d4-2d694a9f3693
Type	string	The type of the task operation. create: Creates a task. cancel: Cancels a task.	create
Completed	boolean	Indicates whether the task is complete. true: The task is complete. false: The task is in progress.	true
Status	string	The status of the task. running: The task is running. cancel: The task is canceled. fail: The task failed. success: The task is successful.	running
Response	string	The response returned after the operation is successful.	success
Error	string	The error message returned if the operation fails or an exception occurs.	Job.Canceled
Process	integer	The progress of the task execution. Unit: percent.	100

Examples

Success response

JSON format

{
  "RequestId": "4C467B38-3910-447D-87BC-AC049166F216",
  "Job": {
    "JobId": "b1748ca6-6b55-49f4-a6d4-2d694a9f3693",
    "Type": "create",
    "Completed": true,
    "Status": "running",
    "Response": "success",
    "Error": "Job.Canceled",
    "Process": 100
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidApiParam.Error	api param is invalid
500	InternalError	The request processing has failed due to some unknown error.	Unknown error caused request processing to fail.
403	NoPermission	User has no permission to access this resource.
403	Backup.ActionForbidden	This API is forbidden for this backup type.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.