接口描述

查询实例的备份设置信息

请求方法

GET

URI

/v1/backup/conf

请求参数

名称	位置	类型	必选	说明
prodInstId	query	Long	否	实例id，若不传则查询登录用户的全部备份配置
pageNum	query	Integer	否	当前页
pageSize	query	Integer	否	页大小，范围1-500

响应参数

名称			类型	说明
message			String	消息提示
statusCode			Integer	状态码
returnObj			Object
	pageNum		Integer	当前页
	pageSize		Integer	页大小
	total		Integer	总记录数
	pageTotal		Integer	总页数
	list		Array
		prodInstId	Integer	实例id
		setname	String	设置名称
		storeIp	String	存储ip
		storePath	String	存储路径
		diskTotal	String	磁盘总大小
		diskUsed	String	已使用磁盘
		autoRemove	Byte	删除清除备份数据的策略，0表示不清除
		autoBackup	Byte	自动备份开关，0表示关闭，1表示打开
		weekdays	List	自动备份的日期列表
		autoBackupTime	String	自动备份时间
		machineId	String	机器资源唯一标识
		createTime	Long	创建时间

示例

请求示例

/v1/backup/pageBackupConf?prodInstId=1&pageNum=1&pageSize=10

响应示例

{
    "message": "SUCCESS",
    "returnObj": {
        "list": [
            {
                "autoBackup": 1,
                "autoBackupTime": "1:30",
                "autoRemove": 0,
                "createTime": 1662103784000,
                "diskTotal": "1024G",
                "diskUsed": "384G",
                "machineId": 1,
                "prodInstId": 1,
                "setname": "测试pg备份",
                "storeIp": "127.0.0.1",
                "storePath": "/app/data/",
                "weekdays": [
                    1,
                    3,
                    5
                ]
            }
        ],
        "pageNum": 1,
        "pageSize": 10,
        "pageTotal": 1,
        "total": 1
    },
    "statusCode": 800
}

错误码

访问ErrorCodes说明文档查看更多错误码。

关系数据库PostgreSQL版

查询PostgreSQL实例备份设置