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

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

名称 二级节点 位置 类型 必选 说明 labelType body Integer 是 资源标签分类标识，1主机，2实例,这里固定传2 labels body Array 是 标签列表,一次最多只能新增50个 labelName body String 是 资源标签名称，同一租户下标签名称唯一、平台标签名称唯一 labelValue body String 否 标签值 remark body String 否 标签说明

接口描述 修改SQL洞察日志保存时长。 接口约束 实例需要已开启SQL洞察 URI PUT /v1/collector/sqlcollectorretention 请求参数 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 prodInstId 是 Long 实例id 10 retainValue 是 Integer SQL洞察日志保存时长，单位：天，取值：30，180，365，1095，1825 30 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码 800 message String 消息提示 SUCCESS returnObj Object 返回对象 请求示例 /v1/collector/sqlcollectorretention 请求体body { "prodInstId": 10, "retainValue": 30 } 响应示例 { "returnObj": {}, "message":"SUCCESS", "statusCode": 800 } 错误码 访问ErrorCodes说明文档查看更多错误码。

接口功能介绍 修改实例的root账户密码 接口约束 实例必须处于运行中的状态 URI PUT /v1/remote/rootpassword 请求参数 body参数 参数 是否必填 参数类型 说明 示例 prodInstId 是 Integer 实例id 54 newPassword 是 String 新密码。816位，且必须含有数字，小写字母，大写字母，特殊字符 Arcyd12EQR 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码 800 message String 消息提示 SUCCESS returnObj Array 返回对象 [] 请求示例 /v1/remote/rootpassword 请求参数 json { "prodInstId":54, "newPassword":"Arcyd12EQR" } 响应示例 json { "message": "SUCCESS", "returnObj": {}, "statusCode": 800 } 错误码 访问ErrorCodes说明文档查看更多错误码。

参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码 800 message String 消息提示 SUCCESS returnObj Array 返回对象 [] VpcForm

名称 类型 说明 message String 消息提示 statusCode Integer 状态码 returnObj Object 所有的返回信息都以JSON形式保存

接口功能介绍 下载实例参数配置。 接口约束 URI GET /v1/params/downloadparam 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 请求体Query参数 参数 是否必填 参数类型 说明 示例 下级对象 prodInstId 是 Long 实例id 10 setName 是 String 实例参数配置名称 实例10的参数配置 响应参数 请求成功时，返回的是一个文件流，在浏览器可以直接下载 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码 810 message String 消息提示 请求失败 : 实例参数配置名称不能为空 returnObj Object 返回对象 请求示例 /v1/params/downloadparam?prodInstId10&setName实例10的参数配置 请求头header 请求体body 响应示例 json { "message": "请求失败 : 实例参数配置名称不能为空", "returnObj": {}, "statusCode": 810 } 错误码 访问ErrorCodes说明文档查看更多错误码。

示例 请求示例 /v1/monitor/pageSwitchRecord?prodInstId1&satrtTime2022722 响应示例 { "message": "SUCCESS", "opMessage": "", "returnObj": { "list": [ { "createTime": 1661694462000, "curSetRun": "192.168.1.116543192.168.1.126543", "oldSetRun": "192.168.1.126543192.168.1.116543", "prodInstId": 53, "prodInstName": "set11126563", "result": true, "switchTime": 1661711492000, "switchType": "auto" } ], "pageNum": 1, "pageSize": 10, "pageTotal": 1, "total": 2 }, "statusCode": 800 } 错误码 访问ErrorCodes说明文档查看更多错误码。

接口描述 将历史数据恢复至一个新实例（称为克隆实例） 请求方法 POST URI /v1/recover/cloneinstance 请求参数 名称 位置 类型 必选 说明 srcProdInstId body Long 是 源pg实例id backupId body Long 否 备份id,和restoreTime只能有一个为空 destProdInstId body Long 是 目标实例id restoreTime body String 否 备份保留周期内的任意时间点。格式：yyyyMMdd HH:mm:ss 响应参数 名称 类型 说明 message String 消息提示 statusCode Integer 状态码 returnObj Object 返回结果 示例 请求示例 /v1/recover/cloneInstance { "backupId": 1, "destProdInstId": 7, "restoreTime": "", "srcProdInstId": 6 } 响应示例 { "message": "SUCCESS", "opMessage": "", "returnObj": {} } 错误码 访问ErrorCodes说明文档查看更多错误码。

