Method: projects.locations.instances.list
コレクションでコンテンツを整理
必要に応じて、コンテンツの保存と分類を行います。
指定された親プロジェクトに関連付けられた各DatabaseInstance
をリストします。
リスト項目は特定の順序で返されませんが、 pageToken
を使用して追加のリクエストが行われた場合、データベース インスタンスの一貫したビューになります。
結果のリストには、任意のSTATE
のインスタンスが含まれます。
リストの結果は数秒間古くなっている可能性があります。
一貫した読み取りには、 instances.get
使用します。
HTTPリクエスト
GET https://firebasedatabase.googleapis.com/v1beta/{parent=projects/*/locations/*}/instances
URL はgRPC トランスコーディング構文を使用します。
パスパラメータ
パラメーター |
---|
parent | string データベース インスタンスをリストする親プロジェクトprojects/{project-number}/locations/{location-id} 形式) すべての場所をリストするには、 projects/{project-number}/locations/- の形式で親を使用します。 認可には、指定されたリソースのparent に対する次のIAM権限が必要です。 -
firebasedatabase.instances.list
|
クエリパラメータ
パラメーター |
---|
pageToken | string データベース インスタンスのセット内のどこでリストを再開するかを示す、 instances.list への以前の呼び出しから返されたトークン。 |
pageSize | integer 応答で返されるデータベース インスタンスの最大数。 サーバーはその裁量により、これよりも少ない数を返す場合があります。値が指定されていない場合 (または大きすぎる値が指定されている場合)、サーバーは独自の制限を課します。 |
showDeleted | boolean DELETED 状態の DatabaseInstances も返される必要があることを示します。 |
リクエストボディ
リクエストの本文は空である必要があります。
レスポンスボディ
成功した場合、応答本文には次の構造のデータが含まれます。
JSON表現 |
---|
{
"instances": [
{
object (DatabaseInstance )
}
],
"nextPageToken": string
} |
田畑 |
---|
instances[] | object ( DatabaseInstance ) 親 Firebase プロジェクトにある各DatabaseInstance のリスト。 |
nextPageToken | string 結果リストが大きすぎて 1 つの応答に収まらない場合は、トークンが返されます。文字列が空の場合、この応答は結果の最後のページになります。 このトークンは、 instances.list への後続の呼び出しで使用して、データベース インスタンスの次のグループを検索できます。 ページ トークンの有効期間は短いため、永続化しないでください。 |
認可の範囲
次の 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
詳細については、 「認証の概要」を参照してください。
特に記載のない限り、このページのコンテンツはクリエイティブ・コモンズの表示 4.0 ライセンスにより使用許諾されます。コードサンプルは Apache 2.0 ライセンスにより使用許諾されます。詳しくは、Google Developers サイトのポリシーをご覧ください。Java は Oracle および関連会社の登録商標です。
最終更新日 2023-12-01 UTC。
[{
"type": "thumb-down",
"id": "missingTheInformationINeed",
"label":"必要な情報がない"
},{
"type": "thumb-down",
"id": "tooComplicatedTooManySteps",
"label":"複雑すぎる / 手順が多すぎる"
},{
"type": "thumb-down",
"id": "outOfDate",
"label":"最新ではない"
},{
"type": "thumb-down",
"id": "translationIssue",
"label":"翻訳に関する問題"
},{
"type": "thumb-down",
"id": "samplesCodeIssue",
"label":"サンプル / コードに問題がある"
},{
"type": "thumb-down",
"id": "otherDown",
"label":"その他"
}]
[{
"type": "thumb-up",
"id": "easyToUnderstand",
"label":"わかりやすい"
},{
"type": "thumb-up",
"id": "solvedMyProblem",
"label":"問題の解決に役立った"
},{
"type": "thumb-up",
"id": "otherUp",
"label":"その他"
}]