使用DescribeDownloadBackupSetStorageInfo获取下载备份集的存储信息-数据管理 DMS-阿里云

接口说明

适用引擎

RDS MySQL（云盘系列）
RDS PostgreSQL
PolarDB MySQL 版

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

dbs:DescribeDownloadBackupSetStorageInfo

get

*BackupPlan

acs:dbs:{#regionId}:{#accountId}:backupplan/{#BackupPlanId}

无

请求参数

名称	类型	必填	描述	示例值
RegionCode	string	是	实例所在地域 ID。	cn-hangzhou
Duration	string	是	下载目标为 URL 时，设置链接有效时长。默认 URL 有效时长为 2 小时（7200 秒）。有效时长范围可设置 5 分钟（300 秒）~1 天（86400 秒）。请转化为秒（s）后传入该值，例如设置链接有效时长为 5 分钟时，传入 300。	300
InstanceName	string	否	实例 ID。说明如果您填写了 InstanceName，也需填写 BackupSetId。	rm-uf6qqf569n435****
TaskId	string	否	下载任务 ID。如果不填写任务 TaskId，则需要填写 BackupSetId 和 InstanceName。您可在单击目标实例中的备份恢复，在备份下载页签下查看任务 ID。	dt-s0ugzak9****
BackupSetId	string	否	备份集 ID。	30****
ClusterName	string	否		dds-example

返回参数

名称	类型	描述	示例值
	object	返回值如下。
RequestId	string	请求 ID。	44B8C2F5-919D-5D29-BCD5-DEB03467****
ErrCode	string	错误码。	DBS.ParamIsInValid
Success	string	是否执行成功。返回值： true：执行成功 false：执行失败	true
ErrMessage	string	错误信息。	Argument: regionCode Must not be empty
Code	string	错误码。	DBS.ParamIsInValid
Message	string	错误信息。	Argument: regionCode Must not be empty
Data	object	返回数据如下。
PublicUrl	string	备份集公网下载地址。	http://dbs-137383785969**-cn-hangzhou-1iv12nblw.oss-cn-hangzhou.aliyuncs.com/dt-u7u4bufa**/dbs_target_file_path/test_456
PrivateUrl	string	备份集私网下载地址。	http://dbs-137383785969**-cn-hangzhou-1iv12nblw.oss-cn-hangzhou-internal.aliyuncs.com/dt-u7u4bufa**/dbs_target_file_path/test_123
ExpirationTime	integer	链接有效期。说明返回值为时间戳形式。	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
  }
}

错误码

HTTP status code	错误码	错误信息	描述
403	Request.Forbidden	Have no Permissions	当前操作未被授权，请联系主账号在RAM控制台进行授权后再执行操作

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

变更历史

更多信息，参考变更详情。

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