You can call this operation to view the details of the backup data files which are uploaded to OSS.

Note This operation is not applicable to SQL Server 2017 cluster instances.

Debugging

You can use API Explorer to perform debugging. API Explorer allows you to perform various operations to simplify API usage. For example, you can retrieve APIs, call APIs, and dynamically generate SDK example code.

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 this instance.

MigrateTaskId String Yes 5625458541

The ID of the migration task. You can call the DescribeMigrateTasks operation to query the IDs of migration tasks.

AccessKeyId String No LTAIfCxxxxxxx

The AccessKey ID issued by Alibaba Cloud for users to access services.

Response parameters

Parameter Type Example Description
DBInstanceId String rm-uf6wjk5xxxxxxx

The ID of the instance.

Items

The list of the imported files.

└BackupMode String FULL

The backup type. Valid values:

  • FULL.
  • DIFF.
  • LOG.
└CreateTime String 2017-08-17T12:45:15Z

The creation time of the backup file in the download list.

└Description String App description

The description of the file.

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

The end time.

└FileName String test

The name of the backup file stored in OSS.

└FileSize String 2

The size of the backup file. Unit: MB

└IsAvailable String True

Indicates whether the backup files are available. Valid values:True | False
└Status String Finished

The status of the file. Valid values:

  • NoStart.
  • Downloading.
  • Finished.
  • DownloadFailed.
  • VerifyFailed.
  • Deleted.
  • DeleteFailed.
  • CheckSuccess.
  • CheckFailed.
  • Restoring.
  • Restored.
  • RestoredFailed.
MigrateTaskId String 562154852

The ID of the migration task.

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

The ID of the request.

Examples

Sample requests


http(s)://rds.aliyuncs.com/? Action=DescribeOssDownloads
&DBInstanceId=rm-uf6wjk5xxxxxxx
&MigrateTaskId=5625458541
&<Common request parameters>

Successful response examples

XML format 

<DescribeOssDownloadsResponse> 
  <RequestId>A5409D02-D661-4BF3-8F3D-0A814D0574E7</RequestId> 
  <DBInstanceId>rm-uf6wjk5xxxxxxx</DBInstanceId> 
  <MigrateTaskId>562154852</MigrateTaskId> 
  <Items> 
    <FileName>test</FileName>
    <CreateTime>2017-05-30 T12:11:4Z</CreateTime>
    <FileSize>2MB</FileSize>
    <IsAvailable>True</IsAvailable>
    <Status>Finished</Status>
    <BackupMode>FULL</BackupMode> 
    <Description>Api description</Description> 
  </Items> 
</DescribeOssDownloadsResponse>

JSON format 

{
	"Items":{
		"FileSize":"2MB",
		"Status":"Finished",
		"IsAvailable":"True",
		"Description":"Api description",
		"FileName":"test",
		"CreateTime":"2017-05-30 T12:11:4Z",
		"BackupMode":"FULL"
	},
	"MigrateTaskId":"562154852",
	"DBInstanceId":"rm-uf6wjk5xxxxxxx",
	"RequestId":"A5409D02-D661-4BF3-8F3D-0A814D0574E7"
}

Error codes

View error codes