Skip to main content
모든 /v1 목록 엔드포인트는 동일한 envelope를 반환하며 동일한 방식으로 페이지네이션합니다. 토큰 기반이며 순방향으로만 진행됩니다.

목록 envelope

string
항상 "list"입니다.
array
안정적이고 결정적인 순서로 정렬된 리소스 페이지입니다.
string | null
다음 페이지를 가져오려면 다음 요청에서 이 값을 page_token로 전달하십시오. 더 이상 결과가 없으면 null입니다.
boolean
이 페이지 이후에 더 많은 결과가 있는지 여부입니다.

요청 매개변수

integer
기본값:"25"
페이지 크기입니다. 1에서 500 사이의 정수입니다. 이 범위를 벗어난 값은 코드 invalid_request이(가) 포함된 400을(를) 반환합니다.
string
이전 응답의 next_page_token입니다. 첫 번째 페이지에서는 생략하십시오.
오프셋 매개변수, 이전 페이지로의 탐색, 정확한 총 개수는 제공되지 않습니다. 컬렉션의 개수를 세려면 컬렉션을 끝까지 순회해야 합니다.
예외: GET /v1/cohorts/{id}/members은(는) 더 높은 limit을(를) 요청하더라도 페이지당 최대 50개의 행만 반환합니다. has_more 및 next_page_token은(는) 여전히 코호트의 실제 나머지 항목을 반영합니다.
두 가지 Basic 자격 증명 형태 중 하나로 인증하십시오. 자세한 내용은 빠른 시작(apikey:secret 또는 secret:)을 참조하십시오. BASE을(를) 조직의 리전 호스트로 설정하십시오. 자세한 내용은 리전을 참조하십시오.

목록 순회

빠른 시작에서와 같이 시크릿 관리자에서 LIVING_SECURITY_API_KEY을(를) 불러오십시오. 이 예제에는 entity:read이(가) 필요합니다. 첫 번째 요청 가이드에서 사용한 키에는 이 추가 권한이 필요할 수 있습니다. Python 예제에는 requests을(를), 셸 예제에는 jq을(를) 설치하십시오. 두 예제 모두 버전을 고정하고, 필터를 변경하지 않으며, 리디렉션을 거부합니다. 오류가 발생하거나 1,000페이지에 도달하면 중단하며, 일부만 순회한 결과를 완료된 것으로 보고하지 않습니다. Python의 읽기 타임아웃은 전체 작업 시간이 아니라 비활성 시간을 제한하므로, 통합 환경에서 작업 데드라인을 설정하십시오. next_page_token이(가) null이(가) 될 때까지 페이지를 요청하십시오. 대량 읽기에는 limit=500을(를) 사용하면 더 적은 요청으로 컬렉션 전체를 가져올 수 있습니다. 자세한 내용은 요청 제한을 참조하십시오.

페이지네이션 중 필터를 변경하지 마십시오

페이지 토큰은 서명된 불투명 커서입니다. 각 토큰은 해당 토큰을 생성한 요청의 조직, 인증된 서비스 계정, 계약 버전 및 정확한 필터 집합에 바인딩됩니다. 순회 도중 이 중 하나라도 변경하면(예: 두 번째 페이지에서 type 필터를 추가하는 경우) page_token 매개변수에 대해 코드 invalid_request이(가) 포함된 400이(가) 반환됩니다.
400 Invalid request
필터를 변경하려면 첫 번째 페이지부터 새로 순회를 시작하십시오.
page_token은(는) 불투명 문자열로 취급하여 받은 그대로 다시 전달하십시오. 토큰을 디코딩하거나, 장기간 저장하거나, 직접 생성하지 마십시오. 토큰의 내부 형식은 예고 없이 언제든지 변경될 수 있습니다.
목록 엔드포인트는 지원하지 않는 쿼리 매개변수가 있으면 해당 매개변수를 명시한 400 invalid_request으로 거부합니다. 지원되는 필터는 각 엔드포인트의 레퍼런스를 확인하십시오.

중단되었거나 변경되는 컬렉션 처리

이 예제들은 오류를 자동으로 재시도하지 않습니다. 429의 경우 Retry-After을(를) 준수하고 제한된 재시도 가이드를 따르십시오. 읽기를 재시도할 때는 동일한 리전, 서비스 계정, 버전, 필터 및 마지막으로 성공적으로 처리한 페이지 토큰을 유지하십시오. 자격 증명을 변경해도 접근 권한이 부여되지 않습니다. 각 요청은 항상 현재 권한을 확인합니다. 여러 페이지에 걸친 읽기는 컬렉션의 스냅샷이 아닙니다. 순회하는 동안 행이 변경될 수 있습니다. 안정적인 id을(를) 기준으로 리소스를 처리하고 하위 쓰기 작업이 멱등성을 갖도록 만드십시오. 다시 시작하면 동일한 행이 다시 반환될 수 있습니다. 토큰이 거부되면 page_token 오류를 확인하고 요청을 수정한 후 첫 페이지부터 다시 시작하십시오. 이전에 처리한 데이터를 조용히 폐기하거나 중단된 내보내기를 완료된 것으로 표시하지 마십시오. 정확한 보고용 총계가 필요하면 실시간 목록 순회를 스냅샷으로 취급하지 말고 해당 보고 리소스를 사용하십시오.