数据库API文档_备份相关 - API中心

1.数据备份列表

接口地址

https://api.yisu.com/rds/backup/getDataLogList

HTTP METHOD

POST

HTTP BODY编码格式

application/x-www-form-urlencoded

请求参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

名称	类型	是否必填	说明
instanceId	string	是
startTime	string	否	开始时间
endTime	string	否	结束时间：默认为该时间当天的23:59:59
currentPage	string	否	页码
pageSize	string	否	每页数量

返回数据

名称	类型	是否必须	备注	其他信息
code	number	非必须	错误码
message	string	非必须	错误信息
data	object	非必须	返回数据
├─ totalResult	number	非必须	总记录数
├─ currentPage	number	非必须	页码
├─ pageSize	number	非必须	每页数量
├─ logFiles	object []	非必须	数据备份列表	item 类型: object
├─ fileName	string	必须	文件名
├─ fileSize	string	必须	文件大小
├─ backupMethod	number	必须	备份方式：2物理备份、1逻辑备份
├─ backupStrategy	number	必须	备份策略:1实例备份、2单库备份
├─ backupType	number	必须	备份方式:1全量备份
├─ startTime	string	必须	备份开始时间
├─ endTime	string	必须	备份完成时间
├─ recoverTime	string	必须	备份机恢复时间点
├─ backupDbs	string []	必须	单库备份数据库列表	item 类型: string
├─		非必须
├─ enableRecover	number	必须	是否允许恢复备份1是0否
requestId	string	非必须	请求ID

请求示例

    curl -XPOST
    "https://api.yisu.com/rds/backup/getDataLogList" \
    -H "content-type: application/x-www-form-urlencoded" \
    -d "accessId=abcdefghijklmnop&nonce=48693365&signature=wm8pQlU34oA5NAEffMtc8NQHues%3D&instanceId=yisurds-60e69eab6173d8-66643171=startTime=2021-07-10=endTime=2021-07-9=currentPage=1=pageSize=2"

返回示例

{
    "code": 200,
    "message": "请求成功",
    "data": {
        "totalResult": 6,
        "currentPage": 1,
        "pageSize": 10,
        "logFiles": [
            {
                "fileName": "auto_1625854443_840.xb",
                "fileSize": "165.98M",
                "backupMethod": 2,
                "backupStrategy": 1,
                "backupType": 1,
                "startTime": "2021-07-10 02:14:03",
                "endTime": "2021-07-10 02:14:08",
                "recoverTime": "2021-07-10 02:14:03",
                "backupDbs": [],
                "enableRecover": 1
            },
        ]
    },
    "requestId": "250e16d8ca796d7bc8a20a6cd8791558"
}

2.binlog备份列表

接口地址

https://api.yisu.com/rds/backup/getBinlogList

HTTP METHOD

POST

HTTP BODY编码格式

application/x-www-form-urlencoded

请求参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

名称	类型	是否必填	说明
instanceId	string	是
startTime	string	否	开始时间
endTime	string	否	结束时间：默认为该时间当天的23:59:59
currentPage	string	否	页码
pageSize	string	否	每页数量

返回数据

名称	类型	是否必须	备注	其他信息
code	number	非必须	错误码
message	string	非必须	错误信息
data	object	非必须	返回数据
├─ totalResult	number	非必须	总记录数
├─ currentPage	number	非必须	页码
├─ pageSize	string	非必须	每页数量
├─ logFiles	object []	非必须	数据备份列表	item 类型: object
├─ fileName	string	必须	文件名
├─ fileSize	string	必须	文件大小
├─ beginTime	string	必须	备份开始时间
├─ endTime	string	必须	备份完成时间
requestId	string	非必须	请求ID

请求示例

    curl -XPOST
    "https://api.yisu.com/rds/backup/getBinlogList" \
    -H "content-type: application/x-www-form-urlencoded" \
    -d "accessId=abcdefghijklmnop&nonce=48693365&signature=wm8pQlU34oA5NAEffMtc8NQHues%3D&instanceId=yisurds-60e69eab6173d8-66643171=startTime=2021-07-9=endTime=2021-07-8=currentPage=1=pageSize=2"

返回示例

