健康狀況

/v1/health

使用 health 節點檢查 WhatsApp Business API 客戶端的狀態。此節點會對閘道器的健康狀況執行採樣,並傳回 JSON 回應。

要求

GET /v1/health

回應

回應會提供閘道器的健康狀態。

單一實例

{
    "health": {
       "gateway_status": "connected | connecting | uninitialized | unregistered"
    }
}

高可用性/多點連線

{
    "health": {
      "your-hostname1:your-container-id1": {
          "gateway_status": "connected | connecting | disconnected | uninitialized | unregistered",
          "role": "primary_master | secondary_master | coreapp"
      },
      "your-hostname2:your-container-id2": {
          "gateway_status": "connected | connecting | disconnected | uninitialized | unregistered",
          "role": "primary_master | secondary_master | coreapp"
      },
    }
}

參數

名稱描述類型

health

health 物件包含描述 WhatsApp Business API 客戶端健康狀況的欄位。

物件

gateway_status

核心應用程式與 WhatsApp 伺服器的連接狀態。
值:

  • connectedconnecting — 健康狀況良好。
  • uninitialized — 應用程式可能正在升級或初始化數據庫架構。請在幾分鐘後重試。如果畫面上仍舊顯示此狀態,請聯絡 WhatsApp 支援團隊
  • unregistered — 您需要註冊 WhatsApp Business API 客戶端。詳情請參閱註冊文件

字串

role

容器在高可用性/多點連線設定中的角色
primary_mastersecondary_mastercoreapp
如需進一步了解這些設定,請參閱高可用性和規模化文件

字串