Press CTRL+K to open search

設定 API - updateSiteGeneralDetails

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

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

updateSiteGeneralDetailsの概要

Cato管理アプリケーション（ネットワーク > サイト > {site name} > サイト設定 > 一般）のサイトの 一般 セクションにおいて、以下の設定を更新するために、updateSiteGeneralDetails ミューテーション API を使用します

  • 名前

  • 説明

  • タイプ

  • タイムゾーン

  • 国

  • 州

  • 住所

アカウントの accountId を見つける方法

このアカウント ID は Cato管理画面 には表示されず、代わりに Cato管理画面 の URL に含まれる数値です。 例えば、以下のURLではアカウントIDが26になります: https://cc.catonetworks.com/#!/26/topology

このIDをサイト作成用APIのaccountId引数に入力してください。例として：

site(accountId: 26) {
 addSocketSite(input: $addSocketSite) { 
 siteId 
 } 
}

サイト用の siteID を見つける方法

サイト ID は Cato管理画面には表示されませんが、次の方法で確認できます：

  • entityLookup API クエリを使用し（Cato API - EntityLookupを参照）、type に サイト を指定します

    サイトの名前として値を指定した検索パラメータを使用することができ、クエリはサイトIDを返します

  • サイトを選択した場合の Cato管理画面のURLに表示される番号（ネットワーク > サイト > {site name}）。 例えば、次のURLではサイトIDが12345になります: https://cc.catonetworks.com/#/26/sites/12345/networkAnalytics

updateSiteGeneralDetails 引数の詳細

これらは、Cato設定 API を使用してサイトの一般設定を更新するための引数です。 引数はオプションとマークされていない限り必須です：

  • 名前 - サイトの名前

  • サイトタイプ - 組織内のサイトタイプ、例：クラウドデータセンター

  • 説明 - (オプション) サイトの説明

  • サイトロケーション - サイトの物理的な所在地に関するデータ

updateSiteGeneralDetails 名称

サイトの名前を更新します。

updateSiteGeneralDetails サイトタイプ

サイトタイプ は、Cato管理アプリケーションのモニタリング > トポロジ スクリーンで使用されるアイコンを決定するサイトのタイプを定義する列挙型引数です。

これらはオプションです：

  • 支店 - 物理または仮想のサイト

  • 本社 - 企業本社のための物理的なサイト

  • CLOUD_DC - クラウドベースのデータセンターのための仮想サイト

  • DATACENTER - データセンターのための物理的なサイト

updateSiteGeneralDetails 説明 (オプション)

説明 はサイトを記述するためのオプションのフリーテキスト項目です。

updateSiteGeneralDetails サイトロケーション

siteLocation 引数は、サイトの物理的な詳細を定義します。 countryCode は、お客様のアカウントの特定のリージョンで利用可能なサイトライセンス数に関連しています。

entityLookup API クエリを使用してこれらの引数の値を取得できます。Cato API - EntityLookupを参照してください。

これらはsiteLocation引数です：

  • countryCode - サイトがある国の二文字のコード（ISO 3166-1 alpha-2）

    entityLookup では、type に country を指定します

  • stateCode - （オプション）該当する国におけるサイトがある州

    entityLookup では、type に countryState を指定します

  • timezone - サイトのタイムゾーンで、メンテナンスウィンドウの時間枠をソケットおよびvSocketのアップグレードのために設定します

    entityLookup では、type に timezone を指定します

  • 住所 - （オプション）物理サイトの番地

サンプル Postman スクリプト

mutation updateSiteGeneralDetails ($accountId: ID!, $siteID: ID!, $input: UpdateSiteGeneralDetailsInput!) {
 site(accountId: $accountId) {
 updateSiteGeneralDetails (siteId: $siteID, input: $input) {
 siteId
 }
 }
}

GraphQL 変数

{
 "accountId": "",
 "siteID": "",
 "input": {
 "name": "MySite",
 "description": "My first DC using the API",
 "siteType": "DATACENTER",
 "siteLocation": {
 "countryCode": "FR",
 "timezone": "Europe/Paris"
 }
 }
}

関連リソース

関連記事