DescribeOssDownloads - ApsaraDB RDS - Alibaba Cloud Documentation Center

Queries the backup files that are included in a backup data migration task of an ApsaraDB RDS for SQL Server instance.

Operation description

Supported database engines

SQL Server

Usage notes

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

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
rds:DescribeOssDownloads	READ	DBInstance acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	rds:ResourceTag	none

Request parameters

Parameter	Type	Required	Description	Example
DBInstanceId	string	Yes	The instance ID. You can call the DescribeDBInstances operation to query the instance ID.	rm-uf6wjk5xxxxxxx
MigrateTaskId	string	Yes	The migration task ID. You can call the DescribeMigrateTasks operation to query the migration task ID.	5625458541
ResourceGroupId	string	No	The ID of the resource group.	rg-acfmy*****

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
DBInstanceId	string	The instance ID.	rm-uf6wjk5xxxxxxx
RequestId	string	The request ID.	A5409D02-D661-4BF3-8F3D-0A814D0574E7
MigrateTaskId	string	The ID of the migration task.	562154852
Items	object []	Details of the backup file.
EndTime	string	The end of the time range during which data was queried. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2017-08-27T12:45:15Z
Status	string	The state of the backup file. Valid values: NoStart Downloading Finished DownloadFailed VerifyFailed Deleted DeleteFailed CheckSuccess CheckFailed Restoring Restored RestoreFailed	Finished
Description	string	The description of the backup file.	App description
CreateTime	string	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.	2017-08-17T12:45:15Z
BackupMode	string	The backup type. Valid values: Database: full backup file Differential_Database: incremental backup file Transaction_Log: log backup file	Database
IsAvailable	string	Indicates whether the backup file is available. Valid values: True and False.	True
FileName	string	The name of the backup file stored in the Object Storage Service (OSS) bucket.	test
FileSize	string	The size of the backup file. Unit: MB	2

Examples

Sample success responses

JSONformat

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

Error codes

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

Change history

Change time

Summary of changes

Operation

2022-08-04

The request parameters of the API has changed

see changesets

Change item	Change content
Input Parameters	The request parameters of the API has changed.
	Added Input Parameters: ResourceGroupId