{
    "code": 200,
    "message": "请求成功",
    "data": {
        "totalResult": 4,
        "currentPage": 1,
        "pageSize": "2",
        "logFiles": [
            {
                "fileName": "mysql-bin.000005",
                "fileSize": "2.75K",
                "beginTime": "2021-07-08 14:46:28",
                "endTime": "2021-07-08 4:08:02"
            }
        ]
    },
    "requestId": "3f93023b89e532d730bf50301d81c074"
}

3.获取备份设置明细

接口地址

https://api.yisu.com/rds/backup/getBackupSettingDetail

HTTP METHOD

POST

HTTP BODY编码格式

application/x-www-form-urlencoded

请求参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

名称	类型	是否必填	说明
instanceId	string	是

返回数据

名称	类型	是否必须	备注
code	number	非必须	错误码
message	string	非必须	错误信息
data	object	非必须	返回数据
├─ backupSettings	object	非必须	备份设置明细
├─ instanceId	string	非必须	实例ID
├─ nextBackupTime	string	非必须	下次备份时间
├─ dataBackupPeriod	string	非必须	数据备份周期：Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday；多个用英文逗号隔开
├─ dataKeepDays	string	非必须	数据备份保留天数
├─ dataBackupTime	string	非必须	数据备份时间点：03:10-04:10
├─ backupLog	string	非必须	是否开启日志备份
├─ logKeepDays	string	非必须	日志备份保留天数
requestId	string	非必须	请求ID

请求示例

    curl -XPOST
    "https://api.yisu.com/rds/backup/getBackupSettingDetail" \
    -H "content-type: application/x-www-form-urlencoded" \
    -d "accessId=abcdefghijklmnop&nonce=48693365&signature=wm8pQlU34oA5NAEffMtc8NQHues%3D&instanceId=yisurds-60e69eab6173d8-66643171"

返回示例

{
    "code": 200,
    "message": "请求成功",
    "data": {
        "backupSettings": {
            "instanceId": "yisurds-60e69eab6173d8-66643171",
            "nextBackupTime": "2021-07-11 02:00:00",
            "dataBackupPeriod": "Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday",
            "dataKeepDays": "7",
            "dataBackupTime": "02:00-04:00",
            "backupLog": "1",
            "logKeepDays": "7"
        }
    },
    "requestId": "6a235a15721d1b5c4d4d65f896508af9"
}

4.创建备份

接口地址

https://api.yisu.com/rds/backup/createBackup

HTTP METHOD

POST

HTTP BODY编码格式

application/x-www-form-urlencoded

请求参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

名称	类型	是否必填	说明
instanceId	string	是	实例ID
backupStrategy	string	是	备份策略：1实例备份、2单库备份
backupMethod	string	是	备份方式：2物理备份、1逻辑备份

返回数据

名称	类型	是否必须	备注
code	number	非必须	错误码
message	string	非必须	错误信息
requestId	string	非必须	请求ID

请求示例

    curl -XPOST
    "https://api.yisu.com/rds/backup/createBackup" \
    -H "content-type: application/x-www-form-urlencoded" \
    -d "accessId=abcdefghijklmnop&nonce=48693365&signature=wm8pQlU34oA5NAEffMtc8NQHues%3D&instanceId=yisurds-60e69eab6173d8-66643171=backupStrategy=1=backupMethod=1"

返回示例

{
    "code": 200,
    "message": "请求成功",
    "requestId": "ecbd142fdba284b949538e7cd562ba4e"
}

5.获取备份集的数据库、表信息

接口地址

https://api.yisu.com/rds/backup/getRecordDbsInfo

HTTP METHOD

POST

HTTP BODY编码格式

application/x-www-form-urlencoded

请求参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

名称	类型	是否必填	说明
instanceId	string	是	实例ID
fileName	string	是	备份集文件名

返回数据

名称	类型	是否必须	备注	其他信息
code	number	非必须	错误码
message	string	非必须	错误信息
data	object	非必须	返回数据
├─ filename	string	非必须	文件名
├─ dbs	object []	非必须	当前备份文件时间点的数据库列表	item 类型: object
├─ db_name	string	必须	数据库名
├─ tables	object []	必须	数据表列表	item 类型: object
├─ name	string	必须	表名
├─ size	string	必须	数据大小，单位MB
requestId	string	非必须	请求ID

