官方地址:https://www.consul.io/docs/agent/http.html
consul的主要接口是RESTful HTTP API,該API可以用來增刪查改nodes、services、checks、configguration。所有的endpoints主要分為以下類別:
kv - Key/Value存儲 agent - Agent控制 catalog - 管理nodes和services health - 管理健康監測 session - Session操作 acl - ACL創建和管理 event - 用戶Events status - Consul系統狀態
下面我們就單獨看看每個模塊的具體內容。
agent endpoints:agent endpoints用來和本地agent進行交互,一般用來服務注冊和檢查注冊,支持以下接
/v1/agent/checks : 返回本地agent注冊的所有檢查(包括配置文件和HTTP接口) /v1/agent/services : 返回本地agent注冊的所有 服務 /v1/agent/members : 返回agent在集群的gossip pool中看到的成員 /v1/agent/self : 返回本地agent的配置和成員信息 /v1/agent/join/<address> : 觸發本地agent加入node /v1/agent/force-leave/<node>>: 強制刪除node /v1/agent/check/register : 在本地agent增加一個檢查項,使用PUT方法傳輸一個json格式的數據 /v1/agent/check/deregister/<checkID> : 注銷一個本地agent的檢查項 /v1/agent/check/pass/<checkID> : 設置一個本地檢查項的狀態為passing /v1/agent/check/warn/<checkID> : 設置一個本地檢查項的狀態為warning /v1/agent/check/fail/<checkID> : 設置一個本地檢查項的狀態為critical /v1/agent/service/register : 在本地agent增加一個新的服務項,使用PUT方法傳輸一個json格式的數據 /v1/agent/service/deregister/<serviceID> : 注銷一個本地agent的服務項
catalog endpoints:catalog endpoints用來注冊/注銷nodes、services、checks
/v1/catalog/register : Registers a new node, service, or check /v1/catalog/deregister : Deregisters a node, service, or check /v1/catalog/datacenters : Lists known datacenters /v1/catalog/nodes : Lists nodes in a given DC /v1/catalog/services : Lists services in a given DC /v1/catalog/service/<service> : Lists the nodes in a given service /v1/catalog/node/<node> : Lists the services provided by a node
health endpoints:health endpoints用來查詢健康狀況相關信息,該功能從catalog中單獨分離出來
/v1/healt/node/<node>: 返回node所定義的檢查,可用參數?dc= /v1/health/checks/<service>: 返回和服務相關聯的檢查,可用參數?dc= /v1/health/service/<service>: 返回給定datacenter中給定node中service /v1/health/state/<state>: 返回給定datacenter中指定狀態的服務,state可以是"any", "unknown", "passing", "warning", or "critical",可用參數?dc=
session endpoints:session endpoints用來create、update、destory、query sessions
/v1/session/create: Creates a new session /v1/session/destroy/<session>: Destroys a given session /v1/session/info/<session>: Queries a given session /v1/session/node/<node>: Lists sessions belonging to a node /v1/session/list: Lists all the active sessions
acl endpoints:acl endpoints用來create、update、destory、query acl
/v1/acl/create: Creates a new token with policy /v1/acl/update: Update the policy of a token /v1/acl/destroy/<id>: Destroys a given token /v1/acl/info/<id>: Queries the policy of a given token /v1/acl/clone/<id>: Creates a new token by cloning an existing token /v1/acl/list: Lists all the active tokens
event endpoints:event endpoints用來fire新的events、查詢已有的events
/v1/event/fire/<name>: 觸發一個新的event,用戶event需要name和其他可選的參數,使用PUT方法 /v1/event/list: 返回agent知道的events
status endpoints:status endpoints用來或者consul 集群的信息
/v1/status/leader : 返回當前集群的Raft leader /v1/status/peers : 返回當前集群中同事