Method: projects.databases.collectionGroups.indexes.list

列出複合式索引。

HTTP 要求

GET https://firestore.googleapis.com/v1beta2/{parent=projects/*/databases/*/collectionGroups/*}/indexes

這個網址使用 gRPC 轉碼語法。

路徑參數

參數
parent

string

表單 projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId} 的父項名稱

查詢參數

參數
filter

string

要套用至清單結果的篩選器。
pageSize

integer

要傳回的結果數。
pageToken

string

頁面權杖，從先前的 FirestoreAdmin.ListIndexes 呼叫傳回，可用於取得下一頁的結果。

要求主體

要求主體必須為空白。

回應主體

FirestoreAdmin.ListIndexes 的回應。

如果成功，回應主體會含有以下結構的資料：

JSON 表示法 
{
  "indexes": [
    {
      object (Index)
    }
  ],
  "nextPageToken": string
}
欄位
indexes[]

object (Index)

要求的索引。
nextPageToken

string

網頁權杖，可用於要求其他結果頁面。如果空白，表示這是最後一頁。

授權範圍

需要下列其中一種 OAuth 範圍：

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

詳情請參閱驗證總覽一文。