Method: projects.databases.indexes.list

指定したフィルタに一致するインデックスを一覧表示します。

HTTP リクエスト

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

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

パスパラメータ

パラメータ
parent

string

データベース名。例: projects/{projectId}/databases/{databaseId}

クエリ パラメータ

パラメータ
filter

string
pageSize

integer

標準のリストページサイズ。
pageToken

string

標準のリストページ トークン。

リクエストの本文

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

レスポンスの本文

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

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