备案 控制台 登录 注册
文档中心 > DescribeBackups
DescribeBackups

最近更新时间：2022-09-26

请求方法：GET

接口描述：获取备份文件列表

请求参数

名称

类型

是否必选

示例值

描述

Action

String

是

DescribeBackups

系统规定参数。取值：DescribeBackups

DBInstanceId

String

是

mysql-lv1xxxxxxx

数据库实例ID

StartTime

String

否

2020-08-14   12:00

备份开始时间，必须小于等于当前时间

EndTime

String

否

2020-08-15   12:00

备份结束时间，必须大于等于开始时间

PageSize

Integer

否

10

分页参数，每页大小,默认30

PageNumber

Integer

否

1

分页参数，当前页

返回参数

状态码：200

名称

类型

示例值

描述

RequestId

String

rm-uf6wjk5xxxxxxxxxx

请求ID。

PageNumber

Integer

1

当前页。

PageSize

Integer

30

每页备份文件个数。

TotalCount

Integer

100

总记录数。

TotalPage

Integer

3

总页数。

Records

Array

[]

由备份信息组成的数组

-   BackupId

String

asdasdwga-asdasddaxxxxxxx

备份文件ID

-   BackupStartTime

String

2020-08-04   16:00

备份开始时间

-   BackupEndTime

String

2020-08-04   16:01

备份结束时间

-   BackupStrategy

String

manual

备份策略，

  • manual：手动备份

  • auto:自动备份

-   BackupType

String

full

备份类型，

full：全量备份

-   BackupStatus

String

success

备份状态 

  • success:成功 

  • fail：失败 

  • begin：备份中

-   BackupSize

Long

573422603

备份文件大小，单位：B

-   BackupDownloadURL

String

见实例

文件下载Url，如当前地域不支持下载，则返回空

-   BackupApproach

String

physical

备份方法目前支持物理备份

l   BackupDatabases

String

dbstest

sqlserver实例返回备份的数据库

示例

请求示例

GET https://api.unicloud.com/v3/api/rds?

Action=DescribeBackups

&DBInstanceId=mysql-xxxxxxxxxxx

返回示例

{

    "PageNumber": 1,

    "PageSize": 30,

    "TotalRecordCount": 1,

    "TotalPageCount": 1,

    "RequestId": "asdasdasdasdasdasd",

    "Items": [

        {

            "BackupId": "81468d80-5130-4044-911a-xxxxxxxxx",

            "BackupStartTime": "2020-08-11 10:45",

            "BackupEndTime": "2020-08-11 10:46",

            "BackupStrategy": "manual",

            "BackupType": "full",

            "BackupStatus": "success",

            "BackupSize": 573422603,

            "BackupDownloadURL": "https://XXXXX/mysql/se/mysql-yrnsuq0e5bk/1597113930775083413/20200811104530full.bkp?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20200811T145415Z&X-Amz-SignedHeaders=host&X-Amz-Expires=899&X-Amz-Credential=zEl1os171Wsc9L9L%2F20200811%2Fcn-north-1%2Fs3%2Faws4_request&X-Amz-Signature=a7faxxxxxxxxxxxxxxxxx"

        }

    ]

}