Method: projects.databases.list

プロジェクト内のすべてのデータベースを一覧表示します。

HTTP リクエスト

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

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

パスパラメータ

パラメータ
parent

string

必須。projects/{projectId} フォームの親名

クエリ パラメータ

パラメータ
showDeleted

boolean

true の場合、削除されたリソースも返されます。

リクエストの本文

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

レスポンスの本文

プロジェクトのデータベースのリスト。

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

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

object (Database)

プロジェクト内のデータベース。
unreachable[]

string

個々のデータベースに関するデータを一覧表示できない場合は、ここに記録されます。

エントリの例: projects/some_project/locations/some_location これは、データベースが存在する Cloud リージョンが現在利用できない場合に発生します。この場合、データベースに関するすべての詳細を取得することはできません。「Get」を送信することで、より詳細なエラー メッセージを取得する（またはリソースを取得できる）場合があります。または「List」というリクエストできます。

認可スコープ

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

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

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