Method: projects.locations.instances.list

แสดงรายการ DatabaseInstance แต่ละรายการที่เกี่ยวข้องกับโปรเจ็กต์หลักที่ระบุ

รายการจะถูกส่งกลับโดยไม่มีลำดับใดเป็นพิเศษ แต่จะเป็นมุมมองที่สอดคล้องกันของอินสแตนซ์ฐานข้อมูลเมื่อมีการร้องขอเพิ่มเติมด้วย pageToken

รายการผลลัพธ์ประกอบด้วยอินสแตนซ์ใน STATE ใดๆ

ผลลัพธ์ของรายการอาจไม่เก่าภายในไม่กี่วินาที

ใช้ instances.get เพื่อการอ่านที่สอดคล้องกัน

คำขอ HTTP

GET https://firebasedatabase.googleapis.com/v1beta/{parent=projects/*/locations/*}/instances

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

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

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

string

โปรเจ็กต์หลักที่จะแสดงรายการอินสแตนซ์ฐานข้อมูล ในรูปแบบ: projects/{project-number}/locations/{location-id}

หากต้องการแสดงรายการในสถานที่ทั้งหมด ให้ใช้รายการหลักในรูปแบบ: projects/{project-number}/locations/-

การให้สิทธิ์ต้องได้รับอนุญาต IAM ต่อไปนี้ในทรัพยากร parent บนสุดที่ระบุ:

  • firebasedatabase.instances.list

พารามิเตอร์แบบสอบถาม

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

string

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

pageSize

integer

จำนวนอินสแตนซ์ฐานข้อมูลสูงสุดที่จะส่งคืนในการตอบกลับ

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

showDeleted

boolean

ระบุว่าควรส่งคืน DatabaseInstances ในสถานะ DELETED ด้วย

ขอร่างกาย

เนื้อความของคำขอจะต้องว่างเปล่า

ร่างกายตอบสนอง

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

การตอบสนองจากเมธอด instances.list

การเป็นตัวแทน JSON
{
  "instances": [
    {
      object (DatabaseInstance)
    }
  ],
  "nextPageToken": string
}
เขตข้อมูล
instances[]

object ( DatabaseInstance )

รายการ DatabaseInstance แต่ละรายการที่อยู่ในโปรเจ็กต์ Firebase หลัก

nextPageToken

string

หากรายการผลลัพธ์มีขนาดใหญ่เกินกว่าจะพอดีกับคำตอบเดียว โทเค็นจะถูกส่งกลับ หากสตริงว่างเปล่า การตอบกลับนี้จะเป็นหน้าสุดท้ายของผลลัพธ์

โทเค็นนี้สามารถใช้ในการเรียก instances.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

สำหรับข้อมูลเพิ่มเติม โปรดดู ภาพรวมการตรวจสอบสิทธิ์