Method: projects.databases.collectionGroups.indexes.list

यह कंपोज़िट इंडेक्स की सूची बनाता है.

एचटीटीपी अनुरोध

GET https://firestore.googleapis.com/v1/{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

ज़्यादा जानकारी के लिए, पुष्टि करने से जुड़ी खास जानकारी देखें.