请求示例

    curl -XPOST
    "https://api.yisu.com/rds/backup/getRecordDbsInfo" \
    -H "content-type: application/x-www-form-urlencoded" \
    -d "accessId=abcdefghijklmnop&nonce=48693365&signature=wm8pQlU34oA5NAEffMtc8NQHues%3D&instanceId=yisurds-60e69eab6173d8-66643171=fileName=auto_1626027242_716.xb"

返回示例

{
    "code": 200,
    "message": "请求成功",
    "data": {
        "filename": "auto_1626027242_716.xb",
        "dbs": [
            {
                "db_name": "db2",
                "tables": [
                    {
                        "name": "sbtest1",
                        "size": "23.063"
                    }
                ]
            }
        ]
    },
    "requestId": "148ccfe12bc5947e7ec41b9b1f2cf038"
}

6.恢复备份

接口地址

https://api.yisu.com/rds/backup/recoverBackup

HTTP METHOD

POST

HTTP BODY编码格式

application/x-www-form-urlencoded

请求参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

名称	类型	是否必填	说明
instanceId	string	是	实例ID
fileName	string	是	文件名
backupInfos	string	是	恢复明细

返回数据

名称	类型	是否必须	备注
code	number	非必须	错误码
message	string	非必须	错误信息
requestId	string	非必须	请求ID

请求示例

    curl -XPOST
    "https://api.yisu.com/rds/backup/recoverBackup" \
    -H "content-type: application/x-www-form-urlencoded" \
    -d "accessId=abcdefghijklmnop&nonce=48693365&signature=wm8pQlU34oA5NAEffMtc8NQHues%3D&instanceId=yisurds-60e69eab6173d8-66643171=fileName=auto_1626027242_716.xb=backupInfos=%5B%7B%22backupType%22%3A%22db%22%2C%22dbName%22%3A%22db2%22%2C%22backupDbName%22%3A%22db2_backup_backup%22%2C%22tableName%22%3A%22%22%2C%22backupTableName%22%3A%22%22%7D%2C%7B%22backupType%22%3A%22table%22%2C%22dbName%22%3A%22t101%22%2C%22backupDbName%22%3A%22t101%22%2C%22tableName%22%3A%22T1%22%2C%22backupTableName%22%3A%22T1_backup_backup%22%7D%5D"

返回示例

{
    "code": 200,
    "message": "请求成功",
    "requestId": "108207b88d3975ac162ed8697e8ea899"
}

7.获得备份文件下载地址

接口地址

https://api.yisu.com/rds/backup/getDownloadLink

HTTP METHOD

POST

HTTP BODY编码格式

application/x-www-form-urlencoded

请求参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

名称	类型	是否必填	说明
instanceId	string	是	实例ID
fileName	string	是	文件名

返回数据

名称	类型	是否必须	备注
code	number	非必须	错误码
message	string	非必须	错误信息
data	object	非必须	返回数据
├─ fileLinks	object	非必须	下载链接信息
├─ outer_address	string	非必须	下载链接地址
requestId	string	非必须	请求ID

请求示例

    curl -XPOST
    "https://api.yisu.com/rds/backup/getDownloadLink" \
    -H "content-type: application/x-www-form-urlencoded" \
    -d "accessId=abcdefghijklmnop&nonce=48693365&signature=wm8pQlU34oA5NAEffMtc8NQHues%3D&instanceId=yisurds-60e69eab6173d8-66643171=fileName=auto_1626027242_716.xb"

返回示例

{
    "code": 200,
    "message": "请求成功",
    "data": {
        "fileLinks": {
            "outer_address": "http://rpm9.file.yisu.com/mysql/1229/auto_1626027242_716.xb?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=download%2F20210712%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20210712T025129Z&X-Amz-Expires=7200&X-Amz-SignedHeaders=host&X-Amz-Signature=eda3eee7be52b2f5d7b3b5d94d2413fb22040a3273877b8dd2ceb2eac2053346"
        }
    },
    "requestId": "48b2ca4fb446cfe251e2964504aef23a"
}