首页
产品
CLup:PostgreSQL高可用集群平台 CMiner: PostgreSQL中的CDC CData高性能数据库云一体机 CBackup数据库备份恢复云平台 CPDA高性能双子星数据库机 CSYun超融合虚拟机产品 ZQPool数据库连接池 ConshGuard数据保护产品
解决方案
数据库专业技术服务全栈式PostgreSQL解决方案Oracle分布式存储化数据库云PolarDB一体化解决方案
文章
客户及伙伴
中启开源
关于我们
公司简介 联系我们
中启开源
修改标题
往前插入
往后插入
删除

接口详解

ZQpool 接口说明:

Get参数携带:url中key=value

Post参数携带:x-www-urlencoded

1. 获取连接池状态

POST /pool_list_be_db

Body Parameters

  1. pool_name: kuafu.sundb
  2. mgr_token: csutoken

Params:

Name Location Type Required Description
body body object no none
» pool_name body string no 连接池名称
» mgr_token body string no 接口鉴权密钥

返回示例:

成功

  1. {
  2. "code": 0,
  3. "data": [
  4. {
  5. "Portal": "10.197.166.36:5432",
  6. "State": "Online",
  7. "RwState": "Standby"
  8. },
  9. {
  10. "Portal": "10.197.166.37:5432",
  11. "State": "Online",
  12. "RwState": "Primary"
  13. }
  14. ]
  15. }

失败

  1. {
  2. "code": 1,
  3. "message": "pool(kuafu.sundb1) not exists"
  4. }

Responses:

HTTP Status Code Meaning Description Data schema
200 OK 成功 Inline

2. 添加数据库节点

POST /pool_add_be_db

Body Parameters

  1. pool_name: kuafu.sundb
  2. db_portal: 10.197.166.116:5414
  3. mgr_token: csutoken

Params:

Name Location Type Required Description
body body object no none
» pool_name body string yes 连接池名字
» db_portal body string yes 多个节点使用’,’分割,示例:10.197.166.115:5414,10.197.166.116:5414
» mgr_token body string yes 鉴权密钥

返回示例:

成功

  1. {
  2. "code": 0,
  3. "message": "Add portal(10.197.166.116:5414) to pool(kuafu.sundb) success."
  4. }

Responses:

HTTP Status Code Meaning Description Data schema
200 OK 成功 Inline

3. 移除数据库节点

POST /pool_remove_be_db

Body Parameters

  1. pool_name: kuafu.sundb
  2. db_portal: 10.197.166.115:5414
  3. mgr_token: csutoken

Params:

Name Location Type Required Description
body body object no none
» pool_name body string yes 连接池名字
» db_portal body string yes 多个节点使用’,’分割,示例:10.197.166.115:5414,10.197.166.116:5414
» mgr_token body string yes 鉴权密钥

返回示例:

成功

  1. {
  2. "code": 0,
  3. "message": "Remove portal(10.197.166.115:5414) from pool(kuafu.sundb) success."
  4. }

Responses:

HTTP Status Code Meaning Description Data schema
200 OK 成功 Inline

4. 修改后端连接信息

POST /pool_modify_be_info

Body Parameters

  1. pool_name: kuafu.sundb
  2. be_user: postgresq
  3. be_passwd: zqpool
  4. mgr_token: csutoken

Params:

Name Location Type Required Description
body body object no none
» pool_name body string yes 连接池名字
» be_user body string no 后端用户,需要先实际修改数据库中的信息。
» be_passwd body string no 后端用户密码,需要先实际修改数据库中的信息。
» mgr_token body string yes 鉴权密钥

返回示例:

成功

  1. {
  2. "code": 0,
  3. "message": "Success modify the pool information."
  4. }

失败

  1. {
  2. "code": -1,
  3. "message": "Could not connect 10.197.166.75:5414, EOF, Please check the user and password."
  4. }

Responses:

HTTP Status Code Meaning Description Data schema
200 OK 成功 Inline

5. 添加一个连接池

POST /pool_add_pool

Body Parameters

  1. pool_id: "2"
  2. mgr_token: csutoken

Params:

Name Location Type Required Description
body body object no none
» pool_id body string yes 需要先修改配置文件,然后再调用这个接口,传入池的ID号
» mgr_token body string yes 鉴权密钥

返回示例:

成功

  1. {
  2. "code": 0,
  3. "message": "PoolServer add pool(ID=2) success."
  4. }

Responses:

HTTP Status Code Meaning Description Data schema
200 OK 成功 Inline

6. 修改前端连接信息

POST /pool_modify_fe_info

Body Parameters

  1. pool_name: kuafu.sundb
  2. fe_user: kuafu
  3. fe_passwd: chase
  4. fe_dbname: sundb
  5. mgr_token: csutoken

