DescribeBackupSetDownloadLink - ApsaraDB for OceanBase - Alibaba Cloud Documentation Center

You can call this operation to query the link for downloading a backup set of OceanBase Database.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the OceanBase cluster.	ob317v4uif****
DownloadTaskId	string	Yes	The ID of the download task corresponding to the target backup set.	1000002

Response parameters

Parameter	Type	Description	Example
	object	The return result of the request.
RequestId	string	The ID of the request.	EE205C00-30E4-**-**-87E3A8A2AA0C
Data	object	The returned data.
DownloadTaskId	long	The ID of the download task corresponding to the target backup set.	1000002
DownloadTaskStatus	string	The status of the download task corresponding to the target backup set.	RUNNING
DownloadTaskCreateTime	string	The time when the download task corresponding to the target backup set was created.	2020-05-22T17:04:18
BackupRestorableTime	string	The restorable time of the backup set.	yyyy-MM-dd HH:mm:ss
BackupSetId	string	The ID of the target backup set.	bak-4n****gacpa8
InternalUrl	string	The internal URL.	http://bucket.oss-region-internal.aliyuncs.com/xxxxx
UrlExpiredTime	string	The expiration time of the URL.	2024-01-04 17:39:49
UrlAliveTime	long	The validity period of the URL, in seconds.	3600

Examples

Sample success responses

JSONformat

{
  "RequestId": "EE205C00-30E4-****-****-87E3A8A2AA0C",
  "Data": {
    "DownloadTaskId": 1000002,
    "DownloadTaskStatus": "RUNNING",
    "DownloadTaskCreateTime": "2020-05-22T17:04:18",
    "BackupRestorableTime": "yyyy-MM-dd HH:mm:ss",
    "BackupSetId": "bak-4n****gacpa8",
    "InternalUrl": "http://bucket.oss-region-internal.aliyuncs.com/xxxxx",
    "UrlExpiredTime": "2024-01-04 17:39:49",
    "UrlAliveTime": 3600
  }
}

Error codes

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