مکانهای منبع معتبر Google Cloud Platform (GCP) را برای پروژه مشخص شده (از جمله FirebaseProject
) فهرست میکند.
یکی از این مکانها را میتوان بهعنوان مکان پیشفرض منبع GCP پروژه انتخاب کرد، که مکان جغرافیایی است که منابع پروژه، مانند Cloud Firestore، بهطور پیشفرض در آن ارائه میشود. با این حال، اگر مکان پیشفرض منبع GCP قبلاً برای پروژه تنظیم شده باشد، این تنظیم را نمیتوان تغییر داد.
این فراخوان هرگونه محدودیت مکانی احتمالی را برای پروژه مشخص شده بررسی میکند و بنابراین، ممکن است زیرمجموعهای از همه مکانهای ممکن منابع GCP را برگرداند. برای فهرست کردن همه مکانهای منبع GCP (صرف نظر از هرگونه محدودیت)، نقطه پایانی را بدون تعیین شناسه پروژه منحصر به فرد (یعنی /v1beta1/{parent=projects/-}/listAvailableLocations
) فراخوانی کنید.
برای فراخوانی availableLocations.list
با یک پروژه مشخص، یک عضو باید حداقل بیننده پروژه باشد. تماس های بدون پروژه مشخص به مجوز پروژه خاصی نیاز ندارند.
درخواست HTTP
GET https://firebase.googleapis.com/v1beta1/{parent=projects/*}/availableLocations
URL از دستور GRPC Transcoding استفاده می کند.
پارامترهای مسیر
مولفه های | |
---|---|
parent | برای جزئیات بیشتر در مورد مقادیر PROJECT_IDENTIFIER به قسمت اگر هیچ شناسه پروژه منحصر به فردی مشخص نشده باشد (یعنی |
پارامترهای پرس و جو
مولفه های | |
---|---|
pageToken | رمز از تماس قبلی به |
pageSize | حداکثر تعداد مکان برای بازگشت در پاسخ. سرور ممکن است به صلاحدید خود کمتر از این مقدار را برگرداند. اگر مقداری مشخص نشده باشد (یا مقدار بسیار بزرگی مشخص شده باشد)، سرور محدودیت خود را اعمال می کند. این مقدار نمی تواند منفی باشد. |
درخواست بدن
بدنه درخواست باید خالی باشد.
بدن پاسخگو
در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:
نمایندگی JSON |
---|
{
"locations": [
{
object ( |
زمینه های | |
---|---|
locations[] | یک صفحه از نتایج تماس با |
nextPageToken | اگر لیست نتایج بیش از حد بزرگ باشد که در یک پاسخ قرار نگیرد، یک نشانه برگردانده می شود. اگر رشته خالی باشد، این پاسخ آخرین صفحه نتایج است و همه مکانهای موجود فهرست شدهاند. این نشانه می تواند در تماس بعدی با توکن های صفحه کوتاه مدت هستند و نباید ادامه پیدا کنند. |
محدوده مجوز
به یکی از حوزه های 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 ( |
زمینه های | |
---|---|
locationId | شناسه مکان منبع GCP. این یکی از مکانهای موجود منبع GCP خواهد بود. |
type | نشان می دهد که مکان منبع GCP یک مکان منطقه ای یا چند منطقه ای برای تکرار داده ها است. |
features[] | محصولات و خدماتی که در محل منبع GCP در دسترس هستند. |
نوع مکان
نحوه تکثیر داده ها در محل منبع GCP را مشخص می کند. درباره انواع مکان های منبع GCP بیشتر بیاموزید.
Enums | |
---|---|
LOCATION_TYPE_UNSPECIFIED | در داخل برای تشخیص مقادیر تنظیم نشده استفاده می شود و برای استفاده خارجی در نظر گرفته نشده است. |
REGIONAL | موقعیت مکانی منطقه ای است. داده ها در یک مکان منطقه ای در چندین منطقه در یک منطقه تکرار می شوند. |
MULTI_REGIONAL | موقعیت مکانی چند منطقه ای است. داده ها در یک مکان چند منطقه ای در چندین منطقه تکرار می شوند. در هر منطقه، داده ها در چندین منطقه تکرار می شوند. |
ویژگی مکان
محصولات و خدماتی که در محل منبع GCP در دسترس هستند.
Enums | |
---|---|
LOCATION_FEATURE_UNSPECIFIED | در داخل برای تشخیص مقادیر تنظیم نشده استفاده می شود و برای استفاده خارجی در نظر گرفته نشده است. |
FIRESTORE | این مکان از نمونه های پایگاه داده Cloud Firestore پشتیبانی می کند. App Engine در این مکان در دسترس است، بنابراین میتواند مکان منبع GCP پیشفرض پروژه باشد. |
DEFAULT_STORAGE | این مکان از سطلهای پیشفرض Cloud Storage پشتیبانی میکند. App Engine در این مکان در دسترس است، بنابراین میتواند مکان منبع GCP پیشفرض پروژه باشد. |
FUNCTIONS | Cloud Functions for Firebase در این مکان موجود است. |