Queries DescribeBackupSets backup sets.

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 Yes DescribeBackupSets

Required parameter. Value: DescribeBackupSets.
DrdsInstanceId String Yes drds***********

The ID of the DRDS instance.
EndTime String Yes 1591326000000

The end of the query time which is in timestamp format (measured in millisecond) .

Note The end time must be later than the start time.
StartTime String Yes 1591327800000

The beginning of the query time which is in timestamp format (measured in millisecond).

Response parameters

Parameter Type Example Description
BackupSets Array

The list of backup sets.
backupSet
BackupConsitentTime String 2020-06-05 11:31:38

Backup Recovery duration.
BackupDbs List ["dts********"]

The list of backup databases.
BackupEndTime Long 1591327899000

The end of the backup time which is in timestamp format (measured in millisecond).

Note 0 indicates not finished.
BackupLevel String instance

The level of the backup. Valid values:

  • db: The database level.
  • instance: the instance level.
BackupMode String logic

The backup method. Valid values:

  • logic: the logical backup.
  • phy: fast backup
BackupStartTime Long 1591327754000 The beginning of the backup time which is in timestamp format (measured in millisecond).
BackupTotalSize String 93.24

The size of the backup set. Unit: MB.
BackupType String manual

The type of the backup. Valid values:

  • manual: indicates a manual backup.
  • auto: indicates an automatic backup.
EnableRecovery Boolean false

Indicates whether the backup set can be restored. Valid values:
Id String ba30d5c4-a6 dc-11ea-bd40-************

The ID of the data backup file you want to use.
Status Long 2

The status of the backup instance. Valid values:

  • -1: Failed
  • 0: Not started
  • 1: The storage instance is running.
  • 2: Success
RequestId String 7103AEE3-9025-442F-B82B-BABD0A******

The ID of the request.
Success Boolean True

Indicates whether the request was successful.

Examples

Sample requests

http(s)://drds.aliyuncs.com/? Action=DescribeBackupSets
&DrdsInstanceId=drds***********
&EndTime=1591326000000
&StartTime=1591327800000
&<Common request parameters>

Sample success responses

XML format 

<RequestId>7103AEE3-9025-442F-B82B-BABD0A******</RequestId>
<BackupSets>
    <backupSet>
        <Status>2</Status>
        <BackupTotalSize>93.24</BackupTotalSize>
        <BackupConsitentTime>2020-06-05 11:31:38</BackupConsitentTime>
        <BackupEndTime>1591327899000</BackupEndTime>
        <BackupMode>logic</BackupMode>
        <BackupLevel>instance</BackupLevel>
        <BackupStartTime>1591327754000</BackupStartTime>
        <BackupType>manual</BackupType>
        <BackupDbs>
            <backupDb>dts********</backupDb>
        </BackupDbs>
        <Id>ba30d5c4-a6dc-11ea-bd40-************</Id>
        <EnableRecovery>true</EnableRecovery>
    </backupSet>
</BackupSets>
<Success>true</Success>

JSON format 

{
    "RequestId": "7103AEE3-9025-442F-B82B-BABD0A******",
    "BackupSets": {
        "backupSet": [
            {
                "Status": 2,
                "BackupTotalSize": "93.24",
                "BackupConsitentTime": "2020-06-05 11:31:38",
                "BackupEndTime": 1591327899000,
                "BackupMode": "logic",
                "BackupLevel": "instance",
                "BackupStartTime": 1591327754000,
                "BackupType": "manual",
                "BackupDbs": {
                    "backupDb": [
                        "dts********"
                    ]
                },
                "Id": "ba30d5c4-a6dc-11ea-bd40-************",
                "EnableRecovery": true
            }
        ]
    },
    "Success": true
}

Error codes

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