Method: deltasharing.v1.projects.catalogs.shares.list

获取上游 Delta Sharing 来源中可用的 Delta Sharing 共享列表。

HTTP 请求

GET https://biglake.googleapis.com/deltasharing/v1/{parent=projects/*/catalogs/*}/shares

网址采用 gRPC 转码语法。

路径参数

参数
parent

string

必需。目录的名称。格式:projects/{project}/catalogs/{catalog}

查询参数

参数
pageSize

integer

可选。要返回的最大分享数。服务返回的值可能小于此值。如果未指定,则最多返回 100 个分享。最大值为 1,000;大于 1,000 的值将被强制转换为 1,000。

pageToken

string

可选。从之前的 shares.list 调用中收到的页面令牌。

请求正文

请求正文必须为空。

响应正文

针对 shares.list 方法的响应消息。

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

JSON 表示法
{
  "deltaSharingShares": [
    {
      object (DeltaSharingShare)
    }
  ],
  "nextPageToken": string
}
字段
deltaSharingShares[]

object (DeltaSharingShare)

指定目录中的 Delta Sharing 共享。

nextPageToken

string

可作为 pageToken 发送并用于检索下一页的令牌。如果省略此字段,则不存在后续页面。

授权范围

需要以下 OAuth 范围之一:

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

如需了解详情,请参阅 Authentication Overview

IAM 权限

需要拥有 parent 资源的以下 IAM 权限:

  • biglake.catalogs.get

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

DeltaSharingShare

表示 Delta Sharing 共享。

JSON 表示法
{
  "name": string,
  "shareId": string,
  "originalName": string
}
字段
name

string

标识符。资源名称。 格式:projects/{project}/catalogs/{catalog}/shares/{delta_sharing_share} 注意:{delta_sharing_share} 是系统生成的用户友好型名称(例如,适用于 BigQuery),而不是原始的上游 URN。

shareId

string

仅限输出。分享的唯一标识符。

originalName

string

仅限输出。分享的原始分享名称(例如原生 URN)。