Method: projects.locations.collections.engines.getWorkspaceSettings

取得使用者的 Workspace 設定。

HTTP 要求

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

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

路徑參數

參數
name

string

這是必要旗標，完整的 Engine 資源名稱。格式：projects/{project}/locations/{location}/collections/{collectionId}/engines/{engineId}

要求主體

要求主體必須為空白。

回應主體

使用者的 Workspace 設定。

如果成功，回應主體會含有以下結構的資料：

JSON 表示法 
{
  "workspaceAccessEnabled": boolean
}
欄位
workspaceAccessEnabled

boolean

是否已為使用者啟用工作區存取權。

授權範圍

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

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

詳情請參閱Authentication Overview。

IAM 權限

需要 name 資源的下列 IAM 權限：

  • discoveryengine.engines.get

詳情請參閱 IAM 說明文件。