Method: projects.databases.collectionGroups.indexes.get

複合インデックスを取得します。

HTTP リクエスト

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

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

パスパラメータ

パラメータ
name

string

必須。projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId}/indexes/{index_id} の形式の名前

リクエスト本文

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

レスポンスの本文

成功した場合、レスポンスの本文には Index のインスタンスが含まれます。

承認スコープ

次の OAuth スコープのいずれかが必要です。

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

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