Press CTRL+K to open search

Cato API - エンティティ検索

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

Cato APIを使用する前に、ぜひCato APIのサポートポリシーをご確認ください。

エンティティ検索の概要

エンティティ検索クエリは、サイトやVPNユーザーなど、Cato管理アプリケーションのエンティティと連携します。 クエリは、特定のIDの返却やアカウント内のエンティティリストの自動抽出に役立ちます。 各エンティティには、作成日や説明などの追加の関連情報が返却されます。

リセラーアカウントの場合、Cato APIに接続中の各顧客アカウント内で個別のAPIキーを作成できます。 レート制限とエンティティ検索APIクエリの詳細については、Cato APIのレート制限の理解をご覧ください。

エンティティ検索フィールドの詳細

これらはクエリのためにauditFeedフィールドが表示できる詳細です：

  • items - アイテムフィールドには各エンティティのデータが含まれます

  • 合計 - このクエリで返されたエンティティの総数

エンティティ検索アイテム

EntityInfoフィールドは、各エンティティのデータを表示し、含む内容は：

  • entity - id、管理アプリケーションからの名前、および通常はサイトまたはvpnUserのようなエンティティのタイプを表示します

  • description - 管理アプリケーションからのエンティティの説明

  • helperFields - エンティティに関する追加の関連情報とデータ

エンティティ検索合計

総フィールドは、Cato管理アプリケーション内のアカウント用のエンティティの総数を示します。 このフィールドの値は、APIのページネーション中に変化せず、取得されたレコードの総数との比較に役立ちます。

エンティティ検索引数

これらは、クエリで返されるエンティティを定義するために渡すことができる引数です：

  • accountIDs - アカウントID、複数のアカウントについては、IDを配列として入力します（必須引数）

  • type - タイプに一致するエンティティを返します。例えば、サイトやvpnUser（必須引数）

  • limit - このクエリで返されるエンティティの最大数（デフォルト値は50）

  • from - エントリのインデックスに基づいて、この特定のエンティティからクエリを開始します

  • search - この値に従って返却をフィルタリングします

  • entityIDs - エンティティID、複数のエンティティについては、IDを配列として入力します

  • sort - クエリが返すエンティティをどのように並べ替えるかを定義します

エンティティ検索アカウントID 引数

クエリで返されるデータに1つ以上のアカウントIDを入力します

このアカウントIDは、管理 > 一般情報ページに表示されます。

クエリに対するaccountIDs引数は必須です。

エンティティ検索タイプ引数

タイプ引数は、クエリで返されるエンティティデータを定義します。 これらはタイプ引数のサポートされている値です: サイト、vpnUser、および管理者。

タイプ引数はクエリで必須です。 それぞれの値に対してenumアイテムのスキーマを参照します

エンティティ検索リミット引数

リミット引数は、クエリが返すエンティティの最大数を定義します。 リミット引数を指定しない場合、クエリは50エンティティに制限されます。

各クエリは最大1000エンティティを返すことができます。

エンティティ検索からの引数

from引数は、クエリを開始するエンティティを定義します 例として、アカウントに100人のVPNユーザーがいる場合、60に設定して最後の40人のVPN ユーザーエンティティのみを表示します

クエリ内の最初のアイテムは0です。 したがって、アイテム20から開始する場合は19に設定してください。

エンティティ検索検索引数

検索引数はクエリをフィルタリングして、一致するエンティティ名のみを返します。 検索引数は文字列値です。

エンティティ検索エンティティID引数

entityIDs引数はIDに一致するエンティティのみを返します

エンティティ検索ソート引数

ソート引数を使うと、エンティティのIDや名前に応じてデータを昇順または降順にソートできます。

  • field - 名前またはidをフィールド値として使用します

  • order - 結果を昇順（asc）または降順（dsc）でソートします

例として、名前に基づいて結果を昇順（a-z）にソートするには、この引数を使用します：sort:{field"name", order:asc}

エンティティ検索親引数

親引数は、階層を持つエンティティをクエリするために使用され、エンティティとその親を提供する必要があります。 例として、タイプnetworkInterfaceの場合、親を以下の値とともに入力する必要があります：id<サイトID>、タイプ サイト。

エンティティ検索クエリのサンプル

このセクションには、エンティティ検索クエリの例が含まれています。

アカウント内のすべてのサイトをクエリする

Postmanスクリプトのサンプル

query entityLookup ($accountID: ID!, $type: EntityType!, $search: String) {
 entityLookup (accountID: $accountID, type: $type, search: $search) {
 items {
 entity {
 id
 name
 }
 }
 }
}

GraphQL変数

{
 "accountID": "26",
 "type": "site"
}

サイト名を使用してサイトを検索

Postmanスクリプトのサンプル

query entityLookup ($accountID: ID!, $type: EntityType!, $search: String) {
 entityLookup (accountID: $accountID, type: $type, search: $search) {
 items {
 entity {
 id
 name
 }
 }
 }
}

GraphQL変数

{
 "accountID": "26",
 "type": "site",
 "search": "MySite"
}

親引数を含めたnetworkInterfaceの検索

Postmanスクリプトのサンプル

query entityLookup ($accountID: ID!, $type: EntityType!, $parent: EntityInput!) {
 entityLookup (accountID: $accountID, type: $type, parent: $parent) {
 items {
 entity {
 id
 name
 type
 }
 description
 helperFields
 }
 }
}

GraphQL変数

{
 "accountID": "26",
 "type": "networkInterface",
 "parent": {
 "id": 52180,
 "type": "site"
 }
}

関連記事