使用DescribeFullBackupList API查询全量备份任务列表-数据管理 DMS-阿里云-数据管理 DMS-阿里云帮助中心

该接口用于查看DBS全量备份任务列表。

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

dbs:DescribeFullBackupList

get

*BackupPlan

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

无

请求参数

名称	类型	必填	描述	示例值
BackupPlanId	string	是	备份计划 ID。	dbsr179qz******
PageSize	integer	否	每页的记录数，取值： 30 50 100 默认为 30。	30
PageNum	integer	否	页码，大于等于 0 且不超过 Integer 的最大值，默认值为：0。	1
ClientToken	string	否	用于保证请求的幂等性，防止重复提交请求。	ETnLKlblzczshOTUbOCzxxxxxxx
ShowStorageType	boolean	否	是否显示存储类型。	true
BackupSetId	string	否	备份集 ID。	1iukx5h******
StartTimestamp	integer	否	开始备份时间。	1676887100
EndTimestamp	integer	否	结束备份时间。	1676887128
ShowProgress	string	否	是否展示备份进度	true
BackupSetStatus	string	否	备份集状态	finish

返回参数

名称	类型	描述	示例值
	object	返回参数详情如下。
HttpStatusCode	integer	HTTP 状态码。	200
PageNum	integer	页码。	1
RequestId	string	请求 ID。	636BC118-6080-4119-A6B5-C199CEC1037D
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	每页的记录数。	10
Items	object
FullBackupFile	array<object>	全量备份任务详情。
	object	全量备份任务详情。
FinishTime	integer	任务结束时间戳。	1676887128000
BackupStatus	string	备份任务状态，取值： schedule：初始化中 running：运行中 finish：完成 stop：失败 pause：暂停	finish
SourceEndpointIpPort	string	数据库连接地址。	121.XXX.XXX.144:3306
CreateTime	integer	任务开始时间戳。	1676886947000
ErrMessage	string	错误信息。	NULL
BackupObjects	string	备份对象。	[{\"DBName\":\"test\"}]
EndTime	integer	备份结束时间戳。	1676887128000
StartTime	integer	备份开始时间。	1676887100000
BackupSetExpiredTime	integer	备份集保留到期时间戳。	1677491900000
StorageMethod	string	存储类型，取值： Standard：标准存储 IA：低频访问存储 Archive：归档存储 UNKNOWN：未知，通常是任务未完成时的状态	Standard
BackupSetId	string	备份集 ID。	1iukx5h******
BackupSize	integer	备份大小。	580
SourceEndpointInstanceType	string	备份源数据库实例类型	rds
SourceEndpointInstanceId	string	备份源数据库实例 Id	rm-testxx
SourceEndpointRegion	string	备份源数据库所在地域	cn-beijing
SourceEndpointHost	string	备份源数据库连接地址	127.0.0.1
StorageEncryptMethod	string	备份存储加密方式	encrypted
CrossRoleName	string	跨账号备份 RAM 角色名称	ram-for-dbs
CrossAliyunId	string	跨账号备份阿里云 Id	2xxx7778xxxxxxxxxx
SourceEndpointEnableSsl	string	备份源数据库是否开启 SSL 安全连接	true
LogicalStructureBackupProgress	integer	逻辑备份结构备份进度	100
LogicalFullBackupProgress	integer	逻辑备份全量备份进度	100
BackupGatewayIdentifier	string	备份网关唯一标识码	TESTGATEWAY
SourceEndpointUserName	string	备份源数据库账号	dbs_backup
SourceEndpointPort	string	备份源数据库端口	3306

示例

正常返回示例

JSON格式

{
  "HttpStatusCode": 200,
  "PageNum": 1,
  "RequestId": "636BC118-6080-4119-A6B5-C199CEC1037D",
  "ErrCode": "Param.NotFound",
  "Success": true,
  "ErrMessage": "The specified parameter %s value is not valid.     ",
  "TotalPages": 1,
  "TotalElements": 1,
  "PageSize": 10,
  "Items": {
    "FullBackupFile": [
      {
        "FinishTime": 1676887128000,
        "BackupStatus": "finish",
        "SourceEndpointIpPort": "121.XXX.XXX.144:3306",
        "CreateTime": 1676886947000,
        "ErrMessage": "NULL",
        "BackupObjects": "[{\\\"DBName\\\":\\\"test\\\"}]",
        "EndTime": 1676887128000,
        "StartTime": 1676887100000,
        "BackupSetExpiredTime": 1677491900000,
        "StorageMethod": "Standard",
        "BackupSetId": "1iukx5h******",
        "BackupSize": 580,
        "SourceEndpointInstanceType": "rds",
        "SourceEndpointInstanceId": "rm-testxx",
        "SourceEndpointRegion": "cn-beijing",
        "SourceEndpointHost": "127.0.0.1",
        "StorageEncryptMethod": "encrypted",
        "CrossRoleName": "ram-for-dbs",
        "CrossAliyunId": "2xxx7778xxxxxxxxxx",
        "SourceEndpointEnableSsl": "true",
        "LogicalStructureBackupProgress": 100,
        "LogicalFullBackupProgress": 100,
        "BackupGatewayIdentifier": "TESTGATEWAY",
        "SourceEndpointUserName": "dbs_backup",
        "SourceEndpointPort": "3306"
      }
    ]
  }
}

错误码

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

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

变更历史

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