Method: projects.locations.catalogs.list

指定したプロジェクトのすべてのカタログを一覧表示します。

HTTP リクエスト

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

この URL では gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
parent

string

必須。このカタログのコレクションを所有する親。形式: projects/{project_id_or_number}/locations/{locationId}

クエリ パラメータ

パラメータ
pageSize

integer

返すカタログの最大数。サービスが返す値はこれよりも少ないことがあります。指定されていない場合、最大で 50 個のカタログが返されます。最大値は 1,000 です。1,000 を超える値は 1,000 に強制変換されます。
pageToken

string

前回の catalogs.list 呼び出しから受け取ったページトークン。後続のページを取得するにはこれを指定します。

ページ分割を行う場合、catalogs.list に指定する他のすべてのパラメータは、ページトークンを提供した呼び出しと一致する必要があります。

リクエストの本文

リクエストの本文は空にする必要があります。

レスポンスの本文

catalogs.list メソッドのレスポンス メッセージ。

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

JSON 表現 
{
  "catalogs": [
    {
      object (Catalog)
    }
  ],
  "nextPageToken": string
}
フィールド
catalogs[]

object (Catalog)

指定されたプロジェクトのカタログ。
nextPageToken

string

次のページを取得するために pageToken として送信できるトークン。このフィールドを省略すると、後続のページはなくなります。

認可スコープ

次の OAuth スコープのいずれかが必要です。

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

詳細については、Authentication Overview をご覧ください。

IAM 権限

parent リソースに対する次の IAM 権限が必要です。

  • biglake.catalogs.list

詳細については、IAM のドキュメントをご覧ください。