文档

DescribeBackupSetDownloadTaskList - 查看备份集下载列表

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

调试

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

授权信息

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

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

请求参数

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

备份计划 ID,可通过调用 DescribeBackupPlanList 接口获取该参数的值。

说明 BackupPlanIdBackupSetDownloadTaskId 任选其一作为请求参数必填项。
dbsqhnuhyw3****
BackupSetDownloadTaskIdstring

备份集下载任务 ID。

urxgrxt7****
PageSizeinteger

每页的记录数,取值 30、50、100。

说明 默认每页记录数为 30。
30
PageNuminteger

页码,大于等于 0 且不超过 Integer 的最大值,默认值为 0。

1
ClientTokenstring

输入任意值,用于保证请求的幂等性,防止重复提交请求。

ETnLKlblzczshOTUbOCzXXXXXX

返回参数

名称类型描述示例值
object

返回参数详情信息。

HttpStatusCodeinteger

HTTP 状态码。

200
PageNuminteger

页码。

0
RequestIdstring

请求 ID。

6DC3D286-E0E6-5988-A558-2184984B****
ErrCodestring

错误码。

Param.NotFound
Successboolean

请求是否成功,返回值如下:

  • true:请求成功
  • false:请求失败
true
ErrMessagestring

错误信息。

The specified parameter %s value is not valid.
TotalPagesinteger

总页数。

1
TotalElementsinteger

总备份集下载记录数。

1
PageSizeinteger

每页的记录数。

30
Itemsobject []

备份计划详情。

BackupSetDownloadStatusstring

备份集下载状态,返回值如下:

  • checking:预检查中
  • init:预检查失败(未启动)
  • check_pass:预检查通过
  • pause:暂停
  • schedule:等待调度
  • running:运行中
  • stop:失败
  • finish:完成
finish
BackupSetDataSizelong

备份集数据大小。

237837
BackupSetDownloadTargetTypestring

备份集下载目标类型。

说明 仅自动下载显示,agent 表示已安装备份网关。
BackupSetDownloadDirstring

备份集下载服务器目录。

说明 仅自动下载有值。
ErrMessagestring

异常信息。

java.lang.IndexOutOfBoundsException.
BackupSetDownloadCreateTimelong

创建时间戳。

1642044001000
BackupPlanIdstring

备份计划 ID。

qhnuhyw3****
BackupSetDbTypestring

数据库类型。

MySQL
BackupSetDownloadInternetUrlstring

备份集公网下载地址。

说明 仅手工下载类型,且转换完成的有值。
"//dbs-137XXXX-cn-hangzhou-1hr5cpbtmXXXX.oss-cn-hangzhou.example"
BackupSetIdstring

源备份集 ID。

1h7za2yws****
BackupSetDownloadIntranetUrlstring

备份集内网下载地址。

说明 仅手工下载类型,且转换完成的有值。
"//dbs-13XXXX-cn-hangzhou-1hr5cpbtmXXXX.oss-cn-hangzhou-internal.example"
BackupGatewayIdlong

备份集备份网关,仅自动下载有值。

BackupSetDownloadWaystring

下载类型,返回值如下:

  • manual:手工
  • auto:自动
manual
BackupSetDownloadFinishTimelong

完成时间戳。

1642044013000
BackupSetJobTypestring

源备份集任务类型,返回值如下:

  • cbs_backup_sub_full:逻辑全量任务
  • cbs_backup_sub_cont:逻辑增量任务
cbs_backup_sub_cont
BackupSetDownloadTaskIdstring

备份集下载任务 ID。

urxgrxt7****
BackupSetDownloadTaskNamestring

备份集下载任务名称。

1h7za2yws****-ManualCont
BackupSetDataFormatstring

备份集下载数据格式,取值如下:

  • Native
  • SQL
  • CSV
  • JSON
Native
BackupSetCodestring

源备份集编码。

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错误码错误信息描述
403Request.ForbiddenHave no Permissions当前操作未被授权,请联系主账号在RAM控制台进行授权后再执行操作

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

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (1)