Method: projects.availableLocations.list

निर्दिष्ट प्रोजेक्ट ( FirebaseProject सहित) के लिए मान्य Google क्लाउड प्लेटफ़ॉर्म (GCP) संसाधन स्थानों को सूचीबद्ध करता है।

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

यह कॉल निर्दिष्ट प्रोजेक्ट के लिए किसी भी संभावित स्थान प्रतिबंध की जांच करता है और इस प्रकार, सभी संभावित जीसीपी संसाधन स्थानों का एक सबसेट लौटा सकता है। सभी GCP संसाधन स्थानों को सूचीबद्ध करने के लिए (किसी भी प्रतिबंध की परवाह किए बिना), एक अद्वितीय प्रोजेक्ट पहचानकर्ता (अर्थात्, /v1beta1/{parent=projects/-}/listAvailableLocations ) निर्दिष्ट किए बिना एंडपॉइंट पर कॉल करें।

किसी निर्दिष्ट प्रोजेक्ट के साथ availableLocations.list कॉल करने के लिए, एक सदस्य को कम से कम प्रोजेक्ट का दर्शक होना चाहिए। किसी निर्दिष्ट प्रोजेक्ट के बिना कॉल के लिए किसी विशिष्ट प्रोजेक्ट अनुमति की आवश्यकता नहीं होती है।

HTTP अनुरोध

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

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

पथ पैरामीटर

पैरामीटर
parent

string

FirebaseProject जिसके लिए जीसीपी संसाधन स्थानों को सूचीबद्ध करना है, प्रारूप में:

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 संसाधन स्थान पर उपलब्ध हैं।

स्थान प्रकार

निर्दिष्ट करता है कि GCP संसाधन स्थान के भीतर डेटा को कैसे दोहराया जाता है। जीसीपी संसाधन स्थानों के प्रकारों के बारे में और जानें।

एनम्स
LOCATION_TYPE_UNSPECIFIED अनसेट मानों को अलग करने के लिए आंतरिक रूप से उपयोग किया जाता है और बाहरी उपयोग के लिए अभिप्रेत नहीं है।
REGIONAL

स्थान एक क्षेत्रीय स्थान है.

किसी क्षेत्रीय स्थान का डेटा एक क्षेत्र के भीतर कई क्षेत्रों में दोहराया जाता है।

MULTI_REGIONAL

यह स्थान एक बहु-क्षेत्रीय स्थान है.

एक बहु-क्षेत्रीय स्थान का डेटा कई क्षेत्रों में दोहराया जाता है। प्रत्येक क्षेत्र के भीतर, डेटा को कई क्षेत्रों में दोहराया जाता है।

स्थान सुविधा

उत्पाद और सेवाएँ जो GCP संसाधन स्थान पर उपलब्ध हैं।

एनम्स
LOCATION_FEATURE_UNSPECIFIED अनसेट मानों को अलग करने के लिए आंतरिक रूप से उपयोग किया जाता है और बाहरी उपयोग के लिए अभिप्रेत नहीं है।
FIRESTORE

यह स्थान क्लाउड फायरस्टोर डेटाबेस इंस्टेंसेस का समर्थन करता है।

ऐप इंजन इस स्थान पर उपलब्ध है, इसलिए यह प्रोजेक्ट का डिफ़ॉल्ट GCP संसाधन स्थान हो सकता है।

DEFAULT_STORAGE

यह स्थान डिफ़ॉल्ट क्लाउड स्टोरेज बकेट का समर्थन करता है।

ऐप इंजन इस स्थान पर उपलब्ध है, इसलिए यह प्रोजेक्ट का डिफ़ॉल्ट GCP संसाधन स्थान हो सकता है।

FUNCTIONS फायरबेस के लिए क्लाउड फ़ंक्शंस इस स्थान पर उपलब्ध है।