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

说明

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String ListUserBackupFiles

系统规定参数。取值:ListUserBackupFiles

RegionId String cn-hangzhou

地域ID。可调用DescribeRegions获取。

Status String CheckSuccess

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

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

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

说明 您可输入目标用户备份的部分备注信息进行模糊匹配。
BackupId String b-kwwvr7v8t7of********

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

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

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

Tags String key1:value1

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

返回数据

名称 类型 示例值 描述
Records Array of Records

由用户备份文件信息组成的数组。

BackupId String b-kwwvr7v8t7of********

用户备份ID。

BinlogInfo String {\"binlogPosition\":\"154\",\"binlogFile\":\"0.000002\"}

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

Comment String BackupTest

用户备份的备注信息。

CreationTime String 1623231084000

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

Engine String mysql

数据库引擎。

EngineVersion String 5.7

数据库版本。

ModificationTime String 1623231750000

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

OssBucket String BackupTest

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

OssFileMetaData String {\"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\"}

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

OssFileName String backup_qp.xb

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

OssFilePath String test/backup_qp.xb

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

OssFileSize Long 79115

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

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

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

Reason String success

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

RestoreSize String 20

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

Retention Integer 3

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

Status String BackupSuccess

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

  • Importing:导入中。
  • Failed:导入失败。
  • CheckSuccess:校验通过。
  • BackupSuccess:导入成功。
  • Deleted:已删除。
ZoneId String cn-hangzhou-b

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

RequestId String AD67C22F-64F3-4448-A9A8-D1606D242879

请求ID。

示例

请求示例

http(s)://rds.aliyuncs.com/?Action=ListUserBackupFiles
&RegionId=cn-hangzhou
&<公共请求参数>

正常返回示例

XML格式

<ListUserBackupFilesResponse>
  <RequestId>9FB29A6E-C63A-4810-B71D-AFC65FD66309</RequestId>
  <Records>
        <Status>BackupSuccess</Status>
        <Comment>b-c8677aw89jo7********</Comment>
        <EngineVersion>5.7</EngineVersion>
        <OssBucket>ghjtest</OssBucket>
        <BackupId>b-c8677aw89jo7********</BackupId>
        <ModificationTime>1623310685000</ModificationTime>
        <Retention>3</Retention>
        <OssFileMetaData>{"Accept-Ranges":"bytes","Connection":"keep-alive","Content-Length":81014337,"Content-MD5":"WBKyX0RbaSVjiwINUgEuTA==","Content-Type":"application/octet-stream","Date":1623310682000,"ETag":"5812B25F445B6925638B020D52012E4C","Last-Modified":1623310648000,"Server":"AliyunOSS","x-oss-hash-crc64ecma":"5793608435727323129","x-oss-object-type":"Normal","x-oss-request-id":"60C1C15AA846BB3737811ED8","x-oss-server-time":"17","x-oss-storage-class":"Standard"}</OssFileMetaData>
        <CreationTime>1623310685000</CreationTime>
        <OssUrl>https://******.oss-ap-********.aliyuncs.com/backup_qp.xb</OssUrl>
        <OssFileName>backup_qp.xb</OssFileName>
        <RestoreSize>20</RestoreSize>
        <OssFileSize>79115</OssFileSize>
        <Engine>mysql</Engine>
        <OssFilePath>test/backup_qp.xb</OssFilePath>
  </Records>
</ListUserBackupFilesResponse>

JSON格式

{  
  "RequestId": "9FB29A6E-C63A-4810-B71D-AFC65FD66309",
  "Records": [
    {
      "Status": "BackupSuccess",
      "Comment": "b-c8677aw89jo7********",
      "EngineVersion": "5.7",
      "OssBucket": "ghjtest",
      "BackupId": "b-c8677aw89jo7********",
      "ModificationTime": 1623310685000,
      "Retention": 3,
      "OssFileMetaData": "{\"Accept-Ranges\":\"bytes\",\"Connection\":\"keep-alive\",\"Content-Length\":81014337,\"Content-MD5\":\"WBKyX0RbaSVjiwINUgEuTA==\",\"Content-Type\":\"application/octet-stream\",\"Date\":1623310682000,\"ETag\":\"5812B25F445B6925638B020D52012E4C\",\"Last-Modified\":1623310648000,\"Server\":\"AliyunOSS\",\"x-oss-hash-crc64ecma\":\"5793608435727323129\",\"x-oss-object-type\":\"Normal\",\"x-oss-request-id\":\"60C1C15AA846BB3737811ED8\",\"x-oss-server-time\":\"17\",\"x-oss-storage-class\":\"Standard\"}",
      "CreationTime": 1623310685000,
      "OssUrl": "https://******.oss-ap-********.aliyuncs.com/backup_qp.xb",
      "OssFileName": "backup_qp.xb",
      "RestoreSize": 20,
      "OssFileSize": 79115,
      "Engine": "mysql",
      "OssFilePath": "test/backup_qp.xb"
    }
  ]
}

错误码

HttpCode 错误码 错误信息 描述
400 OperationDenied.Product The product code is not supported. 不支持产品代码

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