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

entityLookupの概要

entityLookupクエリは、サイトやVPNユーザーなどのCato管理画面のエンティティと連携します。 このクエリは、エンティティ名を調べて特定のIDを返し、アカウント内のエンティティのリストを自動的に抽出するのに役立ちます。 各エンティティは、作成日や説明などの追加の関連情報とともに返されます。

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

entityLookup項目の詳細

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

• アイテム - 各エンティティのデータを含むアイテムフィールド
• 合計 - このクエリで返されるエンティティの合計数

entityLookup アイテム

EntityInfoフィールドには、各エンティティのデータが表示されます。含まれるもの：

• エンティティ - Cato管理画面からのID、名前、通常はサイトまたはvpnUserのエンティティの種類を表示します
• 説明 - Cato管理画面からのエンティティの説明
• helperFields - エンティティに関する追加の関連情報とデータ

entityLookup 合計

合計フィールドは、Cato管理画面のアカウントに対してエンティティの合計数を示します。 このフィールドの値は、APIのページネーション中に変更されず、抽出されたレコードの総数と簡単に比較するのに役立ちます。

entityLookupのための引数

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

• accountIDs - アカウントID、複数のアカウントの場合は、IDを配列として入力（必須引数）
• タイプ - サイトやvpnUserなど、種類に一致するエンティティを返します（必須引数）
• 制限 - このクエリで返されるエンティティの最大数（デフォルト値は50）
• 送信元 - エントリーのインデックスに従って、この特定のエンティティからクエリを開始
• 検索 - この値に従って戻りをフィルタリング
• エンティティID - 複数のエンティティの場合、IDを配列として入力
• 並べ替え - クエリが返すエンティティの並べ替え方法を定義

entityLookup アカウントIDの引数

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

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

クエリにはアカウントID引数が必須です。

entityLookup 種類 引数

種類引数は、クエリが返すエンティティデータを定義します。 これらは、種類引数に対応する値です: サイト、vpnUser、および 管理者。

種類引数は、クエリには必須項目です。 各値に対応する 列挙 アイテムについてのスキーマを参照してください。

entityLookup 制限 引数

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

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

entityLookup 開始 引数

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

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

entityLookup 検索 引数

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

entityLookup entityIDs 引数

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

entityLookup 並べ替え 引数

並べ替え引数により、エンティティのIDや名前に基づいてデータを昇順または降順に並べ替えることができます。

• フィールド - フィールド値として名前またはIDを使用
• 順序 - 結果を昇順 (asc) または降順 (dsc) に並べ替え

たとえば、名前に基づいて結果を昇順 (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"
    }
}