Method: projects.locations.collections.list

Collection 목록을 가져옵니다.

HTTP 요청

GET https://discoveryengine.googleapis.com/v1alpha/{parent=projects/*/locations/*}/collections

URL은 gRPC 트랜스코딩 문법을 사용합니다.

경로 매개변수

매개변수
parent

string

필수 항목입니다. 상위 데이터 스토어 리소스 이름입니다(projects/{project}/locations/{location} 형식).

쿼리 매개변수

매개변수
pageSize

integer

반환할 최대 Collection 수입니다. 서비스가 이 값보다 더 적게 반환할 수 있습니다.

지정하지 않으면 최대 100개의 Collection가 반환됩니다.

최댓값은 1,000이며, 1,000을 초과하는 값은 1,000으로 변환됩니다.
pageToken

string

이전 CollectionService.ListCollections 호출에서 받은 페이지 토큰입니다. 후속 페이지를 검색하려면 이를 입력합니다.

페이지를 매길 때 CollectionService.ListCollections에 제공된 다른 모든 매개변수는 페이지 토큰을 제공한 호출과 일치해야 합니다.
filter

string

연결된 데이터 커넥터 데이터 소스를 기준으로 반환된 컬렉션을 필터링합니다. 예를 들면 filter = 'dataSource:jira confluence'입니다. 필터가 비어 있으면 프로젝트 및 위치의 모든 컬렉션이 반환됩니다.

요청 본문

요청 본문은 비어 있어야 합니다.

응답 본문

CollectionService.ListCollections 메서드의 응답 메시지입니다.

성공한 경우 응답 본문은 다음과 같은 구조의 데이터를 포함합니다.

JSON 표현 
{
  "collections": [
    {
      object (Collection)
    }
  ],
  "nextPageToken": string
}
필드
collections[]

object (Collection)

Collection입니다.
nextPageToken

string

다음 페이지를 검색하기 위해 ListCollectionsRequest.page_token으로 전송할 수 있는 토큰입니다. 이 필드를 생략하면 후속 페이지가 표시되지 않습니다.

승인 범위

다음 OAuth 범위 중 하나가 필요합니다.

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.readwrite

자세한 내용은 Authentication Overview를 참조하세요.

IAM 권한

parent 리소스에 대해서는 다음 IAM 권한이 필요합니다.

  • discoveryengine.collections.list

자세한 내용은 IAM 문서를 참조하세요.