Method: projects.locations.backups.list

すべてのバックアップを一覧表示します。

HTTP リクエスト

GET https://firestore.googleapis.com/v1/{parent=projects/*/locations/*}/backups

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

パスパラメータ

パラメータ
parent

string

必須。バックアップを一覧表示するロケーション。

形式は projects/{project}/locations/{location} です。{location} = '-' を使用して、指定したプロジェクトのすべてのロケーションのバックアップを一覧表示します。これにより、1 つのロケーションまたはすべてのロケーションのバックアップを一覧表示できます。

リクエスト本文

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

レスポンスの本文

FirestoreAdmin.ListBackups に対するレスポンス。

成功すると、レスポンスの本文に次の構造のデータが含まれます。

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

object (Backup)

プロジェクトのすべてのバックアップのリスト。
unreachable[]

string

既存のバックアップを取得できなかったロケーションのリスト。

このレスポンスでは、1 つのビジネスにアクセスできないときにリクエスト全体を失敗させるのではなく、部分的な結果セットと、ここでアクセスできないビジネスのリストが返されます。1 つの場所に対してリクエストを再試行すると、具体的なエラーが発生します。

承認スコープ

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

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

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