All Products
Search
Document Center

Database Backup:CreateFullBackupSetDownload

Last Updated:Mar 27, 2023

Creates and starts a full backup set download task.

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 keyAssociation operation
dbs:CreateFullBackupSetDownloadRead
    All Resources
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
BackupSetIdstringYes

The ID of the full backup set.

dbs1hvXXXXX
BackupSetDataFormatstringNo

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

  • Native
  • SQL
  • CSV
  • JSON
NoteDefault value: CSV.
SQL
ClientTokenstringNo

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

ETnLKlblzczshOTUbOCzxxxxxxx

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.

dbstooi01exxxxx

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": "dbstooi01exxxxx"
}

Error codes

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