Params:

Name Location Type Required Description
body body object no none
» pool_name body string yes 连接池名字
» fe_user body string no 前端连接用户
» fe_passwd body string no 前端连接密码,如果需要中断业务访问,进入维护模式,可以修改此处,修改完成后将无法访问数据库。
» fe_dbname body string no 前端连接数据库
» mgr_token body string yes 鉴权密钥

返回示例:

成功

  1. {
  2. "code": 0,
  3. "message": "Success modify the pool information."
  4. }

Responses:

HTTP Status Code Meaning Description Data schema
200 OK 成功 Inline

7. 获取连接池信息

POST /pool_get_pool_list

Body Parameters

  1. pool_name: a
  2. mgr_token: csutoken

Params:

Name Location Type Required Description
body body object no none
» pool_name body string yes 如果指定pool_name则是查询指定的连接池信息,填空值则是查询所有连接池信息。
» mgr_token body string yes 鉴权密钥

返回示例:

成功

  1. {
  2. "code": 0,
  3. "data": [
  4. {
  5. "ID": "1",
  6. "FeMaxConns": 200,
  7. "FeUser": "kuafu",
  8. "FePasswd": "chase",
  9. "FeDbName": "sundb",
  10. "BeRwConnCount": 100,
  11. "BeRdConnCount": 100,
  12. "BeUser": "postgres",
  13. "BePasswd": "postgres",
  14. "BeDbName": "postgres",
  15. "DbVersion": "14.11",
  16. "MgrAddr": "*",
  17. "ListenAddr": "*",
  18. "BePortals": [
  19. "10.197.166.36:5432",
  20. "10.197.166.37:5432"
  21. ]
  22. }
  23. ]
  24. }

失败

  1. {
  2. "code": 1,
  3. "message": "Cant get any records for the pool(ka)."
  4. }

Responses:

HTTP Status Code Meaning Description Data schema
200 OK 成功 Inline

8. 移除一个连接池

POST /pool_remove_pool

Body Parameters

  1. pool_name: houyi.sundb
  2. mgr_token: csutoken

Params:

Name Location Type Required Description
body body object no none
» pool_name body string yes 连接池名字,此操作不会修改配置文件,如果此连接池确定不再加回,应在配置文件中将其注释掉,否则下次重启连接池会自动加回。
» mgr_token body string yes 鉴权密钥

返回示例:

成功

  1. {
  2. "code": 0,
  3. "message": "Remove the pool(houyi.sundb) success."
  4. }

失败

  1. {
  2. "code": 1,
  3. "message": "Remove the pool(houyi.sundb) failed, the pool(poolName=houyi.sundb) is not exists."
  4. }

Responses:

HTTP Status Code Meaning Description Data schema
200 OK 成功 Inline

9. 修改连接数

POST /pool_modify_conns

Body Parameters

  1. pool_name: kuafu.sundb
  2. fe_max_conns: "200"
  3. be_rw_conns: "100"
  4. be_rd_conns: "100"
  5. mgr_token: csutoken

Params:

Name Location Type Required Description
body body object no none
» pool_name body string yes 连接池名字
» fe_max_conns body string no 前端最大连接数
» be_rw_conns body string no 只能往上增加,不能减少。可通过pool_get_pool_list获取当前的连接数设置。
» be_rd_conns body string no 后端只读最大连接数,只能往上增加,不能减少。可通过pool_get_pool_list获取当前的连接数设置。
» mgr_token body string yes 鉴权密钥

返回示例:

成功

  1. {
  2. "code": 0,
  3. "message": "Success modify the pool information."
  4. }

失败

  1. {
  2. "code": 1,
  3. "message": "The pool(poolName=kuafu.sundb1) is not exists."
  4. }

Responses:

HTTP Status Code Meaning Description Data schema
200 OK 成功 Inline

10. 获取当前的日志级别

POST /get_log_level

Body Parameters

  1. mgr_token: csutoken

Params:

Name Location Type Required Description
body body object no none
» mgr_token body string no none

返回示例:

成功

  1. {
  2. "code": 0,
  3. "message": "Current log level is info."
  4. }

Responses:

HTTP Status Code Meaning Description Data schema
200 OK 成功 Inline

11. 设置日志级别

POST /set_log_level

Body Parameters

  1. loglevel: warn
  2. mgr_token: csutoken

Params:

Name Location Type Required Description
body body object no none
» loglevel body string yes 设置的日志级别,info(默认),warn,error,panic,fatal
» mgr_token body string no none

返回示例:

成功

  1. {
  2. "code": 0,
  3. "message": "set log level to warn success."
  4. }

Responses:

HTTP Status Code Meaning Description Data schema
200 OK 成功 Inline
目录
img