云数据库RedisAPI文档_备份相关 - 帮助中心

1.设置备份策略

接口地址

https://api.yisu.com/redis/backup/modifyBackupSetting

HTTP METHOD

POST

HTTP BODY编码格式

application/x-www-form-urlencoded

请求参数

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

名称	类型	是否必填	说明
instanceId	string	是	实例ID
backupTime	string	是	备份时间点如700
backupCycle	string	是	备份周期，可选范围：Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday

返回数据

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

请求示例

    curl -XPOST
    "https://api.yisu.com/redis/backup/modifyBackupSetting" \
    -H "content-type: application/x-www-form-urlencoded" \
    -d "accessId=abcdefghijklmnop&nonce=48693365&signature=wm8pQlU34oA5NAEffMtc8NQHues%3D&instanceId=yisuredis-60ecfbddc5e663-40223956=backupTime=7-8=backupCycle=Monday%2CWednesday"

返回示例

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

2.获取备份策略明细

接口地址

https://api.yisu.com/redis/backup/getBackupSetting

HTTP METHOD

POST

HTTP BODY编码格式

application/x-www-form-urlencoded

请求参数

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

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

返回数据

名称	类型	是否必须	备注
code	number	非必须	错误码
message	string	非必须	错误信息
data	object	非必须	返回数据
├─ backupTime	string	非必须	备份时间点(07:00-08:00)
├─ nextBackupTime	string	非必须	下次备份时间
├─ backupCycle	string	非必须	备份周期：Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday；多个用英文逗号隔开
├─ backupSaveDays	string	非必须	备份保留时间
requestId	string	非必须	请求ID

请求示例

    curl -XPOST
    "https://api.yisu.com/redis/backup/getBackupSetting" \
    -H "content-type: application/x-www-form-urlencoded" \
    -d "accessId=abcdefghijklmnop&nonce=48693365&signature=wm8pQlU34oA5NAEffMtc8NQHues%3D&instanceId=yisuredis-60ecfbddc5e663-40223956"

返回示例

{
    "code": 200,
    "message": "请求成功",
    "data": {
        "backupTime": "07:00-08:00",
        "nextBackupTime": "2021-07-21 0:16:00",
        "backupCycle": "Monday,Wednesday",
        "backupSaveDays": "7"
    },
    "requestId": "02c2da1ba1dd1edf5d002fe7c9e7085a"
}

3.创建备份

接口地址

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

HTTP METHOD

POST

HTTP BODY编码格式

application/x-www-form-urlencoded

请求参数

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

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

返回数据

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

请求示例

    curl -XPOST
    "https://api.yisu.com/redis/backup/createBackup" \
    -H "content-type: application/x-www-form-urlencoded" \
    -d "accessId=abcdefghijklmnop&nonce=48693365&signature=wm8pQlU34oA5NAEffMtc8NQHues%3D&instanceId=yisuredis-60ecfbddc5e663-40223956"

返回示例

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

4.恢复备份

接口地址

https://api.yisu.com/redis/backup/restoreInstance

HTTP METHOD

POST

HTTP BODY编码格式

application/x-www-form-urlencoded

请求参数

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

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

返回数据

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

请求示例

    curl -XPOST
    "https://api.yisu.com/redis/backup/restoreInstance" \
    -H "content-type: application/x-www-form-urlencoded" \
    -d "accessId=abcdefghijklmnop&nonce=48693365&signature=wm8pQlU34oA5NAEffMtc8NQHues%3D&instanceId=yisuredis-60ecfbddc5e663-40223956=fileName=handle_1626685661.rdb"

返回示例

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

5.备份文件列表

接口地址

https://api.yisu.com/redis/backup/getBackupList

HTTP METHOD

POST

HTTP BODY编码格式

application/x-www-form-urlencoded

请求参数

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

名称	类型	是否必填	说明
instanceId	string	是	实例ID
currentPage	string	是	页码
pageSize	string	是	每页数量

返回数据

名称	类型	是否必须	备注	其他信息
code	number	非必须	错误码
message	string	非必须	错误信息
data	object	非必须	返回数据
├─ Backups	object []	非必须	备份列表	item 类型: object
├─ fileName	string	必须	文件名
├─ createTime	string	必须	备份开始时间
├─ endTime	string	必须	备份结束时间
├─ allowDelete	boolean	必须	是否允许删除（手动备份的文件才可删除）
├─ totalResult	number	非必须	总记录数
├─ currentPage	string	非必须	页码
├─ pageSize	string	非必须	每页数量
requestId	string	非必须	请求ID

请求示例

    curl -XPOST
    "https://api.yisu.com/redis/backup/getBackupList" \
    -H "content-type: application/x-www-form-urlencoded" \
    -d "accessId=abcdefghijklmnop&nonce=48693365&signature=wm8pQlU34oA5NAEffMtc8NQHues%3D&instanceId=yisuredis-60ecfbddc5e663-40223956=currentPage=1=pageSize=20"

返回示例

{
    "code": 200,
    "message": "请求成功",
    "data": {
        "Backups": [
            {
                "fileName": "handle_1626685661.rdb",
                "createTime": "2021-07-19 17:07:42",
                "endTime": "2021-07-19 17:07:47.300371",
                "allowDelete": true
            }
        ],
        "totalResult": 7,
        "currentPage": "1",
        "pageSize": "20"
    },
    "requestId": "3edc22e1d57cf75886629f304b84dab9"
}

6.删除备份文件

接口地址

https://api.yisu.com/redis/backup/deleteBackupFile

HTTP METHOD

POST

HTTP BODY编码格式

application/x-www-form-urlencoded

请求参数

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

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

返回数据

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

请求示例

    curl -XPOST
    "https://api.yisu.com/redis/backup/deleteBackupFile" \
    -H "content-type: application/x-www-form-urlencoded" \
    -d "accessId=abcdefghijklmnop&nonce=48693365&signature=wm8pQlU34oA5NAEffMtc8NQHues%3D&instanceId=yisuredis-60ecfbddc5e663-40223956=fileName=handle_1626685661.rdb"

返回示例

{
    "code": 500,
    "message": "请求失败",
    "requestId": "dece35f894d3265a4684b2e7ba5fa53b"
}

7.获取文件下载链接

接口地址

https://api.yisu.com/redis/backup/getFileDownloadLink

HTTP METHOD

POST

HTTP BODY编码格式

application/x-www-form-urlencoded

请求参数

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

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

返回数据

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

请求示例

    curl -XPOST
    "https://api.yisu.com/redis/backup/getFileDownloadLink" \
    -H "content-type: application/x-www-form-urlencoded" \
    -d "accessId=abcdefghijklmnop&nonce=48693365&signature=wm8pQlU34oA5NAEffMtc8NQHues%3D&instanceId=yisuredis-60ecfbddc5e663-40223956=fileName=handle_1626685661.rdb"

返回示例

{
    "code": 200,
    "message": "请求成功",
    "data": {
        "links": {
            "inner_address": "",
            "outer_address": "http://rpm2.file.yisu.com/redis/237/handle_1626685661.rdb?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=download%2F20210719%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20210719T101555Z&X-Amz-Expires=7200&X-Amz-SignedHeaders=host&X-Amz-Signature=5429739592a179d68bf10de4efb38648280e655f1d1c93fbb7d3ad006069ad15"
        }
    },
    "requestId": "e805f953f2dc0479a103fe8436b2710c"
}