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

Listet die Iceberg-REST-Kataloge auf.

HTTP-Anfrage


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

Für die URLs wird die Syntax der gRPC-Transcodierung verwendet.

Pfadparameter

Parameter
parent

string

Erforderlich. Die übergeordnete Ressource, in der dieser Katalog erstellt wird. Format: projects/{projectId}

Suchparameter

Parameter
view

enum (CatalogView)

Optional. Die Ansicht des zurückzugebenden Katalogs.

page-size

integer

Optional. Die maximale Anzahl der zurückzugebenden Kataloge. Der Dienst gibt möglicherweise weniger als diesen Wert zurück.

page-token

string

Optional. Das Seitentoken, das von einem vorherigen catalogs.list-Aufruf empfangen wurde. Geben Sie dieses an, um die nachfolgende Seite abzurufen.

filter

string

Optional. Der Filterausdruck. Der einzige derzeit unterstützte Parameter ist das Filtern nach dem Feld IcebergCatalog.catalog_type.

Beispiele: * 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

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Die Antwortnachricht für die catalogs.list API.

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

JSON-Darstellung
{
  "iceberg-catalogs": [
    {
      object (IcebergCatalog)
    }
  ],
  "next-page-token": string,
  "unreachable": [
    string
  ]
}
Felder
iceberg-catalogs[]

object (IcebergCatalog)

Nur Ausgabe. Die Liste der Iceberg-Kataloge.

next-page-token

string

Nur Ausgabe. Das Token für die nächste Seite für die Paginierung.

unreachable[]

string

Nur Ausgabe. Die Liste der nicht erreichbaren Cloud-Regionen. Wenn der Wert nicht leer ist, ist die Ergebnismenge möglicherweise unvollständig.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

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

Weitere Informationen finden Sie unter Authentication Overview.

CatalogView

Die Aufzählung der Ansichten, die zurückgegeben werden können.

Enums
CATALOG_VIEW_UNSPECIFIED Standardwert/nicht festgelegter Wert. Dieser Wert wird genauso behandelt wie CATALOG_VIEW_BASIC.
CATALOG_VIEW_BASIC Geben Sie nur den Namen und den Katalogtyp an.
CATALOG_VIEW_FULL Schließen Sie alle Felder des Katalogs ein. replicationStatus wird nur ausgefüllt, wenn region angegeben ist und sich auf eine sekundäre Replikatregion des Katalogs bezieht.