You can call this operation to submit a data backup task.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String No PutStartBackup

Required parameter. Value: PutStartBackup.
DrdsInstanceId String No drds****c6vxxyzd

The ID of the DRDS instance.
BackupMode String Yes phy

The backup mode. For more information, see backup mode and the valid values are as follows:

  • phy: fast backup
  • logic: Consistent backup
BackupLevel String Yes db

The backup level. Valid values:

  • instance: instance
  • db: The database type.
BackupDbNames String Yes db_1, db_2

If you need to back up data at the database level, you must specify the list of databases to be backed up, and separate multiple databases with commas (,).

Response parameters

Parameter Type Example Description
RequestId String 5D64DE5944A1******

The ID of the request.
Result String success

Indicates whether the backup task was submitted.
Success Boolean True

Indicates whether the request was successful.

Examples

Sample request

http(s)://drds.aliyuncs.com/? Action=PutStartBackup
&DrdsInstanceId=drds****c6vxxyzd
&<Common request parameters>

Sample success responses

XML format 

<code>200</code>
<data>
    <RequestId>07D9CC74-2707-4234-BC5A-1F11AE******</RequestId>
    <Success>true</Success>
    <Result>success</Result>
</data>

JSON format 

{
    "code": 200,
    "data": {
        "RequestId": "07D9CC74-2707-4234-BC5A-1F11AE******",
        "Success": "true",
        "Result": "success"
    }
}

Error codes

For a list of error codes, visit the API Error Center.