名称 二级节点 三级节点 位置 类型 必选 说明 labelInfos body Array 是 标签信息列表，最大长度为50 prodInstId body Long 是 实例id labelType body Integer 是 资源标签分类标识，1主机，2实例,这里固定传2 labels body Array 否 标签列表,一次最多20个 labelName body String 是 标签名称，若传递，则不能为空字符串或者null labelValue body String 否 标签值

接口功能介绍 下载实例参数配置。 接口约束 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说明文档查看更多错误码。

接口描述 查询指定的Postgresql参数模板信息。 请求方法 GET URI /v1/template/list 请求参数 名称 位置 类型 必选 说明 templateId query Long 是 参数模板ID name query String 否 参数名称 prodInstId query Long 是 实例id 响应参数 名称 二级节点 类型 说明 message String 消息提示 statusCode Integer 状态码 returnObj Array paramName String 参数名 paramValue String 参数值 permitValue String 允许的值 desc String 简单描述 description String 描述 valueType String 参数类型 restart String 是否需要重启生效,0:否，1是 示例 请求示例 /v1/template/list?templateId1&prodInstId53 响应示例 { "message": "SUCCESS", "opMessage": "", "returnObj": [ { "description": "设置用于对WAL文件进行归档的shell命令。", "paramName": "archivecommand", "paramValue": "''", "permitValue": "", "restart": "0", "valueType": "string" } ], "statusCode": 800 } 错误码 访问ErrorCodes说明文档查看更多错误码。

接口描述 查询Postgresql实例数据加密状态。 请求方法 GET URI /v1/product/encryption 请求参数 名称 位置 类型 必选 说明 prodInstId query Long 是 实例id 响应参数 名称 类型 说明 message String 消息提示 statusCode Integer 状态码 returnObj Boolean true:已加密 false:未加密 示例 请求示例 /v1/product/getProductEncryption?prodInstId53 响应示例 { "message": "SUCCESS", "opMessage": "", "returnObj": false, "statusCode": 800 } 错误码 访问ErrorCodes说明文档查看更多错误码。

名称 二级节点 类型 说明 message String 消息提示 statusCode Integer 状态码 returnObj Object 所有的返回信息都以JSON形式保存 delayTime String 复制延迟时间

接口描述 查询Postgresql实例在指定时间范围内的增强指标监控信息 请求方法 GET URI /v1/monitor/queryenhancedmetrics 请求参数 名称 位置 类型 必选 说明 prodInstId query Long 是 实例id startTime query String 是 自定义查询开始时间,格式：yyyyMMdd HH:mm:ss endTime query String 是 自定义查询结束时间,格式：yyyyMMdd HH:mm:ss,查询时间间隔不超过30天 响应参数 名称 二级节点 三级节点 类型 说明 message String 消息提示 statusCode Integer 状态码 returnObj Object instId Long 实例id nodes List 实例各个节点性能信息 ip String 节点ip master boolean 是否主节点 metrics List > 时间范围内各个时间点已开启的增强性能指标 示例 请求示例 /v1/monitor/queryInstEnhancedMetrics?prodInstId14&startTime20220820 19:18:41&endTime20220820 19:19:42 响应示例 { "message": "SUCCESS", "opMessage": "", "returnObj": { "instId": 53, "nodes": [ { "ip": "192.168.190.11", "master": true, "metrics": [ { "collectTime": "20220908 17:45:01", "con": 0, "delay": 0, "walsize": 0.00 }, { "collectTime": "20220908 17:46:01", "con": 6, "delay": 0, "walsize": 11.00 }, { "collectTime": "20220908 17:47:01", "con": 5, "delay": 0, "walsize": 11.00 } ] }, { "ip": "192.168.190.12", "master": false, "metrics": [] } ] }, "statusCode": 800 }

错误码 访问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说明文档查看更多错误码。

名称 二级节点 类型 说明 message String 消息提示 statusCode Integer 状态码 returnObj Object 所有的返回信息都以JSON形式保存 enableEventLog Boolean 历史事件开启情况 true：开启 false：关闭

名称 位置 类型 必选 说明 pageNum query Integer 是 页码 pageSize query Integer 是 页大小，范围1500 startTime query Long 否 自定义查询开始时间,格式:时间戳 endTime query Long 否 自定义查询结束时间,格式:时间戳

