ConfigBackupTask - Key Management Service - Alibaba Cloud Documentation Center

Operation description

This operation applies only to backup tasks for Hardware Security Module (HSM) instances in the Chinese mainland.

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

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
BackupId	string	Yes	The backup ID.	backup-173620705****
BackupPeriod	integer	Yes	The automatic backup interval, in days. Valid values: 1, 3, 7, and 30.	3
BackupHourInDay	integer	Yes	The backup time in 24-hour format. Valid values: 1 to 24.	12
Manual2PeriodicList	array	No	A list of image IDs to change from manual backup to automatic backup.
	string	No	The ID of an image to change from manual backup to automatic backup.	image-haiduf23bj****
Periodic2ManualList	array	No	A list of image IDs to change from automatic backup to manual backup.
	string	No	The ID of an image to change from automatic backup to manual backup.	image-daiduahsbj****

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request. Alibaba Cloud generates a unique ID for each request. Use this ID to troubleshoot issues.	4C467B38-3910-447D-87BC-AC049166F216

Examples

Success response

JSON format

{
  "RequestId": "4C467B38-3910-447D-87BC-AC049166F216"
}

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	caller has no permission
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.