CreateBackup - - Alibaba Cloud Documentation Center

Backs up an ApsaraDB for Redis instance.

Operation description

You can also back up an instance in the ApsaraDB for Redis console. For more information, see Backup and recovery.

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
kvstore:CreateBackup	create	DBInstance acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the instance.	r-bp1zxszhcgatnx****

Response parameters

Parameter	Type	Description	Example
	object
BackupJobID	string	The ID of the backup task. For cluster instances created before December 5, 2023, the return value is a comma-separated list composed of the job ID of each node within an instance. For example, if you have a cluster instance with two shards, the return value of BackupJobID is "10000,10001". For cluster instance created after December 5, 2023, all jobs for nodes in an instance are represented by a single job ID.	1162****
RequestId	string	The ID of the request.	2FF6158E-3394-4A90-B634-79C49184****

Examples

Sample success responses

JSONformat

{
  "BackupJobID": "1162****",
  "RequestId": "2FF6158E-3394-4A90-B634-79C49184****"
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2023-03-02	The internal configuration of the API is changed, but the call is not affected	View Change Details