示例 请求示例 /v1/monitor/getPerformance?prodInstId14&startTime'20220819 00:00:00'&endTime'20220820 23:59:00' 响应示例 { "message": "SUCCESS", "opMessage": "", "returnObj": { "instId": 14, "nodes": [ { "ip": "192.168.190.11", "master": false, "metrics": [ { "collectTime": "20220820 15:54:48", "cpuSys": 3, "cpuUser": 1, "ioUtil": 0.1, "qps": 0, "rRateKbs": 6.2, "tps": 0, "wRateKbs": 74.5 }, { "collectTime": "20220820 15:54:48", "cpuSys": 3, "cpuUser": 1, "ioUtil": 0.1, "qps": 0, "rRateKbs": 6.2, "tps": 0, "wRateKbs": 74.5 } ] }, { "ip": "192.168.190.12", "master": true, "metrics": [] } ] }, "statusCode": 800 } 错误码 访问ErrorCodes说明文档查看更多错误码。

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

接口描述 将历史数据恢复至一个新实例（称为克隆实例） 请求方法 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 Array 返回对象 [] BackupProdVo

名称 位置 类型 必选 说明 srcProdInstId body Long 是 源PG的实例ID destProdInstId body Long 是 目标PG的实例ID backupName body String 是 备份名称

参数 是否必填 参数类型 说明 示例 下级对象 prodInstId 是 Long 实例id 34 startTime 是 String 查询开始时间，格式yyyyMMdd HH:mm:ss， 不能晚于当前时间 20221017 12:00:00 endTime 是 String 查询结束时间，格式yyyyMMdd HH:mm:ss， 与开始时间不能间隔30天，且不能早于开始时间 20221018 12:00:00

参数 参数类型 说明 示例 下级对象 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

接口描述 解锁PostgreSQL实例的账号，PostgreSQL实例被锁定的账号无法使用，需要解锁后才能继续使用。 请求方法 POST URI /v1/instuser/unlock 请求参数 名称 位置 类型 必选 说明 prodInstId body Long 是 实例id username body String 是 用户账号 响应参数 名称 类型 说明 message String 消息提示 statusCode Integer 状态码 returnObj Object 返回结果 示例 请求示例 /v1/instuser/unlockUser { "prodInstId": "165776586159600008", "username": "pguser" } 响应示例 { "message": "SUCCESS", "returnObj": {}, "statusCode": 800 } 错误码 访问ErrorCodes说明文档查看更多错误码。

示例 请求示例 {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说明文档查看更多错误码。

参数 参数类型 说明 示例 下级对象 fileName String 文件名称 postgresql20221101174412.csv logDownloadUrl String 下载地址 logSize String 日志文件大小，单位：byte 5438349 logTime Long 审计文件时间 1667297102000 sqlStartTime Long sql开始时间 1667296096000 sqlEndTime Long sql结束时间 1667297102000

参数 是否必填 参数类型 说明 示例 下级对象 orders 是 Array 订单项 List

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

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

名称 二级节点 三级节点 类型 说明 message String 消息提示 statusCode Integer 状态码 returnObj Array pageNum Integer 页码 pageSize Integer 每页最大条数 total Integer 总记录数 pageTotal Integer 总页数 list Array id String 错误日志id resId String 数据库资源唯一标识 host String 数据库所在服务器ip port String 数据库所在服务器端口 level String 日志级别 message String 错误信息 createTime String 创建时间 lineNumber Integer 行数

名称 位置 类型 必选 说明 resId body Long 是 数据库资源唯一标识 limit body Integer 是 查询数量，限制500 flag body String 否 数据库类型，OpenGauss:OpenGauss,PostgreSQL:PostgreSQL, 若不传，则根据resId的数据库类型进行过滤 order body String 否 排序字段，不传默认avgCost，取值 calls total avgCost beginTime body String 否 自定义开始时间,格式：yyyyMMdd HH:mm:ss，开始时间默认为结束时间的一小时前。 endTime body String 否 自定义结束时间,格式：yyyyMMdd HH:mm:ss，结束时间默认为当前时间。