Method: projects.locations.collections.dataStores.list

列出與專案相關聯的所有 DataStore

HTTP 要求

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

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

路徑參數

參數
parent

string

這是必要旗標,父項分支資源名稱,例如 projects/{project}/locations/{location}/collections/{collectionId}

如果呼叫者沒有列出這個位置下方 DataStore 的權限,無論這個資料存放區是否存在,系統都會傳回 PERMISSION_DENIED 錯誤。

查詢參數

參數
pageSize

integer

要傳回的 DataStore 數量上限。如未指定,則預設值為 10。允許的最大值為 50。如果值超過 50,系統會強制設為 50。

如果這個欄位為負數,系統會傳回 INVALID_ARGUMENT。

pageToken

string

屬於接收自前一個 DataStoreService.ListDataStores 呼叫的網頁權杖 ListDataStoresResponse.next_page_token。提供此項目即可擷取後續網頁。

進行分頁時,提供至 DataStoreService.ListDataStores 的所有其他參數須與提供網頁權杖的呼叫相符。否則,系統會傳回 INVALID_ARGUMENT 錯誤。

filter

string

依解決方案類型篩選。例如:filter = 'solutionType:SOLUTION_TYPE_SEARCH'

view

enum (DataStoreView)

選用。要套用至傳回 DataStore 的檢視區塊。如果沒有指定,則預設值為 DataStoreView.DATA_STORE_VIEW_BASIC

DataStoreView.DATA_STORE_VIEW_FULL 也會為連接器支援的資料儲存庫填入 DataStore.icon_uri。解析連接器圖示需要額外查詢,因此只有在呼叫端算繪圖示時才要求。

要求主體

要求主體必須為空白。

回應主體

如果成功,回應主體會包含 ListDataStoresResponse 的執行個體。

授權範圍

需要下列其中一種 OAuth 範圍:

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

詳情請參閱Authentication Overview

IAM 權限

需要 parent 資源的下列 IAM 權限:

  • discoveryengine.dataStores.list

詳情請參閱 IAM 說明文件