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

依父項 DataStore 列出所有工作階段。

HTTP 要求

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

這個網址使用 gRPC 轉碼語法。

路徑參數

參數
parent

string

這是必要旗標，資料儲存庫資源名稱。格式：projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStoreId}

查詢參數

參數
pageSize

integer

一頁的結果數上限，如未指定，預設值為 50。允許的最大值為 1000。
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 說明文件。