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狀態的 DatabaseInstance。

請求正文

請求內文必須為空。

響應體

如果成功，回應正文包含具有以下結構的資料：

來自instances.list方法的回應。

JSON 表示
{
  "instances": [
    {
      object (DatabaseInstance)
    }
  ],
  "nextPageToken": string
}
領域
instances[]

object ( DatabaseInstance )

父 Firebase 專案中的每個DatabaseInstance的清單。

nextPageToken

string

如果結果清單太大而無法容納單一回應，則傳回一個令牌。如果字串為空，則此回應是結果的最後一頁。

此令牌可用於後續呼叫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

有關詳細信息，請參閱身份驗證概述。