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

列出目录中的 Iceberg 命名空间。我们仅支持一级命名空间嵌套。

HTTP 请求

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

网址采用 gRPC 转码语法。

路径参数

参数
apiParent

string

必需。资源路径中的父级。

查询参数

参数
pageToken

string

可选。指定上一个响应中返回的 pageToken 以检索下一页结果。

pageSize

integer

可选。对于支持分页的服务器,此字段表示客户端将收到的结果数的上限。对于不支持分页的服务器,客户端可能会收到大于指定 pageSize 的结果。如果未设置,则默认为 100。

parent

string

可选。一个可选的命名空间,用于列出其下方的命名空间。如果未提供或为空,则应列出所有顶级命名空间。如果父级是多部分命名空间,则各部分必须用单元分隔符 (0x1F) 字节分隔。不是实际的父级,因此为 ST_NOT_REQUIRED。

请求正文

请求正文必须为空。

响应正文

namespaces.list API 的响应消息。

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

JSON 表示法
{
  "namespaces": [
    array
  ],
  "next-page-token": string,
  "unreachable": [
    string
  ]
}
字段
namespaces[]

array (ListValue format)

命名空间列表。

next-page-token

string

用于分页的下一页面令牌。

unreachable[]

string

仅限输出。无法访问的已跳过位置的列表。如果非空,结果集可能不完整。

授权范围

需要以下 OAuth 范围之一:

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

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