Press CTRL+K to open search

設定 API - updateHa

  • 更新日 Jul 30, 2026
  • 公開日 Jun 24, 2026
  • 1 分で読めます
Prev Next

Cato API を使用する前に、Cato API のサポートポリシーを確認することを強くお勧めします。

updateHa の概要

Cato 管理アプリケーション（ネットワーク>サイト>{site name}>サイト設定>ソケット）で Socket High Availability (HA) 設定が有効なサイトの ソケット セクションで次の設定を更新するために updateHa ミューテーション API を使用します：

  • プライマリおよびセカンダリソケットの管理 IP アドレス

  • VRID - プライマリソケットがダウンしているとき、および再び機能するようになったときを識別する VRRP メッセージの ID

注：

両方のソケットがサイトに割り当てられ、Cato 管理アプリケーションを使用してソケット HA サイトとして構成されている場合にのみ、updateHa API を実行できます。

サイトの siteID の特定

Cato 管理アプリケーションにはサイト ID が表示されないため、以下の方法で見つけることができます：

  • entityLookup API クエリを使用して（Cato API - EntityLookup を参照）、値が サイト である タイプ を使用します

    search パラメータを使用し、値としてサイトの名前を指定してクエリを実行すると、サイト ID が返されます。

  • Cato 管理アプリケーションでサイトを選択したときの URL の番号（ネットワーク>サイト>{site name}）。 たとえば、次の URL のサイト ID は 12345 です：  https://cc.catonetworks.com/#/26/sites/12345/networkAnalytics

updateHa 引数の詳細

Cato 設定 API を使用して、次の HA ソケット設定を更新するための引数です。 すべての updateHaInput 引数は任意です：

  • primaryManagementIp - プライマリソケットの管理 IP アドレス

  • secondaryManagementIp- セカンダリソケットの管理 IP アドレス

  • VRID - VRRP メッセージ用の仮想ルーター識別子

updateHaInput primaryManagementIp

プライマリソケットの管理 IP アドレスを更新します。 この IP アドレスを使用してプライマリソケットの Socket WebUI にアクセスできます。

updateHaInput secondaryManagementIp

セカンダリソケットの管理 IP アドレスを更新します。 この IP アドレスを使用してセカンダリソケットの Socket WebUI にアクセスできます。

updateHaInput vrid

VRID（仮想ルーター識別子）を VRRP メッセージ用にプライマリおよびセカンダリソケットの間で更新します。 デフォルト VRID は 100 です。

Sample Postman スクリプト

ミューテーション updateHa ($accountId: ID!, $siteId: ID!, $input: UpdateHaInput!) {
    site(accountId: $accountId) {
        updateHa (siteId: $siteId, input: $input) {
            siteId
        }
    }
}

GraphQL 変数

{
    "accountId": "26",
    "siteId": 126,
    "input": {
        "primaryManagementIp": "192.168.4.2",
        "secondaryManagementIp": "192.168.4.3",
        "vrid": 100
    }
}

関連リソース

関連記事