Cato API를 사용하기 전에 Cato API 지원 정책을 검토할 것을 강력히 권장합니다.

entityLookup 개요

entityLookup 쿼리는 사이트 및 VPN 사용자와 같은 Cato 관리 애플리케이션 엔티티와 함께 작동합니다. 쿼리는 특정 ID를 반환하도록 엔티티 이름을 조회하고 계정의 엔티티 목록을 자동으로 추출하는 데 도움이 될 수 있습니다. 각 엔티티는 생성 날짜 및 설명과 같은 추가 관련 정보와 함께 반환됩니다.

리셀러 계정의 경우 연결 중인 각 고객 계정 내에 별도의 API 키를 생성할 수 있습니다. 속도 제한 및 entityLookup API 쿼리에 대한 자세한 내용은 Cato API 속도 제한 이해하기를 참조하십시오.

entityLookup 필드 세부사항

auditFeed 필드가 쿼리에서 보여줄 수 있는 세부사항은 다음과 같습니다:

• items - items 필드는 각 엔티티에 대한 데이터를 포함합니다.
• total - 이 쿼리에 대해 반환된 엔티티의 총 수

entityLookup 항목

EntityInfo 필드는 각 엔티티에 대한 데이터를 포함하는데, 다음과 같은 것이 있습니다:

• entity - Cato 관리 애플리케이션의 id, name 및 일반적으로 사이트나 vpnUser 유형의 엔티티를 표시합니다.
• description - Cato 관리 애플리케이션에서 가져온 엔티티의 설명
• helperFields - 엔티티에 대한 추가 관련 정보 및 데이터

entityLookup 총계

총계 필드는 Cato 관리 애플리케이션에서 계정의 총 엔티티 수를 보여줍니다. 이 필드의 값은 API 반환의 페이지 네이션 동안 변경되지 않으며, 검색된 총 레코드 수와 쉽게 비교할 수 있습니다.

entityLookup 인수

쿼리로 반환되는 엔티티를 정의 및 전달할 수 있는 인수는 다음과 같습니다:

• accountIDs - 계정 ID로, 여러 계정의 경우 배열로 ID를 입력합니다 (필수 인수)
• type - 유형을 일치시키는 엔티티를 반환하며, 예를 들면 site나 vpnUser (필수 인수)
• limit - 이 쿼리에 대해 반환된 최대 엔티티 수 (기본값은 50)
• from - 엔트리 인덱스에 따라, 이 특정 엔티티에서 쿼리를 시작합니다.
• search - 이 값을 기준으로 반환 필터링
• entityIDs - 여러 엔티티의 경우, 배열로 ID를 입력합니다.
• sort - 쿼리가 반환하는 엔티티를 정렬하는 방식 정의

entityLookup accountIDs 인수

쿼리가 반환하는 데이터의 계정 ID를 하나 이상 입력하십시오.

이 계정 ID는 관리 > 정보 페이지에 표시됩니다.

accountIDs 인수는 쿼리에 필수적입니다.

entityLookup 유형 인수

유형 인수는 쿼리가 반환하는 엔티티 데이터를 정의합니다. 유형 인수의 지원 값은 다음과 같습니다: site, vpnUser, 및 관리자.

유형 인수는 쿼리에 필수적입니다. 각 값에 대한 enum 항목을 보려면 스키마를 참조하십시오.

entityLookup 제한 인수

제한 인수는 쿼리가 반환하는 최대 엔티티 수를 정의합니다. 제한 인수를 지정하지 않으면 쿼리는 50개의 엔티티로 제한됩니다.

각 쿼리는 최대 1000개의 엔티티를 반환할 수 있습니다.

entityLookup 시작 인수

시작 인수는 쿼리를 시작할 엔티티를 정의합니다. 예를 들어, 계정에 100명의 VPN 사용자가 있는 경우, 60으로 설정하여 마지막 40개의 VPN 사용자 엔티티만 표시합니다.

쿼리의 첫 번째 항목은 0입니다. 따라서 20번째 항목부터 표시하려면 19로 설정하십시오.

entityLookup 검색 인수

검색 인수는 쿼리를 필터링하여 일치하는 엔티티 이름만 반환합니다. 검색 인수는 문자열 값입니다.

entityLookup entityIDs 인수

entityIDs 인수는 ID와 일치하는 엔티티만 반환합니다.

entityLookup 정렬 인수

정렬 인수는 ID 또는 엔티티의 이름에 따라 데이터를 오름차순 또는 내림차순으로 정렬할 수 있습니다.

• field - 필드 값으로 name 또는 id를 사용합니다.
• order - 결과를 오름차순(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
            }
            설명
            helperFields
            }
        }
    }
}

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