Method: iceberg.v1.restcatalog.extensions.projects.catalogs.list

列出 Iceberg REST 目录。

HTTP 请求

GET https://biglake.googleapis.com/iceberg/v1/restcatalog/extensions/{parent=projects/*}/catalogs

网址采用 gRPC 转码语法。

路径参数

参数
parent

string

必需。将在其中创建此目录的父级资源。格式:projects/{projectId}

查询参数

参数
view

enum (CatalogView)

可选。要返回的目录视图。

page-size

integer

可选。要返回的目录数量上限。服务返回的值可能小于此值。

page-token

string

可选。从之前的 catalogs.list 调用收到的页面令牌。利用其进行后续页面检索。

请求正文

请求正文必须为空。

响应正文

catalogs.list API 的响应消息。

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

JSON 表示法
{
  "iceberg-catalogs": [
    {
      object (IcebergCatalog)
    }
  ],
  "next-page-token": string,
  "unreachable": [
    string
  ]
}
字段
iceberg-catalogs[]

object (IcebergCatalog)

仅限输出。Iceberg 目录列表。

next-page-token

string

仅限输出。用于分页的下一页令牌。

unreachable[]

string

仅限输出。无法访问的云区域列表。如果此列表不为空,则结果集可能不完整。

授权范围

需要以下 OAuth 范围之一:

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

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

CatalogView

可以返回的视图的枚举。

枚举
CATALOG_VIEW_UNSPECIFIED 默认值/未设置的值。与 BASIC 相同。
CATALOG_VIEW_BASIC 仅包含名称和目录类型。
CATALOG_VIEW_FULL 包含目录的所有字段。