All Products
Search
Document Center

Database Backup:CreateIncrementBackupSetDownload

Last Updated:Nov 14, 2024

Creates and starts an incremental backup set download task.

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.

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

Request parameters

ParameterTypeRequiredDescriptionExample
BackupSetIdstringYes

The ID of the incremental backup task. To obtain the task ID, you can call the DescribeIncrementBackupList operation and check the value of BackupSetJobId in the response.

dbstooi01e****
BackupSetNamestringYes

The ID of the incremental backup set. To obtain the backup set ID, you can call the DescribeIncrementBackupList operation and check the value of BackupSetId in the response.

test
BackupSetDataFormatstringNo

The format in which the incremental backup set is downloaded. Valid values:

  • Native
  • SQL
  • CSV
  • JSON
Note Default value: Native.
Native
ClientTokenstringNo

The client token that is used to ensure the idempotence of the request.

ETnLKlblzczshOTUbOCz****

Response parameters

ParameterTypeDescriptionExample
object
HttpStatusCodeinteger

The HTTP status code.

200
RequestIdstring

The ID of the request.

D6E068C3-25BC-455A-85FE-45F0B22ECB1F
ErrCodestring

The error code.

Param.NotFound
Successboolean

Indicates whether the request is successful.

true
ErrMessagestring

The error message.

The specified parameter %s value is not valid.
BackupSetDownloadTaskIdstring

The ID of the backup set download task.

dbstooi01e****

Examples

Sample success responses

JSONformat

{
  "HttpStatusCode": 200,
  "RequestId": "D6E068C3-25BC-455A-85FE-45F0B22ECB1F",
  "ErrCode": "Param.NotFound",
  "Success": true,
  "ErrMessage": "The specified parameter %s value is not valid. ",
  "BackupSetDownloadTaskId": "dbstooi01e****"
}

Error codes

HTTP status codeError codeError message
403Request.ForbiddenHave no Permissions

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

Change history

Change timeSummary of changesOperation
No change history