首页 数据库备份 DBS API参考(2021-01-01) API目录 高级下载 DescribeDownloadBackupSetStorageInfo - 查看下载备份集的存储信息

DescribeDownloadBackupSetStorageInfo - 查看下载备份集的存储信息

调用DescribeDownloadBackupSetStorageInfo接口查看下载备份集的存储信息。

接口说明

您可以按任意时间点或按指定备份集创建高级下载任务,并支持选择下载目标为URL或直接将数据写入您的OSS中,后续方便您进行数据分析以及离线归档。功能详情,请参见高级下载

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
dbs:DescribeDownloadBackupSetStorageInfoRead
  • DBS
    acs:dbs:{#regionId}:{#accountId}:backupplan/{#BackupPlanId}

请求参数

名称类型必填描述示例值
RegionCodestring

实例所在地域ID,您可以调用DescribeDBInstanceAttribute查询。

cn-hangzhou
Durationstring

下载目标为URL时,设置链接有效时长。

  • 默认URL有效时长为2小时(7200秒)。
  • 有效时长范围可设置5分钟(300秒)~1天(86400秒)。
  • 请转化为秒(s)后传入该值,例如设置链接有效时长为5分钟时,传入300。
300
InstanceNamestring

实例ID。

说明如果您填写了InstanceName,也需填写BackupSetId
rm-uf6qqf569n435****
TaskIdstring

下载任务ID。

  • 如果不填写任务下载任务ID(TaskId),则需要填写BackupSetIdInstanceName
  • 您可在单击目标实例中的备份恢复,在备份下载页签下查看任务ID
dt-s0ugzak9****
BackupSetIdstring

备份集ID。

30****

返回参数

名称类型描述示例值
object

返回值如下。

RequestIdstring

请求ID。

44B8C2F5-919D-5D29-BCD5-DEB03467****
ErrCodestring

错误码。

DBS.ParamIsInValid
Successstring

是否执行成功。返回值:

  • true:执行成功
  • false:执行失败
true
ErrMessagestring

错误信息。

Argument: regionCode Must not be empty
Codestring

错误码。

DBS.ParamIsInValid
Messagestring

错误信息。

Argument: regionCode Must not be empty
Dataobject

返回数据如下。

PublicUrlstring

备份集公网下载地址。

http://dbs-137383785969****-cn-hangzhou-1iv12nblw****.oss-cn-hangzhou.aliyuncs.com/dt-u7u4bufa****/dbs_target_file_path/test_456
PrivateUrlstring

备份集私网下载地址。

http://dbs-137383785969****-cn-hangzhou-1iv12nblw****.oss-cn-hangzhou-internal.aliyuncs.com/dt-u7u4bufa****/dbs_target_file_path/test_123
ExpirationTimelong

链接有效期。

说明返回值为时间戳形式。
1661329050

示例

正常返回示例

JSON格式

{
  "RequestId": "44B8C2F5-919D-5D29-BCD5-DEB03467****",
  "ErrCode": "DBS.ParamIsInValid",
  "Success": "true",
  "ErrMessage": "Argument: regionCode Must not be empty",
  "Code": "DBS.ParamIsInValid",
  "Message": "Argument: regionCode Must not be empty",
  "Data": {
    "PublicUrl": "http://dbs-137383785969****-cn-hangzhou-1iv12nblw****.oss-cn-hangzhou.aliyuncs.com/dt-u7u4bufa****/dbs_target_file_path/test_456",
    "PrivateUrl": "http://dbs-137383785969****-cn-hangzhou-1iv12nblw****.oss-cn-hangzhou-internal.aliyuncs.com/dt-u7u4bufa****/dbs_target_file_path/test_123",
    "ExpirationTime": 1661329050
  }
}

错误码

访问错误中心查看更多错误码。

阿里云首页 数据库备份 DBS 相关技术圈