Method: projects.locations.backupPlans.list

特定のロケーションにある BackupPlan を一覧表示します。

HTTP リクエスト

GET https://gkebackup.googleapis.com/v1/{parent=projects/*/locations/*}/backupPlans

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

パスパラメータ

パラメータ
parent

string

必須。一覧表示する BackupPlans を含むロケーション。形式: projects/*/locations/*

認可には、指定されたリソース parent に対する次の IAM の権限が必要です。

  • gkebackup.backupPlans.list

クエリ パラメータ

パラメータ
pageSize

integer

単一のレスポンスで返す結果の目標数。指定しない場合は、サービスによってデフォルト値が選択されます。レスポンスには部分的なリストが含まれる場合があり、クエリ対象のインスタンスが他にも存在するかどうかを見極めるため、呼び出し元はレスポンスの nextPageToken のみを信頼します。
pageToken

string

前の backupPlans.list 呼び出しから受け取った nextPageToken の値。結果の複数ページのリストで後続のページを取得するには、これを指定します。ページ分割を行う場合、backupPlans.list に指定する他のすべてのパラメータは、ページトークンを提供した呼び出しと一致する必要があります。
filter

string

結果のフィルタリングに使用されるフィールド一致式。
orderBy

string

結果の並べ替え基準として使用するフィールド。

リクエストの本文

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

レスポンスの本文

backupPlans.list に対するレスポンス メッセージ。

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

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

object (BackupPlan)

指定した条件に一致する BackupPlans のリスト。
nextPageToken

string

結果の次のページを取得するために、後続の backupPlans.list 呼び出しで pageToken として送信できるトークン。このフィールドが省略されているか空の場合、返されるその他の結果はありません。
unreachable[]

string

到達できなかった場所。

認可スコープ

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

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

詳細については、認証の概要をご覧ください。