3.patroni手册—patroni REST API

最新推荐文章于 2023-10-27 15:58:20 发布

qq_863444233

最新推荐文章于 2023-10-27 15:58:20 发布

阅读量616

点赞数

分类专栏： database

原文链接：https://patroni.readthedocs.io/en/latest/rest_api.html

版权

本文详述了Patroni的REST API，包括健康检查、监控、集群状态、配置、故障转移和切换等关键端点的用法。这些API用于状态检查、系统监控、集群管理和故障处理，有助于确保PostgreSQL高可用性。

摘要由CSDN通过智能技术生成

3.patroni REST API

Patroni有丰富的REST API，这些接口他们在竞争领导者的时候会有用。通过patronictl工具实现failovers/switchovers/reinitialize/restarts/reloads，HAProxy或任何其他类型的负载平衡器来执行HTTP运行状况检查，当然也可以用于监视。下面是Patroni REST API端点的列表

健康检查端点

对于所有运行状况检查GET请求，Patroni将返回一个JSON文档，其中包含节点的状态以及HTTP状态代码。如果您不需要或不需要JSON文档，则可以考虑使用OPTIONS方法而不是GET

仅当Patroni节点作为领导者运行时，对Patroni REST API的以下请求将返回HTTP状态代码200：
- GET/
- GET/master
- GET/leader
- GET/primary
- GET/read-write
GET /replica: replica运行状况检查端点。仅当patroni节点处于running状态角色为副本且未设置noloadbalance标签时，他才返回HTTP状态代码200
GET/read-only：像上述端点一样，也包括主节点
GET/standby-leader：当patroni节点在"standby cluster"作为领导者运行时返回HTTP状态码200
GET/synchronousorGET/sync:当patroni节点作为同步备库运行时返回HTTP状态码200
GET/asynchronousorGET/async:当patroni节点作为异步备库运行时返回HTTP状态码200
GET/health当PostgreSQL启动并且处于运行状态时返回HTTP状态码200

监控端点

GET/patroni在patroni领导者竞争时会被使用。他也会被用来监控你的系统。该端点生成的JSON文档与运行状况检查端点生成的JSON具有相同的结构。

$ curl -s http://localhost:8008/patroni | jq .
{
   
  "state": "running",
  "postmaster_start_time": "2019-09-24 09:22:32.555 CEST",
  "role": "master",
  "server_version": 110005,
  "cluster_unlocked": false,
  "xlog": {
   
    "location": 25624640
  },
  "timeline": 3,
  "database_system_identifier": "6739877027151648096",
  "patroni": {
   
    "version": "1.6.0",
    "scope": "batman"
  }
}

集群状态端点

GET/cluster端点生成一个描述当前集群拓扑和状态的JSON文档

$ curl -s http://localhost:8008/cluster | jq .
{
     
  "members": [
    {
     
      "name": "postgresql0",
      "host": "127.0.0.1",
      "port": 5432,
      "role": "leader",
      "state": "running",
      "api_url": "http://127.0.0.1:8008/patroni",
      "timeline": 5,
      "tags": {
     
        "clonefrom"