Method: projects.availableLocations.list

แสดงตำแหน่งทรัพยากร Google Cloud Platform (GCP) ที่ถูกต้องสำหรับโปรเจ็กต์ที่ระบุ (รวมถึง FirebaseProject)

คุณเลือก 1 ตำแหน่งดังกล่าวเป็นตำแหน่งทรัพยากร GCP เริ่มต้นของโปรเจ็กต์ได้ ซึ่งเป็นตำแหน่งทางภูมิศาสตร์ที่ทรัพยากรของโปรเจ็กต์ เช่น Cloud Firestore จะได้รับการจัดสรรโดยค่าเริ่มต้น อย่างไรก็ตาม หากมีการตั้งค่าตำแหน่งทรัพยากร GCP เริ่มต้นสำหรับโครงการแล้ว การตั้งค่านี้จะเปลี่ยนแปลงไม่ได้

การเรียกนี้จะตรวจสอบการจำกัดตำแหน่งที่เป็นไปได้สำหรับโปรเจ็กต์ที่ระบุ และอาจแสดงผลกลุ่มย่อยของตำแหน่งทรัพยากร GCP ที่เป็นไปได้ทั้งหมด หากต้องการแสดงตำแหน่งทรัพยากร GCP ทั้งหมด (โดยไม่คำนึงถึงข้อจำกัด) ให้เรียกใช้ปลายทางโดยไม่ต้องระบุตัวระบุโปรเจ็กต์ที่ไม่ซ้ำกัน (กล่าวคือ /v1beta1/{parent=projects/-}/listAvailableLocations)

หากต้องการเรียกใช้ availableLocations.list กับโปรเจ็กต์ที่ระบุ สมาชิกต้องเป็นผู้ดูโปรเจ็กต์เป็นอย่างน้อย การเรียกใช้ที่ไม่มีโปรเจ็กต์ที่ระบุจะไม่ต้องใช้สิทธิ์โปรเจ็กต์ที่เฉพาะเจาะจง

คำขอ HTTP

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

URL ใช้ไวยากรณ์การแปลง gRPC

พารามิเตอร์เส้นทาง

พารามิเตอร์
parent

string

FirebaseProject ที่จะแสดงตำแหน่งทรัพยากร GCP ในรูปแบบดังนี้

projects/PROJECT_IDENTIFIER

โปรดดูที่ช่อง FirebaseProject name เพื่อดูรายละเอียดเกี่ยวกับค่า PROJECT_IDENTIFIER

หากไม่ได้ระบุตัวระบุโปรเจ็กต์ที่ไม่ซ้ำกัน (ซึ่งก็คือ projects/-) รายการที่ส่งคืนจะไม่พิจารณาข้อจำกัดสถานที่ตั้งเฉพาะองค์กรหรือโปรเจ็กต์

พารามิเตอร์การค้นหา

พารามิเตอร์
pageToken

string

โทเค็นที่ส่งคืนจากการเรียกไปยัง availableLocations.list ครั้งก่อน ซึ่งระบุตำแหน่งในรายการสถานที่ที่ต้องการกลับมาแสดงข้อมูลอีกครั้ง
pageSize

integer

จำนวนตำแหน่งสูงสุดที่จะแสดงในการตอบกลับ

เซิร์ฟเวอร์อาจแสดงผลน้อยกว่าค่านี้ได้ตามที่เห็นสมควร หากไม่ได้ระบุค่าไว้ (หรือระบุค่ามากเกินไป) เซิร์ฟเวอร์จะกำหนดขีดจำกัดของตนเอง

ค่านี้ต้องไม่เป็นค่าลบ

เนื้อความของคำขอ

เนื้อหาของคำขอต้องว่างเปล่า

เนื้อหาการตอบกลับ

หากทำสำเร็จ เนื้อหาการตอบกลับจะมีข้อมูลที่มีโครงสร้างต่อไปนี้

การแสดง JSON 
{
  "locations": [
    {
      object (Location)
    }
  ],
  "nextPageToken": string
}
ช่อง
locations[]

object (Location)

ผลการค้นหา 1 หน้าจากการโทรไปที่ 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 ดูข้อมูลเพิ่มเติมเกี่ยวกับประเภทของตำแหน่งทรัพยากร GCP

Enum
LOCATION_TYPE_UNSPECIFIED ใช้ภายในเพื่อแยกค่าที่ไม่ได้ตั้งค่าและไม่ได้มีไว้สำหรับใช้ภายนอก
REGIONAL

สถานที่ตั้งนี้เป็นสถานที่ตั้งระดับภูมิภาค

ระบบจะจำลองข้อมูลในตำแหน่งระดับภูมิภาคในหลายโซนภายในภูมิภาค
MULTI_REGIONAL

สถานที่ตั้งเป็นสถานที่ตั้งแบบหลายภูมิภาค

ระบบจะจำลองข้อมูลในสถานที่ตั้งแบบหลายภูมิภาคในหลายภูมิภาค ภายในแต่ละภูมิภาค ระบบจะจำลองข้อมูลในหลายโซน

ฟีเจอร์ตำแหน่ง

ผลิตภัณฑ์และบริการที่พร้อมใช้งานในตำแหน่งทรัพยากร GCP

Enum
LOCATION_FEATURE_UNSPECIFIED ใช้ภายในเพื่อแยกค่าที่ไม่ได้ตั้งค่าและไม่ได้มีไว้สำหรับใช้ภายนอก
FIRESTORE

ตำแหน่งที่ตั้งนี้รองรับอินสแตนซ์ฐานข้อมูล Cloud Firestore

App Engine พร้อมให้ใช้งานในตำแหน่งนี้ จึงสามารถใช้เป็นตำแหน่งทรัพยากร GCP เริ่มต้นของโปรเจ็กต์
DEFAULT_STORAGE

ตำแหน่งที่ตั้งนี้รองรับที่เก็บข้อมูล Cloud Storage เริ่มต้น

App Engine พร้อมให้ใช้งานในตำแหน่งนี้ จึงสามารถใช้เป็นตำแหน่งทรัพยากร GCP เริ่มต้นของโปรเจ็กต์
FUNCTIONS Cloud Functions for Firebase พร้อมใช้งานในตำแหน่งนี้