You need to enable JavaScript to run this app.
导航
云数据库 MySQL 版
  • 文档首页
    • /
  • 云数据库 MySQL 版

ListBackups

最近更新时间：2023.02.13 20:34:43

首次发布时间：2021.11.29 21:10:03

我的收藏

调用 ListBackups 接口查询备份集列表。

请求类型

同步请求。

请求参数

名称类型是否必选示例值描述
OffsetInteger否0当前页查询偏移量。
LimitInteger否10每页记录数，取值：大于 0 且不超过 Integer 的最大值。

InstanceId

String

是

rds-mysql-h441603c68aaa****

实例 ID。

说明

您可以调用ListDBInstances接口查询实例信息，包括实例 ID 。

StartTime

String

否

2020-01-01 00:00:00

备份创建的开始时间，格式： yyyy-MM-dd HH:mm:ss （ UTC 时间）。

说明

  • 若设置了该参数，备份创建的最晚时间（即 EndTime）参数也必填。
  • 若该参数留空，默认返回当前实例下已存在的所有备份集信息。

EndTime

String

否

2020-01-01 00:00:10

备份创建的最晚时间，格式： yyyy-MM-dd HH:mm:ss （ UTC 时间）。

说明

  • 若设置了创建开始时间（即StartTime），该参数必填。
  • 创建最晚时间需晚于创建开始时间。
BackupStatusString否Success备份状态，取值：
  • Success：成功。
  • Failed：失败。
  • Running：执行中。
    • BackupDataTypeString否Data备份数据类型。取值：
  • Data：数据备份。
  • Log：日志备份。

    • 返回参数

    参数
    		类型示例值描述
    TotalInteger1备份总数。
    DatasArray of BackupInfo[
    {
    "BackupId": "990e1fa0df8b4aadb45f00ad00abff9d",
    "BackupStatus": "Success",
    "BackupType": "Physical",
    "BackupMode": "Full",
    "BackupStrategy": "Instance",
    "CreateType": "System",
    "BackupFileName": "full-1638021415869047766-1638021600436875578.xbstream",
    "BackupFileSize": 6831562,
    "BackupStartTime": "2021-12-02 10:00:00",
    "BackupEndTime": "2021-12-02 10:00:10"
    }    		备份列表。关于 Backups 的详细信息，请参见数据结构。

    请求示例

    POST /?Action=ListBackups&Version=2018-01-01 HTTP/1.1
Content-Type: application/json
Host: rds.volcengineapi.com
X-Date: 20211202T101010Z
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20211202/cn-beijing/rds_mysql/request, SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c645af****

{
    "Offset" : 0,
    "Limit" : 10,
    "InstanceId" : "rds-mysql-h441603c68aaa****",
    "StartTime" : "2020-01-02 00:00:00",
    "EndTime" : "2020-01-03 00:00:10",
    "BackupStatus" : "Failed",
    "BackupDataType" : "Data"
}

    返回示例

    正常返回示例

    {
    "ResponseMetadata" : {
        "RequestId": "d78bbf4e-63a5-4937-ac3c-3767e7eddfbe",
        "Action": "ListBackups",
        "Version": "2018-01-01",
        "Service": "rds_mysql",
        "Region": "cn-beijing"
    }

    "Result": {
        "Total" : 1,
        "Datas" : [
            {
                "BackupId" : "990e1fa0df8b4aadb45f00ad00ab****",
                "BackupStatus" : "Failed",
                "BackupStrategy" : "Instance",
                "BackupType" : "Physical",
                "BackupMode" : "Full",
                "BackupStartTime" : "2020-01-01 00:00:00",
                "BackupEndTime" : "2020-01-01 00:00:10",
                "CreateType" : "System",
                "BackupFileName" : "full-1638021415869047766-163802160043687****.xbstream",
                "BackupFileSize" : 6831562
            }
        ]
    }
}

    错误码

    更多详情，请参见错误码。