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 呼叫的網頁權杖。提供此項目即可擷取後續網頁。
filter

string

選用。篩選運算式。目前僅支援根據 IcebergCatalog.catalog_type 欄位篩選的參數。

範例：* catalogType = CATALOG_TYPE_BIGLAKE * catalogType != CATALOG_TYPE_GCS_BUCKET * catalogType = CATALOG_TYPE_BIGLAKE OR catalogType = CATALOG_TYPE_GCS_BUCKET * NOT catalogType = CATALOG_TYPE_GCS_BUCKET

要求主體

要求主體必須為空白。

回應主體

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 預設/未設定值。這個值與 CATALOG_VIEW_BASIC 的處理方式相同。
CATALOG_VIEW_BASIC 只需要填入名稱和目錄類型。
CATALOG_VIEW_FULL 包含目錄的所有欄位。