参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码 800 message String 消息提示 SUCCESS returnObj Object 返回对象，true:有效，false:无效 true

接口描述 查询实例所有节点以及备机（如果有的话）的规格详情，包括cpu、内存、磁盘 请求方法 GET URI /v1/product/scaledetail 请求参数 名称 位置 类型 必选 说明 prodInstId body Long 是 实例id 响应参数 名称 二级节点 类型 说明 message String 消息提示 statusCode Integer 状态码 returnObj List 所有的返回信息都以JSON形式保存 ip String 节点ip type Integer 节点类型，取值 l 0：主节点 l 1：从节点 l 2：备份节点 cpu Integer cpu数量，单位core memeory Long 内存大小，单位K disk Long 磁盘大小，单位K 示例 请求示例 /v1/product/getProductScaleDetail?prodInstId14 响应示例 { "message": "SUCCESS", "opMessage": "", "returnObj": [ { "cpu": 1, "disk": 22750104, "ip": "192.168.190.12", "memory": 1863000, "type": 2 }, { "cpu": 1, "disk": 22936404, "ip": "192.168.190.11", "memory": 1863000, "type": 0 }, { "cpu": 1, "disk": 22750104, "ip": "192.168.190.12", "memory": 1863000, "type": 1 } ], "statusCode": 800 }

接口功能介绍 自动备份任务下次开始时间。 接口约束 URI GET /v1/backup/nextautobackupbegintime 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 请求体Query参数 参数 是否必填 参数类型 说明 示例 下级对象 prodInstId 是 Long 实例id 10 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码 800 message String 消息提示 SUCCESS returnObj Object 返回对象 20221122 10:00:00 请求示例 /v1/backup/nextautobackupbegintime?prodInstId10 请求头header 请求体body 响应示例 json { "message": "SUCCESS", "returnObj": "20221122 10:00:00", "statusCode": 800 } 错误码 访问ErrorCodes说明文档查看更多错误码。

名称 位置 类型 必选 说明 prodInstId query Long 是 实例id operType query Integer 否 备份类型，1：自动备份，2：手动备份，4：系统备份,默认查询全部 startTime query String 否 备份开始时间，若该值，则查询大于等于该值的，格式：yyyyMMdd HH:mm:ss endTime query String 否 备份查询时间，若该值，则查询大于等于该值的，格式：yyyyMMdd HH:mm:ss pageNum query Integer 是 当前页 pageSize query Integer 是 页大小，范围1500

名称 类型 说明 message String 消息提示 statusCode Integer 状态码 returnObj Object

名称 类型 说明 message String 消息提示 statusCode Integer 状态码 returnObj Object

示例 请求示例 {URI}?pageNum1&pageSize10 响应示例 { "message": "SUCCESS", "returnObj": { "list": [ { "backupName": "测试pg备份", "createTime": "2022726 11:19:00", "dataLen": "3G", "endTime": 1661498705000, "invalid": 0, "prodInstId": 1, "prodInstName": "pg实例", "result": 3, "startTime": 1661498704000, "type": "0" } ], "pageNum": 1, "pageSize": 10, "pageTotal": 1, "total": 1 }, "statusCode": 800 } 错误码 访问ErrorCodes说明文档查看更多错误码。

名称 位置 类型 必选 说明 prodInstId body Long 是 实例id username body String 是 用户账号 password body String 是 用户密码

示例 请求示例 /v1/backup/pageDetachedBackup?prodInstId53&pageNum1&pageSize10 响应示例 { "message": "SUCCESS", "opMessage": "", "returnObj": { "list": [ { "backupName": "53to5420220826110646", "dataLen": "", "endTime": 1661512021000, "id": 25, "prodInstId": 53, "result": 3, "startTime": 1661512006000, "type": 3 } ], "pageNum": 1, "pageSize": 10, "pageTotal": 1, "total": 1 }, "statusCode": 800 } 错误码 访问ErrorCodes说明文档查看更多错误码。

参数 是否必填 参数类型 说明 示例 下级对象 projectid 是 String 项目id

参数 是否必填 参数类型 说明 示例 下级对象 prodInstId 是 Long 实例id 34 sqlCollectorStatus 是 String 开启或关闭SQL洞察（SQL审计），取值：enable disabled enable restartInstance 否 boolean 是否重启实例，默认false。若要生效，需要重启实例 true

名称 位置 类型 必选 说明 prodInstId body Long 是 实例id description body String 是 最大长度不超过1KB,最小长度为0；输入空字符串表示清空描述

