接口功能介绍 自动备份任务下次开始时间。 接口约束 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，结束时间默认为当前时间。

接口描述 修改Postgresql实例IP白名单。 请求方法 PUT URI /v1/whitelist/modify 请求参数 名称 位置 类型 必选 说明 prodInstId body Long 是 实例id mode body String 是 修改模式： cover：用ipList中的IP覆盖原白名单 delete：把ipList的IP从白名单中移除,如果有白名单中不存在的IP，会被跳过 append：把ipList中的IP加入白名单 ipList body List 是 IP列表 响应参数 名称 类型 说明 message String 消息提示 statusCode Integer 状态码 returnObj Object 所有的返回信息都以JSON形式保存 示例 请求示例 /v1/whiteList/modifyIPWhiteList { "ipList": [ "127.0.0.1", "192.168.174.1" ], "mode": "delete", "prodInstId": 15 } 响应示例 { "message": "SUCCESS", "opMessage": "", "returnObj": {}, "statusCode": 800 } 错误码 访问ErrorCodes说明文档查看更多错误码。

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

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

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

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

名称 二级节点 类型 说明 message String 消息提示 statusCode Integer 状态码 returnObj Object 所有的返回信息都以JSON形式保存 enableDbName Boolean 数据库名是否可用 true:可用 false:不可用

接口描述 删除PostgreSQL实例下的某个数据库 请求方法 POST URI /v1/database/drop 请求参数 名称 位置 类型 必选 说明 prodInstId body Long 是 实例id dbName body String 是 数据库名称 响应参数 名称 类型 说明 message String 消息提示 statusCode Integer 状态码 returnObj Object 所有的返回信息都以JSON形式保存 示例 请求示例 /v1/database/drop { "dbName": "myDb", "prodInstId": 1 } 响应示例 { "message": "SUCCESS", "returnObj": {}, "statusCode": 800 } 错误码 访问ErrorCodes说明文档查看更多错误码。

名称 位置 类型 必选 说明 prodInstId body Long 是 实例id dbName body String 是 数据库名称 description body String 否 数据库描述，长度为2~256个字符。 以中文、英文字母开头，可以包含数字、中文、英文、下划线（）、短横线（）

接口描述 撤销账号对数据库下schema的访问权限。调用该接口时，实例必须满足以下条件，否则将操作失败： 实例状态为运行中。 数据库状态为运行中。 请求方法 POST URI /v1/instuser/revokeprivilege 请求参数 名称 位置 类型 必选 说明 prodInstId body Long 是 实例id username body String 是 用户账号 dbName body String 是 数据库名称 schemaName body String 否 schema名称，默认public 响应参数 名称 类型 说明 message String 消息提示 statusCode Integer 状态码 returnObj Object 返回结果 示例 请求示例 /v1/instuser/revokeUserPrivilege { "dbName": "testdb", "prodInstId": "165776586159600008", "schemaName": "testSchema", "username": "pguser" } 响应示例 { "message": "SUCCESS", "returnObj": {}, "statusCode": 800 } 错误码 访问ErrorCodes说明文档查看更多错误码。

接口描述 撤销服务账号对PostgreSQL实例的访问权限。当技术支持通过服务账号解决了您的问题后，您可以通过该接口释放服务账号对您PostgreSQL实例的访问权限。 请求方法 POST URI /v1/instuser/revokeoperator 请求参数 名称 位置 类型 必选 说明 prodInstId body Long 是 实例id database body String 是 需要授权访问的数据库名称。 schema body String 否 需要授权访问的模式名称。不指定默认为public 响应参数 名称 类型 说明 message String 消息提示 statusCode Integer 状态码 returnObj Object 返回结果 示例 请求示例 /v1/instuser/revokeOperatorPermission { "database": "test", "prodInstId": "165776586159600008", "schema": "test" } 响应示例 { "message": "SUCCESS", "returnObj": {}, "statusCode": 800 } 错误码 访问ErrorCodes说明文档查看更多错误码。

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

名称 位置 类型 必选 说明 prodInstId body Long 是 实例id username body String 是 用户账号 dbName body String 是 需要授权访问的数据库名称。 schemaName body String 否 需要授权访问的模式名称。不指定默认为public userPrivilege body String 是 账号权限，取值： 1.readwrite：读写。拥有指定模式下所有表的select,insert,update,delete,truncate权限 2.readonly：只读。拥有指定模式下所有表的select权限

名称 位置 类型 必选 说明 prodInstId query String 是 实例id key query String 否 保留关键字的类型，取值: U：不保留关键字，可以用于任何identity（视图、表、函数、类型、索引、字段、类型 等名称）。 R：保留关键字，不可用于任何identity。 T：保留关键字，但是可用于函数、类型名。 C：不保留关键字，但是不可用于函数、类型名。 key为空，查询全部。

名称 位置 类型 必选 说明 prodInstId query Long 是 实例id username query String 否 用户账号 pageNum query Integer 是 页码。取值为大于0且不超过Integer的最大值。 pageSize query Integer 是 页大小，范围1500

本页介绍关系型数据库的服务等级协议。 自2023年5月30日起，新版关系型数据库服务等级协议生效。详情请参见这里。 协议历史版本请参见关系型数据库服务等级协议 历史版本（20191111）。

本文介绍了MySQL全表扫描导致CPU高的问题的解决方法。 场景描述 mysqld CPU开销 100%。 原因分析 1. 在控制台查看MySQL实例监控信息，确定是数据库实例的CPU占用高。 查看监控信息的具体操作，请参见查看监控指标。 2. 查看processlist。虽然无明显AP类查询，但有个select count(1) 的并发较高。 3. explain sql查看执行计划，发现该sql采用全表扫描的方式。 解决方案 该SQL语句中存在where uuid$x的查询，为了避免进行全表扫描，可以为uuid增加索引。 上图加索引前，cpu的开销为200%。 sql：alter table txxpicture add index idxuuid(uuid); 上图加索引后，cpu开销由200%降低至22.9%。

接口描述 查询资源池列表 接口约束 无 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

本节介绍了数据库基本使用中的常见问题。 如何查看当前连接数据库的session ID以及登录时间 在数据库中执行如下命令，其中pid为对应的当前连接sessionID，backendstart为该连接的登录时间。 select pid, backendstart from pgstatactivity; 为什么重置密码后新密码没有生效 可能原因：密码重置发生在备份操作之后，执行恢复操作时，恢复为旧密码。 定位思路：密码重置之后是否执行了恢复操作。 解决方法：在控制台实例详情页面，重新执行“重置密码”，具体请参见重置管理员(root帐号)密码。 RDSPostgreSQL在磁盘扩容、系列扩容和规格变更场景下是否一直可用 RDSPostgreSQL支持包括磁盘扩容、系列扩容和规格变更在内的多种场景。上述几种场景对RDSPostgreSQL可用性影响如下： 在磁盘扩容和系列扩容场景下，RDS实例服务可用，用户业务不受影响，但不允许退订、续订以及重启等操作。 在CPU/内存规格变更场景下，会出现5~15分钟的业务不可用。修改CPU/内存后，将会重启数据库。为避免对业务影响，请选择业务低峰期操作。 是否可以访问RDSPostgreSQL备实例 RDSPostgreSQL数据库支持一主一备的高可用模式，其中，主实例可以访问，备实例无法直接访问，仅用于主备切换实现数据库高可用。 RDSPostgreSQL的备实例支持与主实例切换，切换后原来的备实例会变成主实例，主备实例的数据会实时同步。