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

entityLookup の概要

entityLookup クエリーは、サイトや VPN ユーザーなどの Cato管理画面のエンティティと連携します。 このクエリーは、特定の ID を返すためのエンティティ名の検索や、アカウント内のエンティティリストの自動抽出を支援します。 各エンティティには、作成日や説明などの追加の関連情報が返されます。

販売代理店アカウントの場合、カト API に接続している各顧客アカウント内に個別の API キーを作成できます。 レート制限と entityLookup API クエリーの詳細については、Cato API レート制限の理解を参照してください。

entityLookup フィールドの詳細

監査フィードフィールドがクエリーに対して表示できる詳細は次のとおりです：

• items - 各エンティティのデータを含むアイテムフィールド
• total - このクエリーに対して返されるエンティティの総数

entityLookup アイテム

EntityInfo フィールドには、次の項目を含む各エンティティのデータが表示されます：

• entity - Cato管理画面からのid、nameおよび通常サイトまたはvpnUserであるエンティティのtypeを示します
• description - Cato管理画面からのエンティティの説明
• helperFields - エンティティに関する追加の関連情報とデータ

entityLookup 合計

Total フィールドは、Cato管理画面でアカウント用のエンティティの総数を示します。 このフィールドの値は API 戻り値のページネーション中に変わることはなく、取得されたレコードの総数と簡単に比較することができます。

entityLookup の引数

このクエリーによって返されるエンティティを定義および渡すことができる引数は次のとおりです：

• accountIDs - アカウント ID。複数のアカウントの場合は、ID を配列として入力します（必須引数）。
• type - タイプに一致するエンティティを返します。例: siteまたはvpnUser（必須引数）。
• limit - このクエリーに対して返されるエンティティの最大数（デフォルト値は 50）。
• from - エントリーのインデックスに従って、この特定のエンティティからクエリーを開始します。
• search - この値に従って返された結果をフィルターします。
• entityIDs - エンティティ ID。複数のエンティティの場合は、ID を配列として入力します。
• sort - クエリーが返すエンティティの並べ替え方法を定義します。

entityLookup accountIDs 引数

クエリが返すデータのアカウント ID を1つ以上入力します。

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

クエリーには accountIDs 引数が必須です。

entityLookup type 引数

type 引数は、クエリーが返すエンティティデータを定義します。 type 引数のサポートされている値は次のとおりです：site、vpnUser、およびadmins。

このクエリーには type 引数が必須です。 各値のenumアイテムのスキーマを参照してください。

entityLookup limit 引数

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

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

entityLookup from 引数

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

クエリーの最初の項目は 0 です。 アイテム 20 から開始して表示したい場合、19 に設定します。

entityLookup 検索引数

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

entityLookup entityIDs 引数

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

entityLookup ソート引数

sort 引数を使用して、エンティティの id または name に従ってデータを昇順または降順に並べ替えます。

• フィールド - フィールド値としてnameまたはidを使用します
• オーダー - 結果を昇順（asc）または降順（dsc）で並べ替えます

例えば、name に従って結果を昇順（a-z）で並べ替えるには、この引数を使用します：sort:{field"name", order:asc}

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

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

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

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

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

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