接口详解

ZQpool 接口说明:

Get参数携带：url中key=value

Post参数携带：x-www-urlencoded

1. 获取连接池状态

POST /pool_list_be_db

pool_name: kuafu.sundb
mgr_token: csutoken

Params:

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

返回示例:

成功

{
  "code": 0,
  "data": [
    {
      "Portal": "10.197.166.36:5432",
      "State": "Online",
      "RwState": "Standby"
    },
    {
      "Portal": "10.197.166.37:5432",
      "State": "Online",
      "RwState": "Primary"
    }
  ]
}

失败

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

Responses:

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

2. 添加数据库节点

POST /pool_add_be_db

pool_name: kuafu.sundb
db_portal: 10.197.166.116:5414
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	鉴权密钥

返回示例:

成功

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

Responses:

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

3. 移除数据库节点

POST /pool_remove_be_db

pool_name: kuafu.sundb
db_portal: 10.197.166.115:5414
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	鉴权密钥

返回示例:

成功

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

Responses:

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

4. 修改后端连接信息

POST /pool_modify_be_info

pool_name: kuafu.sundb
be_user: postgresq
be_passwd: zqpool
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	鉴权密钥

返回示例:

成功

{
  "code": 0,
  "message": "Success modify the pool information."
}

失败

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

Responses:

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

5. 添加一个连接池

POST /pool_add_pool

pool_id: "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	鉴权密钥

返回示例:

成功

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

Responses:

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

6. 修改前端连接信息

POST /pool_modify_fe_info

pool_name: kuafu.sundb
fe_user: kuafu
fe_passwd: chase
fe_dbname: sundb
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	鉴权密钥

返回示例:

成功

{
  "code": 0,
  "message": "Success modify the pool information."
}

Responses:

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

7. 获取连接池信息

POST /pool_get_pool_list

pool_name: a
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	鉴权密钥

返回示例:

成功

{
    "code": 0,
    "data": [
        {
            "ID": "1",
            "FeMaxConns": 200,
            "FeUser": "kuafu",
            "FePasswd": "chase",
            "FeDbName": "sundb",
            "BeRwConnCount": 100,
            "BeRdConnCount": 100,
            "BeUser": "postgres",
            "BePasswd": "postgres",
            "BeDbName": "postgres",
            "DbVersion": "14.11",
            "MgrAddr": "*",
            "ListenAddr": "*",
            "BePortals": [
                "10.197.166.36:5432",
                "10.197.166.37:5432"
            ]
        }
    ]
}

失败

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

Responses:

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

8. 移除一个连接池

POST /pool_remove_pool

pool_name: houyi.sundb
mgr_token: csutoken

Params:

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

返回示例:

成功

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

失败

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

Responses:

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

9. 修改连接数

POST /pool_modify_conns

pool_name: kuafu.sundb
fe_max_conns: "200"
be_rw_conns: "100"
be_rd_conns: "100"
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	鉴权密钥

返回示例:

成功

{
  "code": 0,
  "message": "Success modify the pool information."
}

失败

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

Responses:

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

10. 获取当前的日志级别

POST /get_log_level

mgr_token: csutoken

Params:

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

返回示例:

成功

{
  "code": 0,
  "message": "Current log level is info."
}

Responses:

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

11. 设置日志级别

POST /set_log_level

loglevel: warn
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

返回示例:

成功

{
  "code": 0,
  "message": "set log level to warn success."
}

Responses:

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