Method: projects.locations.collections.dataStores.branches.get

检索 Branch。

HTTP 请求

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

网址采用 gRPC 转码语法。

路径参数

参数
name

string

必需。要检索的分支的名称。格式：projects/*/locations/global/dataStores/default_data_store/branches/some_branch_id。

“default_branch”可用作特殊 branchId，它会返回为相应文档设置的默认分支。

查询参数

参数
view

enum (BranchView)

要应用于返回的 Branch 的视图。如果未指定，则默认为 [Branch.BranchView.BASIC][]。

请求正文

请求正文必须为空。

响应正文

如果成功，则响应正文包含一个 Branch 实例。

授权范围

需要以下 OAuth 范围之一：

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

如需了解详情，请参阅 Authentication Overview。

IAM 权限

需要拥有 name 资源的以下 IAM 权限：

  • discoveryengine.branches.get

如需了解详情，请参阅 IAM 文档。