DescribeBackupSetDownloadTaskList - 查看备份集下载列表 - 数据库备份 DBS

该接口用于查看DBS备份集下载列表。

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
dbs:DescribeBackupSetDownloadTaskList	get	全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
BackupPlanId	string	否	备份计划 ID，可通过调用 DescribeBackupPlanList 接口获取该参数的值。说明 BackupPlanId 或 BackupSetDownloadTaskId 任选其一作为请求参数必填项。	dbsqhnuhyw3****
BackupSetDownloadTaskId	string	否	备份集下载任务 ID。全量备份：可通过调用 CreateFullBackupSetDownload 接口获取该参数的值。增量备份：可通过调用 CreateIncrementBackupSetDownload 接口获取该参数的值。	urxgrxt7****
PageSize	integer	否	每页的记录数，取值 30、50、100。说明默认每页记录数为 30。	30
PageNum	integer	否	页码，大于等于 0 且不超过 Integer 的最大值，默认值为 0。	1
ClientToken	string	否	输入任意值，用于保证请求的幂等性，防止重复提交请求。	ETnLKlblzczshOTUbOCzXXXXXX

返回参数

名称	类型	描述	示例值
	object	返回参数详情信息。
HttpStatusCode	integer	HTTP 状态码。	200
PageNum	integer	页码。	0
RequestId	string	请求 ID。	6DC3D286-E0E6-5988-A558-2184984B****
ErrCode	string	错误码。	Param.NotFound
Success	boolean	请求是否成功，返回值如下： true：请求成功 false：请求失败	true
ErrMessage	string	错误信息。	The specified parameter %s value is not valid.
TotalPages	integer	总页数。	1
TotalElements	integer	总备份集下载记录数。	1
PageSize	integer	每页的记录数。	30
Items	array<object>	备份计划详情。
BackupSetDownloadTaskDetail	object	备份计划详情。
BackupSetDownloadStatus	string	备份集下载状态，返回值如下： checking：预检查中 init：预检查失败（未启动） check_pass：预检查通过 pause：暂停 schedule：等待调度 running：运行中 stop：失败 finish：完成	finish
BackupSetDataSize	long	备份集数据大小。	237837
BackupSetDownloadTargetType	string	备份集下载目标类型。说明仅自动下载显示，agent 表示已安装备份网关。	无
BackupSetDownloadDir	string	备份集下载服务器目录。说明仅自动下载有值。	无
ErrMessage	string	异常信息。	java.lang.IndexOutOfBoundsException.
BackupSetDownloadCreateTime	long	创建时间戳。	1642044001000
BackupPlanId	string	备份计划 ID。	qhnuhyw3****
BackupSetDbType	string	数据库类型。	MySQL
BackupSetDownloadInternetUrl	string	备份集公网下载地址。说明仅手工下载类型，且转换完成的有值。	"//dbs-137XXXX-cn-hangzhou-1hr5cpbtmXXXX.oss-cn-hangzhou.example"
BackupSetId	string	源备份集 ID。	1h7za2yws****
BackupSetDownloadIntranetUrl	string	备份集内网下载地址。说明仅手工下载类型，且转换完成的有值。	"//dbs-13XXXX-cn-hangzhou-1hr5cpbtmXXXX.oss-cn-hangzhou-internal.example"
BackupGatewayId	long	备份集备份网关，仅自动下载有值。	无
BackupSetDownloadWay	string	下载类型，返回值如下： manual：手工 auto：自动	manual
BackupSetDownloadFinishTime	long	完成时间戳。	1642044013000
BackupSetJobType	string	源备份集任务类型，返回值如下： cbs_backup_sub_full：逻辑全量任务 cbs_backup_sub_cont：逻辑增量任务	cbs_backup_sub_cont
BackupSetDownloadTaskId	string	备份集下载任务 ID。	urxgrxt7****
BackupSetDownloadTaskName	string	备份集下载任务名称。	1h7za2yws****-ManualCont
BackupSetDataFormat	string	备份集下载数据格式，取值如下： Native SQL CSV JSON	Native
BackupSetCode	string	源备份集编码。	mysql-bin.00XXXX

示例

正常返回示例

JSON格式

{
  "HttpStatusCode": 200,
  "PageNum": 0,
  "RequestId": "6DC3D286-E0E6-5988-A558-2184984B****",
  "ErrCode": "Param.NotFound",
  "Success": true,
  "ErrMessage": "The specified parameter %s value is not valid.",
  "TotalPages": 1,
  "TotalElements": 1,
  "PageSize": 30,
  "Items": {
    "BackupSetDownloadTaskDetail": [
      {
        "BackupSetDownloadStatus": "finish",
        "BackupSetDataSize": 237837,
        "BackupSetDownloadTargetType": "无",
        "BackupSetDownloadDir": "无",
        "ErrMessage": "java.lang.IndexOutOfBoundsException.",
        "BackupSetDownloadCreateTime": 1642044001000,
        "BackupPlanId": "qhnuhyw3****",
        "BackupSetDbType": "MySQL",
        "BackupSetDownloadInternetUrl": "\"//dbs-137XXXX-cn-hangzhou-1hr5cpbtmXXXX.oss-cn-hangzhou.example\"",
        "BackupSetId": "1h7za2yws****",
        "BackupSetDownloadIntranetUrl": "\"//dbs-13XXXX-cn-hangzhou-1hr5cpbtmXXXX.oss-cn-hangzhou-internal.example\"",
        "BackupGatewayId": 0,
        "BackupSetDownloadWay": "manual",
        "BackupSetDownloadFinishTime": 1642044013000,
        "BackupSetJobType": "cbs_backup_sub_cont",
        "BackupSetDownloadTaskId": "urxgrxt7****",
        "BackupSetDownloadTaskName": "1h7za2yws****-ManualCont",
        "BackupSetDataFormat": "Native",
        "BackupSetCode": "mysql-bin.00XXXX"
      }
    ]
  }
}

错误码

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

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

变更历史

变更时间	变更内容概要	操作

暂无变更历史