名称 位置 类型 必选 说明 prodInstId body Long 是 实例id uncheckRange body String 是 禁用检测组件范围，取值如下： 1.逗号分割的字符串，其中每一项只能在zk/agent/pg/gateway中取值, eg: agent,pg 2.空字符串，恢复默认检测所有组件

接口描述 查询资源池列表 接口约束 无 URI GET /v1/eop/resourcepool 请求参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 否 String 资源池id，如不填则返回所有资源池信息 30e9xxxxx7211e9bxxx0242ac11xxxx 响应参数 参数 参数类型 说明 示例 下级对象 : statusCode Integer 状态码 800 message String 消息提示 SUCCESS returnObj Array 资源池信息列表 List ResourcePoolVO 参数 参数类型 说明 示例 下级对象 : region String 资源池属地 cnbaoding regionId String 资源池ID 30e9xxxxx7211e9bxxx0242ac11xxxx zoneName String 资源池名称 佛山OS storageType Array 存储介质列表 List StorageType 参数 参数类型 说明 示例 下级对象 name String 名称 普通IO type String 类型 SATA 请求示例 /v1/eop/resourcepool?regionId30e9xxxxx7211e9bxxx0242ac11xxxx

接口描述 修改实例的可维护时间段，可维护时间段格式为：hh:mmhh:mm，默认的维护时间段为01:0004:00 请求方法 PUT URI /v1/product/maintaintime 请求参数 名称 位置 类型 必选 说明 prodInstId body Long 是 实例id maintainTime body String 是 格式为：hh:mmhh:mm，默认的维护时间段为01:0004:00 响应参数 名称 类型 说明 message String 消息提示 statusCode Integer 状态码 returnObj Object 所有的返回信息都以JSON形式保存 示例 请求示例 /v1/product/modifyProductMaintainTime { "maintainTime": "01:0004:00", "prodInstId": 15 } 响应示例 { "message": "SUCCESS", "opMessage": "", "returnObj": {}, "statusCode": 800 } 错误码 访问ErrorCodes说明文档查看更多错误码。

名称 位置 类型 必选 说明 prodInstId query Long 是 实例id

示例 请求示例 /v1/notify/queryNotify?pageNum1&pageSize1&startTime1662189142000&endTime&withConfirmedtrue 响应示例 { "message": "SUCCESS", "opMessage": "", "returnObj": { "list": [ { "confirmFlag": true, "notifyContent": "创建实例失败，工单号:19063", "notifyId": 4, "notifyLevel": "warning", "notifyTime": "20220903 15:13:19", "notifyType": "InstanceOperation", "updateTime": "20220903 15:13:19", "userId": 1 } ], "pageNum": 1, "pageSize": 1, "pageTotal": 1, "total": 1 }, "statusCode": 800 } 错误码 访问ErrorCodes说明文档查看更多错误码。

名称 类型 说明 message String 消息提示 statusCode Integer 状态码 returnObj Object 所有的返回信息都以JSON形式保存 enable Boolean 功能启用标志

名称 位置 类型 必选 说明 prodInstId query Long 是 实例id

参数 是否必填 参数类型 说明 示例 下级对象 vpcId 否 String 真实vpcId c455ffa4ace64f5fbc184587b5a10650

参数 是否必填 参数类型 说明 示例 pageNum 是 Integer 页码，页码最小值为1 1 pageSize 是 Integer 页大小，页大小取值范围为：1500

接口描述 查询实例的所有连接地址信息 请求方法 GET URI /v1/product/getpaasproductnetinfo 请求参数 名称 位置 类型 必选 说明 prodInstId query Long 是 实例id 响应参数 名称 二级节点 三级节点 类型 说明 message String 消息提示 statusCode Integer 状态码 returnObj Object 所有的返回信息都以JSON形式保存 master ProductNetInfo 主节点连接信息 ip String 连接ip port String 连接端口 slaves List 从节点连接信息，单节点实例为null vip ProductNetInfo vip连接信息，单节点实例为null 示例 请求示例 /v1/product/getPaasProductNetInfo?prodInstId1 响应示例 { "message": "SUCCESS", "opMessage": "", "returnObj": { "master": { "ip": "192.168.190.12", "port": "5200" }, "slaves": [ { "ip": "192.168.190.11", "port": "5200" } ], "vip": { "ip": "192.168.190.14", "port": "5202" } }, "statusCode": 800 } 错误码 访问ErrorCodes说明文档查看更多错误码。