consul 的 HTTP API 和使用方法



建議讀者先學習筆者的另一篇文章 學習搭建 Consul 服務發現與服務網格-有豐富的示例和圖片,這樣了解 consul 大體的結構和學習集群搭建,摸清 consul 的服務注冊發現配置方法。

本文 HTTP API 請求使用 postman 測試,讀者可以打開 https://documenter.getpostman.com/view/5988188/TzCV4jqL 查看 HTTP 文檔,並可直接導入 postman 測試。

搭建起 consul

Consul 支持基礎結構的服務注冊和發現(稱為內部服務),也支持外部服務(第三方 SAAS服務以及無法直接運行 Consul 代理的其它環境,例如 redis)。

直接使用 sudo apt-get install consul命令即可安裝 consul,你也可以參考導讀中筆者的另一篇文章,里面提到了詳細的安裝方法。

然后我們使用命令啟動 consul:

consul agent -dev -client 0.0.0.0 -enable-script-checks -node=web -ui

上面配置指定了允許任何 ip 連接到此 consul,-enable-script-checks 開啟 consul 進行簡單的基於 ping 的運行狀況檢查;-node 命名此 consul 節點名稱為 web,並開啟 UI(-ui)訪問(端口8500)。

注:如果是生產環境,則應在 consul 的配置文件中啟用 enable_script_checks = true,以持久化配置。

Consul 的 HTTP API

Consul 的主要接口是 Restful HTTP API,這些 API 可以對節點、服務、檢查、配置等對象執行基本的 CRUD 操作。

官方 API 文檔地址:https://www.consul.io/api-docs/index

在 consul 中,有四類 HTTP API,agent、service、check、connect,后面會介紹這些 API 中常用 API 的操作和參數配置。

Service API

Service 相關的 API 都在 /v1/agent/service 下,這里來列一下這些 API 地址(省略了/v1),湊些字數。

  • /agent/services:該端點返回在本地代理程序中注冊的所有服務;
  • /agent/service/{service_id}:返回在本地代理上注冊的單個服務實例的完整服務定義;
  • /agent/health/service/name/{service_name}/ /agent/health/service/id/{service_id}:通過名稱或id檢索本地代理上的聚合服務狀態;
  • /agent/service/register:注冊服務;
  • /agent/service/deregister/{service_id} :注銷服務;
  • /agent/service/maintenance/{service_id}:該端點將給定的服務置於“維護模式”,在維護模式下,該服務將被標記為不可用,並且不會出現在DNS或API查詢中;

通過這些 API,可以注冊服務以及注銷服務,下面介紹一下一些只要的 API 的使用方法。

簡單地注冊服務

本小節介紹通過 HTTP API 方式,簡單注冊一個服務並配置健康檢查,接下來我們將使用 HTTP API 原生請求的方式,一步步了解 consul 中如何注冊服務,並了解一些參數的使用,這里盡量做到與編程語言無關。

這是官方文檔給出的一個注冊服務的配置示例:

{
  "id": "web1",
  "name": "web",
  "port": 80,
  "check": {
    "name": "ping check",
    "args": ["ping", "-c1", "learn.hashicorp.com"],
    "interval": "30s",
    "status": "passing"
  }
}

我們先來了解一下這個配置的字段。

id 為這個服務的唯一標記,而 name 表示此服務的邏輯名稱; check 是健康檢查的配置,后面會單獨介紹。

通過 HTTP API 注冊服務,請求的信息如下(curl命令):

curl --location -g --request PUT 'http://{{consul}}:8500/v1/agent/service/register' \
--data-raw '{
  "id": "web1",
  "name": "web",
  "port": 80,
  "check": {
    "name": "ping check",
    "args": ["ping", "-c1", "learn.hashicorp.com"],
    "interval": "30s",
    "status": "passing"
  }
}
'

如果要查詢相應的服務是否已經注冊,則可使用 /v1/catalog/service/{name} 查詢。

curl http://{{consul}}:8500/v1/catalog/service/web

查詢服務

由於我們配置了健康檢查,可以在 UI 上看到詳細結果。

ping失敗

健康檢查的配置和查詢

健康檢查配置:

  "check": {
    "name": "ping check",
    "args": ["ping", "-c1", "learn.hashicorp.com"],
    "interval": "30s",
    "status": "passing"
  }

check 對象用於運行狀況檢查,上面的配置就是每 30s 執行 ping 命令,檢查 learn.hashicorp.com 是否可以訪問,status 表示注冊時此服務的初始狀態。

args 最終會組合成一條命令: ping -c1 learn.hashicorp.com-c1 即表示只 ping 1次。ping 失敗時提示:

ping: learn.hashicorp.com: Temporary failure in name resolution

Consul 支持 Script, HTTP, TCP, Time to Live (TTL), Docker, and gPRC 等方式進行監控檢查,例如 HTTP 形式,可以這樣寫配置:

      "Definition": {
        "http": "https://learn.hashicorp.com/consul/",
        "interval": "30s"
      }

如果要獲得讀取本地節點上所有服務的運行狀況檢查結果,則可以直接通過 HTTP GET 請求 http://{{consul}}:8500/v1/agent/checks 獲得。結果如下:

{
    "service:web1": {
        "Node": "web",
        "CheckID": "service:web1",
        "Name": "ping check",
        "Status": "critical",
        "Notes": "",
        "Output": "ping: learn.hashicorp.com: Temporary failure in name resolution\n",
        "ServiceID": "web1",
        "ServiceName": "web",
        "ServiceTags": [],
        "Type": "script",
        "Definition": {},
        "CreateIndex": 0,
        "ModifyIndex": 0
    }
}

如果要單獨查詢節點上的某個服務,可以使用:

/health/service/{name}

如果要查詢某個節點上的所有服務,可以使用:

/health/node/{name}

本文內容較少,API 較多,不需要全部都測試一次,可以挑一些常用的了解即可。不同編程語言都有相應的庫,不需要基於 HTTP API 編寫代碼,可以直接調用官方提供的 SDK。


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM