Method: projects.locations.collections.engines.sessions.list

상위 DataStore별로 모든 세션을 나열합니다.

HTTP 요청

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

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

경로 파라미터

파라미터
parent

string

필수 항목. 데이터 스토어 리소스 이름입니다. 형식: projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStoreId}

쿼리 파라미터

파라미터
pageSize

integer

반환할 결과의 최대 수입니다. 지정하지 않으면 기본적으로 50입니다. 허용되는 최댓값은 1,000입니다.
pageToken

string

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

string

EBNF 문법을 사용하여 필터링에 사용할 필드를 쉼표로 구분한 목록입니다.

지원되는 필드는 다음과 같습니다.

  • user_pseudo_id
  • state
  • display_name
  • starred
  • is_pinned
  • labels
  • create_time
  • update_time

예를 들면 다음과 같습니다.

  • user_pseudo_id = some_id
  • display_name = "some_name"
  • starred = true
  • is_pinned=true AND (NOT labels:hidden)
  • create_time > "1970-01-01T12:00:00Z"
orderBy

string

정렬 기준으로 사용할 필드를 쉼표로 구분하여 지정합니다. 오름차순으로 정렬됩니다. 내림차순 정렬이 필요한 경우 필드 이름 뒤에 "desc"를 사용합니다.

지원되는 필드:

  • update_time
  • create_time
  • session_name
  • is_pinned

예를 들면 다음과 같습니다.

  • update_time desc
  • create_time
  • is_pinned desc,update_time desc: 세션을 is_pinned 값을 기준으로 정렬하고, 그다음 update_time을 기준으로 정렬합니다.

요청 본문

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

응답 본문

성공한 경우 응답 본문에 ListSessionsResponse의 인스턴스가 포함됩니다.

승인 범위

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

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

자세한 내용은 Authentication Overview에서 확인하세요.

IAM 권한

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

  • discoveryengine.sessions.list

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