Method: projects.locations.list

מפרט מידע על המיקומים הנתמכים עבור שירות זה.

שיטה זו מפרטת מיקומים בהתבסס על טווח המשאבים שסופק בשדה ListLocationsRequest.name:

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

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

בקשת HTTP

GET https://storagebatchoperations.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.

הרשאות IAM

נדרשת הרשאת IAM הבאה במשאב name:

  • storagebatchoperations.locations.list

מידע נוסף מופיע במאמרי העזרה בנושא IAM.