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}

请求正文

请求正文必须为空。

响应正文

最终用户的工作区设置。

如果成功，响应正文将包含结构如下的数据：

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 文档。