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

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

接口描述 查询Postgresql实例IP白名单。 请求方法 GET URI /v1/whitelist/query 请求参数 名称 位置 类型 必选 说明 prodInstId query Long 是 实例id 响应参数 名称 类型 说明 message String 消息提示 statusCode Integer 状态码 returnObj List IP白名单列表 示例 请求示例 /v1/whiteList/queryIPWhiteList?prodInstId15 响应示例 { "message": "SUCCESS", "opMessage": "", "returnObj": [ "127.0.0.1", "192.168.174.1" ], "statusCode": 800 } 错误码 访问ErrorCodes说明文档查看更多错误码。

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

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

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

本文中可查看天翼云关系型数据库服务等级协议。 自2021年11月11日起，新版关系型数据库服务等级协议生效。详情请参见[](

名称 二级节点 类型 说明 message String 消息提示 statusCode Integer 状态码 returnObj Array 所有的返回信息都以JSON形式保存 characterSetNameItems List 支持的字符集列表,例如： ["gbk","utf8","ascii"] engine String 数据库引擎类型。取值： postgreSQL：PostgreSQL

请求示例 /v1/collector/sqllogrecords?pageSize10&pageNum1101 00:00:00&endTime20221129 23:59:59&prodInstId10 请求体body 响应示例 json { "message": "SUCCESS", "returnObj": { "list": [ { "accountName": "test", "dbName": "postgres", "executeTime": 1667354445000, "hostAddress": "192.168.0.18:50744", "sqlText": "terminating connection due to administrator command", "threadId": "6952" } ], "pageNum": 1, "pageSize": 10, "pageTotal": 1, "total": 1 }, "statusCode": 800 } 错误码 访问ErrorCodes说明文档查看更多错误码。

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

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

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

参数 是否必填 参数类型 说明 示例 下级对象 prodInstId 是 Long 实例id 10 dbResourceId 是 Long 数据库资源id 2 fileName 是 String 审计日志文件名称 postgresql20221026152843.csv

参数 是否必填 参数类型 说明 示例 下级对象 vpcId 否 String VPC ID cfcbed30ca9e432daa8b87ef0eb6a9aa

参数 参数类型 说明 示例 下级对象 host String 数据库ip 192.168.1.11 port Integer 数据库端口 5432 sqlCollectorStatus String SQL审计状态，取值：enable disabled disabled

接口描述 重置账号系统权限，仅保留登录权限 请求方法 PUT URI /v1/instuser/resetprivilege 请求参数 名称 位置 类型 必选 说明 prodInstId body Long 是 实例id username body String 是 实例数据库用户名 响应参数 名称 类型 说明 message String 消息提示 statusCode Integer 状态码 returnObj Object 所有的返回信息都以JSON形式保存 示例 请求示例 /v1/instuser/resetAccountPrivilege { "prodInstId": 15, "username": "test" } 响应示例 { "message": "SUCCESS", "opMessage": "", "returnObj": {}, "statusCode": 800 } 错误码 访问ErrorCodes说明文档查看更多错误码。

名称 二级节点 类型 说明 message String 消息提示 statusCode Integer 状态码 returnObj Array 所有的返回信息都以JSON形式保存 resId Long 数据库机器资源id role String 数据库角色，m:主库，s:备库 prodInstId Long 实例id prodInstName String 实例名称 nodeId Long 实例下的数据库节点id

名称 位置 类型 必选 说明 prodInstId body Long 是 实例id labelType body Integer 是 资源标签分类标识，1主机，2实例,这里固定传2 labelIds body List 是 标签id列表,一次最多只能设置20个

本文可查看天翼云关系型数据库服务协议。 自2021年11月11日起，新版关系型数据库服务协议生效。详情请参见[](

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

参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码 810 message String 消息提示 请求失败 : 实例参数配置名称不能为空 returnObj Object 返回对象

名称 位置 类型 必选 说明 templateId query Long 是 参数模板ID name query String 否 参数名称 prodInstId query Long 是 实例id

名称 类型 说明 message String 消息提示 statusCode Integer 状态码 returnObj Boolean true:已加密 false:未加密

名称 位置 类型 必选 说明 prodInstId query Long 是 实例id nodeId query Long 是 只读实例节点id

名称 位置 类型 必选 说明 prodInstId query Long 是 实例id startTime query String 是 自定义查询开始时间,格式：yyyyMMdd HH:mm:ss endTime query String 是 自定义查询结束时间,格式：yyyyMMdd HH:mm:ss,查询时间间隔不超过30天

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

名称 位置 类型 必选 说明 prodInstId query Long 是 实例id startTime query String 是 开始时间，格式：yyyyMMdd HH:mm:ss endTime query String 是 结束时间，格式：yyyyMMdd HH:mm:ss pageNum query Integer 是 当前页 pageSize query Integer 是 页大小，范围1500

名称 位置 类型 必选 说明 enableEventLog query Boolean 是 开启或关闭历史事件功能

名称 二级节点 三级节点 类型 说明 message String 消息提示 statusCode Integer 状态码 returnObj Object pageNum Integer 页码 pageSize Integer 每页最大条数 total Integer 总记录数 pageTotal Integer 总页数 list Array eventId String id prodInstId String 实例ID eventType String 事件类型 eventName String 事件名称 eventTime String 事件发生时间 eventUserType String 事件发起人 eventReason String 事件产生原因 userId Integer 用户ID eventPayload String 请求参数

名称 二级节点 三级节点 四级节点 类型 说明 message String 消息提示 statusCode Integer 状态码 returnObj Object instId Long 实例id nodes List 实例各个节点性能信息 ip String 节点ip master boolean 是否主节点 metrics List 时间范围类各个时间点性能指标 cpuUser Byte 监控数据采集时间间隔内，cpu处于用户态的时间比例,单位% cpuSys Byte 监控数据采集时间间隔内，cpu处于内核态的时间比例，单位% rRateKbs BigDecimal io读速率，单位kb/s wRateKbs BigDecimal io写速率，单位kb/s ioUtil BigDecimal io利用率,单位% qps Integer 节点qps tps Integer 节点tps collectTime String 数据采集时间

接口描述 删除数据库账号。调用该接口时，实例状态需要为运行中，否则将操作失败。 请求方法 POST URI /v1/instuser/drop 请求参数 名称 位置 类型 必选 说明 prodInstId body Long 是 实例id username body String 是 用户账号 force body Boolean 否 是否强制删除，默认为false。 当用户存在某对象的权限或者其他依赖关系时，删除账号会失败； 此参数为true时，账号拥有的对象以及拥有写权限的对象（包括table，schema等） 均会被强制删除，请谨慎用此选项 响应参数 名称 类型 说明 message String 消息提示 statusCode Integer 状态码 returnObj Object 返回结果 示例 请求示例 /v1/instuser/drop { "force": true, "prodInstId": "165776586159600008", "username": "test1" } 响应示例 { "message": "SUCCESS", "returnObj": {}, "statusCode": 800 } 错误码 访问ErrorCodes说明文档查看更多错误码。

名称 位置 类型 必选 说明 srcProdInstId body Long 是 源pg实例id backupId body Long 否 备份id,和restoreTime只能有一个为空 destProdInstId body Long 是 目标实例id restoreTime body String 否 备份保留周期内的任意时间点。格式：yyyyMMdd HH:mm:ss