首页 云数据库 RDS 开发参考 API参考 API目录 MySQL备份文件上云 ListUserBackupFiles - 查询用户备份信息

ListUserBackupFiles - 查询用户备份信息

更新时间: 2023-11-30 12:33:21

该接口用于查询所有已导入至RDS的用户备份的详情。

接口说明

适用引擎

  • RDS MySQL

功能说明

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

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

通过用户备份文件的状态查询目标用户备份。取值:

  • Importing:导入中。
  • Failed:导入失败。
  • CheckSuccess:校验通过。
  • BackupSuccess:导入成功。
  • Deleted:已删除。
CheckSuccess
RegionIdstring

地域ID。可调用DescribeRegions获取。

cn-hangzhou
Commentstring

通过备注信息查询目标用户备份。

说明 您可输入目标用户备份的部分备注信息进行模糊匹配。
BackupTest
BackupIdstring

通过用户备份ID查询目标用户备份。

b-kwwvr7v8t7of****
OssUrlstring

通过用户备份文件的OSS下载地址查询目标用户备份。如何获取用户备份文件的OSS下载地址,请参见上传Object后如何获取访问URL

https://****.oss-ap-****.aliyuncs.com/backup_qp.xb
Tagsstring

通过标签信息查询目标用户备份。

key1:value1
ResourceGroupIdstring

资源组ID。可调用DescribeDBInstanceAttribute获取。

rg-acfmy****

返回参数

名称类型描述示例值
object

返回参数详情。

RequestIdstring

请求ID。

AD67C22F-64F3-4448-A9A8-D1606D242879
Recordsobject []

用户备份文件详情列表。

Statusstring

用户备份文件状态。返回值:

  • Importing:导入中。
  • Failed:导入失败。
  • CheckSuccess:校验通过。
  • BackupSuccess:导入成功。
  • Deleted:已删除。
BackupSuccess
CreationTimestring

用户备份的导入开始时间,格式为Unix时间戳。单位:毫秒。

1623231084000
FinishTimestring

用户备份成功导入的时间,格式为Unix时间戳。单位:毫秒。

1623231750000
Commentstring

用户备份的备注信息。

BackupTest
OssFilePathstring

OSS中用户备份文件的路径。

test/backup_qp.xb
OssBucketstring

用户备份文件所在的OSS Bucket名称。

BackupTest
ModificationTimestring

用户备份的导入完成时间,格式为Unix时间戳。单位:毫秒。

1623231750000
OssFileSizelong

OSS中用户备份文件的大小。单位:KB。

79115
OssFileNamestring

OSS中用户备份文件的文件名。

backup_qp.xb
EngineVersionstring

数据库版本。

5.7
BackupIdstring

用户备份ID。

b-kwwvr7v8t7of****
RestoreSizestring

还原用户备份所需存储空间大小。单位:GB。

20
ZoneIdstring

用户备份所在的可用区ID。

cn-hangzhou-b
Retentioninteger

用户备份文件保留时长。单位:天。

3
Enginestring

数据库引擎。

mysql
OssUrlstring

用户备份文件的OSS下载地址。

https://****.oss-ap-****.aliyuncs.com/backup_qp.xb
OssFileMetaDatastring

用户备份文件元信息。更多信息,请参见管理文件元信息

{\"Accept-Ranges\":\"bytes\",\"Connection\":\"keep-alive\",\"Content-Length\":81014337,\"Content-Type\":\"application/octet-stream\",\"Date\":1623309548000,\"ETag\":\"889FE9E5FCEBFE4781829488A352863B-1\",\"Last-Modified\":1622186844000,\"Server\":\"AliyunOSS\",\"x-oss-hash-crc64ecma\":\"5793608435727323129\",\"x-oss-object-type\":\"Multipart\",\"x-oss-request-id\":\"60C1BCEC92572F37318BD499\",\"x-oss-server-time\":\"166\",\"x-oss-storage-class\":\"Standard\"}
BinlogInfostring

备份文件中的Binlog文件信息,备份过程中如有增量内容则会返回此参数。

{\"binlogPosition\":\"154\",\"binlogFile\":\"0.000002\"}
Reasonstring

用户备份文件导入失败的原因。

success

示例

正常返回示例

JSON格式

{
  "RequestId": "AD67C22F-64F3-4448-A9A8-D1606D242879",
  "Records": [
    {
      "Status": "BackupSuccess",
      "CreationTime": "1623231084000",
      "FinishTime": "1623231750000",
      "Comment": "BackupTest",
      "OssFilePath": "test/backup_qp.xb",
      "OssBucket": "BackupTest",
      "ModificationTime": "1623231750000",
      "OssFileSize": 79115,
      "OssFileName": "backup_qp.xb",
      "EngineVersion": "5.7",
      "BackupId": "b-kwwvr7v8t7of****",
      "RestoreSize": "20",
      "ZoneId": "cn-hangzhou-b",
      "Retention": 3,
      "Engine": "mysql",
      "OssUrl": "https://****.oss-ap-****.aliyuncs.com/backup_qp.xb",
      "OssFileMetaData": "{\\\"Accept-Ranges\\\":\\\"bytes\\\",\\\"Connection\\\":\\\"keep-alive\\\",\\\"Content-Length\\\":81014337,\\\"Content-Type\\\":\\\"application/octet-stream\\\",\\\"Date\\\":1623309548000,\\\"ETag\\\":\\\"889FE9E5FCEBFE4781829488A352863B-1\\\",\\\"Last-Modified\\\":1622186844000,\\\"Server\\\":\\\"AliyunOSS\\\",\\\"x-oss-hash-crc64ecma\\\":\\\"5793608435727323129\\\",\\\"x-oss-object-type\\\":\\\"Multipart\\\",\\\"x-oss-request-id\\\":\\\"60C1BCEC92572F37318BD499\\\",\\\"x-oss-server-time\\\":\\\"166\\\",\\\"x-oss-storage-class\\\":\\\"Standard\\\"}",
      "BinlogInfo": "{\\\"binlogPosition\\\":\\\"154\\\",\\\"binlogFile\\\":\\\"0.000002\\\"}",
      "Reason": "success"
    }
  ]
}

错误码

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

变更历史

变更时间变更内容概要操作
2023-07-25OpenAPI 入参发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:ResourceGroupId
2022-06-23OpenAPI 描述信息更新看变更集
变更项变更内容
API 描述OpenAPI 描述信息更新
阿里云首页 云数据库 RDS 相关技术圈