You can call the DescribeOssDownloads operation to query the backup file details of a backup data migration task for an ApsaraDB RDS for SQL Server instance.

Note This operation is not supported for instances that run SQL Server 2017 EE or SQL Server 2019 EE.


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 for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeOssDownloads

The operation that you want to perform. Set the value to DescribeOssDownloads.

DBInstanceId String Yes rm-uf6wjk5xxxxxxx

The ID of the instance. You can call the DescribeDBInstances operation to query the ID of the instance.

MigrateTaskId String Yes 5625458541

The ID of the backup data migration task. You can call the DescribeMigrateTasks operation to query the ID of the migration task.

ResourceGroupId String No rg-acfmy*****

The ID of the resource group.

Response parameters

Parameter Type Example Description
DBInstanceId String rm-uf6wjk5xxxxxxx

The ID of the instance.

RequestId String A5409D02-D661-4BF3-8F3D-0A814D0574E7

The ID of the request.

MigrateTaskId String 562154852

The ID of the migration task.

Items Array of OssDownload

Details of the backup file.

EndTime String 2017-08-27T12:45:15Z

The end of the time range. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

Status String Finished

The state of the backup file. Valid values:

  • NoStart:
  • Downloading
  • Finished
  • DownloadFailed
  • VerifyFailed
  • Deleted
  • DeleteFailed
  • CheckSuccess
  • CheckFailed
  • Restoring
  • Restored
  • RestoredFailed
Description String App description

The description of the file.

CreateTime String 2017-08-17T12:45:15Z

The time when the backup file was created in the download list. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

BackupMode String Database

The backup type. Valid values:

  • Database: full backup file
  • Differential_Database: incremental backup file
  • Transaction_Log: log backup file
IsAvailable String True

Indicates whether the backup file is available. Valid values: True and False.

FileName String test

The name of the backup file stored in the Object Storage Service (OSS) bucket.

FileSize String 2

The size of the backup file. Unit: MB


Sample requests

&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK

            <Description>App description</Description>

JSON format

HTTP/1.1 200 OK

  "DescribeDBInstancesResponse" : {
    "RequestId" : "A5409D02-D661-4BF3-8F3D-0A814D0574E7",
    "DBInstanceId" : "rm-uf6wjk5xxxxxxx",
    "MigrateTaskId" : 562154852,
    "Items" : {
      "OssDownload" : {
        "Status" : "Finished",
        "Description" : "App description",
        "EndTime" : "2017-08-27T12:45:15Z",
        "IsAvailable" : "True",
        "BackupMode" : "Database",
        "CreateTime" : "2017-08-17T12:45:15Z",
        "FileName" : "test",
        "FileSize" : 2

Error codes

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