Package google.cloud.location

אינדקס

מיקומים

ממשק מופשט שמספק מידע שקשור למיקום של שירות. מטא-נתונים שספציפיים לשירות מסופקים דרך השדה Location.metadata.

GetLocation

rpc GetLocation(GetLocationRequest) returns (Location)

קבלת מידע על מיקום.

היקפי הרשאות

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

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

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

הרשאות IAM

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

  • observability.locations.get

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

rpc ListLocations(ListLocationsRequest) returns (ListLocationsResponse)

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

  • רשימת כל המיקומים הציבוריים: משתמשים בנתיב GET /v1/locations.
  • רשימת מיקומים שגלויים לפרויקט: משתמשים בנתיב GET /v1/projects/{project_id}/locations. זה יכול לכלול מיקומים ציבוריים וגם מיקומים פרטיים או מיקומים אחרים שגלויים רק בפרויקט.
היקפי הרשאות

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

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

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

הרשאות IAM

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

  • observability.locations.list

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

GetLocationRequest

ההודעה עם הבקשה מ-Locations.GetLocation.

שדות
name

string

שם המשאב של המיקום.

ListLocationsRequest

ההודעה עם הבקשה מ-Locations.ListLocations.

שדות
name

string

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

string

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

int32

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

string

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

string

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

ListLocationsResponse

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

שדות
locations[]

Location

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

string

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

מיקום

משאב שמייצג מיקום ב-Google Cloud.

שדות
name

string

שם המשאב של המיקום, שעשוי להיות שונה בהטמעות שונות. לדוגמה: "projects/example-project/locations/us-east1"
location_id

string

המזהה הקנוני של המיקום הזה. לדוגמה: "us-east1".
display_name

string

השם הידידותי של המיקום, בדרך כלל שם של עיר סמוכה. לדוגמה, 'טוקיו'.
labels

map<string, string>

מאפיינים של המיקום שרלוונטיים לכמה שירותים. לדוגמה

{"cloud.googleapis.com/region": "us-east1"}
metadata

Any

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