Method: projects.availableLocations.list

बताए गए प्रोजेक्ट के लिए, Google Cloud Platform (GCP) के मान्य संसाधन की जगहों की जानकारी देता है. इसमें FirebaseProject भी शामिल है.

इनमें से किसी एक जगह को प्रोजेक्ट की डिफ़ॉल्ट GCP संसाधन की जगह के रूप में चुना जा सकता है. यह वह भौगोलिक जगह है जहां प्रोजेक्ट के संसाधन, जैसे कि Cloud Firestore का प्रावधान डिफ़ॉल्ट रूप से किया जाएगा. हालांकि, अगर प्रोजेक्ट के लिए डिफ़ॉल्ट GCP संसाधन की जगह पहले से सेट है, तो इस सेटिंग को बदला नहीं जा सकता.

यह कॉल, बताए गए प्रोजेक्ट के लिए जगह से जुड़ी किसी भी संभावित पाबंदी की जांच करता है. इस तरह, यह सभी संभावित GCP संसाधन की जगहों का सबसेट दिखा सकता है. GCP रिसॉर्स की सभी जगहों को सूची में शामिल करने के लिए (किसी भी पाबंदी के बावजूद), यूनीक प्रोजेक्ट आइडेंटिफ़ायर (यानी, /v1beta1/{parent=projects/-}/listAvailableLocations) तय किए बिना एंडपॉइंट को कॉल करें.

availableLocations.list को किसी खास प्रोजेक्ट से कॉल करने के लिए, यह ज़रूरी है कि सदस्य के पास प्रोजेक्ट का कम से कम दर्शक हो. किसी खास प्रोजेक्ट के बिना कॉल करने के लिए, किसी प्रोजेक्ट की खास अनुमति की ज़रूरत नहीं होती.

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

GET https://firebase.googleapis.com/v1beta1/{parent=projects/*}/availableLocations

यह यूआरएल gRPC ट्रांसकोडिंग सिंटैक्स का इस्तेमाल करता है.

पाथ पैरामीटर

पैरामीटर
parent

string

FirebaseProject, जिसके लिए इस फ़ॉर्मैट में GCP संसाधन की जगहों की सूची बनानी है:

projects/PROJECT_IDENTIFIER

PROJECT_IDENTIFIER वैल्यू के बारे में जानकारी के लिए, FirebaseProject name फ़ील्ड देखें.

अगर कोई भी यूनीक प्रोजेक्ट आइडेंटिफ़ायर (projects/-) तय नहीं किया गया है, तो दिखाई गई सूची में, संगठन से जुड़ी या प्रोजेक्ट की जगह से जुड़ी पाबंदियों को ध्यान में नहीं रखा जाता.

क्वेरी पैरामीटर

पैरामीटर
pageToken

string

पिछले कॉल के बाद availableLocations.list पर भेजा गया टोकन, जो बताता है कि लिस्टिंग को फिर से शुरू करने के लिए, जगहों की सूची में वह कहां है.
pageSize

integer

जवाब में दिखाई जाने वाली जगहों की ज़्यादा से ज़्यादा संख्या.

सर्वर अपने विवेक के आधार पर इस वैल्यू से कम वैल्यू दिखा सकता है. अगर कोई वैल्यू तय नहीं की गई है या बहुत बड़ी वैल्यू दी गई है, तो सर्वर अपनी सीमा तय करेगा.

यह मान शून्य से कम नहीं हो सकता.

अनुरोध का मुख्य भाग

अनुरोध का लेख खाली होना चाहिए.

जवाब का लेख

अगर इंडेक्सिंग सही से हाे जाती है, ताे जवाब के लेख में नीचे दिए गए स्ट्रक्चर का डेटा शामिल होता है.

JSON के काेड में दिखाना 
{
  "locations": [
    {
      object (Location)
    }
  ],
  "nextPageToken": string
}
फ़ील्ड
locations[]

object (Location)

availableLocations.list को किए गए कॉल के नतीजों का एक पेज.
nextPageToken

string

अगर नतीजों की सूची का साइज़ बहुत बड़ा है, तो एक रिस्पॉन्स में यह सूची फ़िट नहीं हो सकती. अगर स्ट्रिंग खाली है, तो इसका मतलब है कि यह रिस्पॉन्स, नतीजों का आखिरी पेज है और सभी उपलब्ध जगहों की सूची बनाई गई है.

ज़्यादा जगहों को ढूंढने के लिए, availableLocations.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

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

जगह

GCP के संसाधन की जगह, जिसे FirebaseProject के लिए चुना जा सकता है.

JSON के काेड में दिखाना 
{
  "locationId": string,
  "type": enum (LocationType),
  "features": [
    enum (LocationFeature)
  ]
}
फ़ील्ड
locationId

string

GCP के संसाधन की जगह का आईडी. यह GCP संसाधन की उपलब्ध जगहों में से एक होगी.
type

enum (LocationType)

इससे पता चलता है कि डेटा को एक जैसे करने के लिए, GCP संसाधन की जगह क्षेत्रीय या बहु-क्षेत्रीय जगह है या नहीं.
features[]

enum (LocationFeature)

ऐसे प्रॉडक्ट और सेवाएं जो GCP के संसाधन में उपलब्ध हैं.

LocationType

इससे पता चलता है कि GCP के संसाधन की जगह पर, डेटा को कैसे कॉपी किया जाता है. जीसीपी में मौजूद अलग-अलग रिसॉर्स लोकेशन के बारे में ज़्यादा जानें.

एनम्स
LOCATION_TYPE_UNSPECIFIED इसका इस्तेमाल, सेट नहीं की गई वैल्यू को अलग करने के लिए किया जाता है. इसे बाहरी इस्तेमाल के लिए नहीं बनाया गया है.
REGIONAL

वह जगह एक क्षेत्रीय जगह है.

किसी इलाके का डेटा, एक क्षेत्र के कई ज़ोन में कॉपी किया जाता है.
MULTI_REGIONAL

वह जगह कई इलाकों के हिसाब से हो.

एक से ज़्यादा इलाकों वाली जगह का डेटा, कई क्षेत्रों में दोहराया जाता है. हर क्षेत्र में, डेटा को एक से ज़्यादा ज़ोन में दोहराया जाता है.

जगह की जानकारी

ऐसे प्रॉडक्ट और सेवाएं जो GCP के संसाधन में उपलब्ध हैं.

एनम्स
LOCATION_FEATURE_UNSPECIFIED इसका इस्तेमाल, सेट नहीं की गई वैल्यू को अलग करने के लिए किया जाता है. इसे बाहरी इस्तेमाल के लिए नहीं बनाया गया है.
FIRESTORE

इस जगह पर Cloud Firestore डेटाबेस इंस्टेंस काम करते हैं.

App Engine इस जगह उपलब्ध है, इसलिए यह प्रोजेक्ट की डिफ़ॉल्ट GCP संसाधन जगह हो सकती है.
DEFAULT_STORAGE

यह जगह डिफ़ॉल्ट Cloud Storage बकेट के साथ काम करती है.

App Engine इस जगह उपलब्ध है, इसलिए यह प्रोजेक्ट की डिफ़ॉल्ट GCP संसाधन जगह हो सकती है.
FUNCTIONS 'Firebase के लिए Cloud Functions' इस जगह पर उपलब्ध है.