Method: projects.availableLocations.list

แสดงรายการตำแหน่งทรัพยากร 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

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

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

string

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

projects/ PROJECT_IDENTIFIER

โปรดดูช่อง name FirebaseProject สำหรับรายละเอียดเกี่ยวกับค่า PROJECT_IDENTIFIER

หากไม่มีการระบุตัวระบุโปรเจ็กต์ที่ไม่ซ้ำกัน (นั่นคือ 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 เรียนรู้เพิ่มเติมเกี่ยวกับ ประเภทของตำแหน่งทรัพยากร 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 Cloud Functions สำหรับ Firebase มีให้บริการในตำแหน่งนี้