指定された親プロジェクトに関連付けられた各DatabaseInstance
をリストします。
リスト項目は特定の順序で返されませんが、 pageToken
を使用して追加のリクエストが行われた場合、データベース インスタンスの一貫したビューになります。
結果のリストには、任意のSTATE
のインスタンスが含まれます。
リストの結果は数秒間古くなっている可能性があります。
一貫した読み取りには、 instances.get
使用します。
HTTPリクエスト
GET https://firebasedatabase.googleapis.com/v1beta/{parent=projects/*/locations/*}/instances
URL はgRPC トランスコーディング構文を使用します。
パスパラメータ
パラメーター | |
---|---|
parent | データベース インスタンスをリストする親プロジェクト すべての場所をリストするには、 認可には、指定されたリソースの
|
クエリパラメータ
パラメーター | |
---|---|
pageToken | データベース インスタンスのセット内のどこでリストを再開するかを示す、 |
pageSize | 応答で返されるデータベース インスタンスの最大数。 サーバーはその裁量により、これよりも少ない数を返す場合があります。値が指定されていない場合 (または大きすぎる値が指定されている場合)、サーバーは独自の制限を課します。 |
showDeleted | |
リクエストボディ
リクエストの本文は空である必要があります。
レスポンスボディ
成功した場合、応答本文には次の構造のデータが含まれます。
instances.list
メソッドからの応答。
JSON表現 |
---|
{
"instances": [
{
object ( |
田畑 | |
---|---|
instances[] | 親 Firebase プロジェクトにある各 |
nextPageToken | 結果リストが大きすぎて 1 つの応答に収まらない場合は、トークンが返されます。文字列が空の場合、この応答は結果の最後のページになります。 このトークンは、 ページ トークンの有効期間は短いため、永続化しないでください。 |
認可の範囲
次の OAuth スコープのいずれかが必要です。
-
https://www.googleapis.com/auth/cloud-platform
-
https://www.googleapis.com/auth/cloud-platform.read-only
-
https://www.googleapis.com/auth/firebase
-
https://www.googleapis.com/auth/firebase.readonly
詳細については、 「認証の概要」を参照してください。