Method: projects.locations.instances.list

निर्दिष्ट मूल प्रोजेक्ट से जुड़े प्रत्येक DatabaseInstance सूचीबद्ध करता है।

सूची आइटम किसी विशेष क्रम में नहीं लौटाए जाते हैं, लेकिन pageToken के साथ अतिरिक्त अनुरोध किए जाने पर डेटाबेस उदाहरणों का एक सुसंगत दृश्य होगा।

परिणामी सूची में किसी भी STATE उदाहरण शामिल हैं।

सूची के परिणाम कुछ सेकंड के लिए पुराने हो सकते हैं।

लगातार पढ़ने के लिए instances.get उपयोग करें।

HTTP अनुरोध

GET https://firebasedatabase.googleapis.com/v1beta/{parent=projects/*/locations/*}/instances

यूआरएल जीआरपीसी ट्रांसकोडिंग सिंटैक्स का उपयोग करता है।

पथ पैरामीटर

पैरामीटर
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 स्थिति में DatabaseInstances को भी वापस किया जाना चाहिए।

निकाय से अनुरोध करें

अनुरोध का मुख्य भाग खाली होना चाहिए.

प्रतिक्रिया निकाय

सफल होने पर, प्रतिक्रिया निकाय में निम्नलिखित संरचना वाला डेटा शामिल होता है:

instances.list विधि से प्रतिक्रिया।

JSON प्रतिनिधित्व
{
  "instances": [
    {
      object (DatabaseInstance)
    }
  ],
  "nextPageToken": string
}
खेत
instances[]

object ( DatabaseInstance )

प्रत्येक DatabaseInstance की सूची जो मूल Firebase प्रोजेक्ट में है।

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

अधिक जानकारी के लिए, प्रमाणीकरण अवलोकन देखें।