Method: projects.locations.list

רשימת המיקומים הנתמכים בשירות הזה.

השיטה הזו מציגה רשימה של מיקומים על סמך היקף המשאבים שצוין בשדה ListLocationsRequest.name:

  • מיקומים גלובליים: אם name ריק, השיטה מציגה את המיקומים הציבוריים שזמינים לכל הפרויקטים.
  • מיקומים ספציפיים לפרויקט: אם name הוא בפורמט projects/{project}, הפונקציה מחזירה רשימה של מיקומים שגלויים לפרויקט הספציפי הזה. המיקומים האלה כוללים מיקומים ציבוריים, פרטיים או מיקומים אחרים שספציפיים לפרויקט והופעלו בו.

בהטמעות של gRPC וספריית הלקוח, שם המשאב מועבר כשדה name. בשיחות שירות ישירות, שם המשאב משולב בנתיב הבקשה על סמך ההטמעה והגרסה הספציפיות של השירות.

בקשת HTTP


GET https://universalledger.googleapis.com/v1/{name=projects/*}/locations

כתובות ה-URL כתובות בתחביר של gRPC Transcoding.

פרמטרים של נתיב

פרמטרים
name

string

המשאב שבבעלותו אוסף המיקומים, אם רלוונטי.

פרמטרים של שאילתה

פרמטרים
filter

string

מסנן לצמצום התוצאות לקבוצת משנה מועדפת. שפת הסינון מקבלת מחרוזות כמו "displayName=tokyo", והיא מתועדת בפירוט נוסף ב-AIP-160.
pageSize

integer

המספר המקסימלי של תוצאות שיוחזרו. אם לא מגדירים את המדיניות, השירות יבחר ברירת מחדל.
pageToken

string

טוקן של דף שהתקבל מהשדה nextPageToken בתגובה. שולחים את טוקן הדף כדי לקבל את הדף הבא.
extraLocationTypes[]

string

זה שינוי אופציונלי. אין להשתמש בשדה הזה אלא אם צוין אחרת במפורש במסמכים. השימוש הזה מיועד בעיקר לשימוש פנימי.

גוף הבקשה

גוף הבקשה צריך להיות ריק.

גוף התשובה

הודעת התשובה ל-Locations.ListLocations.

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל נתונים במבנה הבא:

ייצוג ב-JSON 
{
  "locations": [
    {
      object (Location)
    }
  ],
  "nextPageToken": string
}
שדות
locations[]

object (Location)

רשימת מיקומים שתואמים למסנן שצוין בבקשה.
nextPageToken

string

טוקן הדף הבא של הרשימה הרגילה.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/cloud-platform

ניתן למצוא מידע נוסף כאן: Authentication Overview.