Method: projects.locations.buckets.list

特定のロケーションにあるプロジェクトのバケットを一覧表示します。

HTTP リクエスト

GET https://observability.googleapis.com/v1/{parent=projects/*/locations/*}/buckets

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

パスパラメータ

パラメータ
parent

string

必須。このバケット コレクションを所有する親。書式は次のとおりです。

projects/[PROJECT_ID]/locations/[LOCATION]

クエリ パラメータ

パラメータ
pageSize

integer

省略可。返されるバケットの最大数。指定されていない場合、最大で 100 個のバケットが返されます。最大値は 1,000 です。1,000 を超える値は 1,000 に強制変換されます。

pageToken

string

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

showDeleted

boolean

省略可。true の場合、レスポンスに削除されたバケットが含まれます。

リクエストの本文

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

レスポンスの本文

バケットを一覧表示するためのレスポンス。

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

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

object (Bucket)

省略可。バケットのリスト。

nextPageToken

string

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

認可スコープ

次の OAuth スコープが必要です。

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

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

IAM 権限

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

  • observability.buckets.list

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