Method: projects.locations.clusters.list

השיטה מחזירה רשימה של כל אשכולות Redis שבבעלות פרויקט במיקום (אזור) שצוין או בכל המיקומים.

המיקום צריך להיות בפורמט הבא:

  • projects/{projectId}/locations/{locationId}

אם מציינים את הערך locationId כ-- (תו כללי), מתבצעת שאילתה על כל האזורים שזמינים לפרויקט, והתוצאות מצטברות.

בקשת HTTP

GET https://redis.googleapis.com/v1beta1/{parent=projects/*/locations/*}/clusters

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

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

פרמטרים
parent

string

חובה. שם המשאב של מיקום האשכול בפורמט: projects/{projectId}/locations/{locationId} כאשר locationId מתייחס לאזור Google Cloud.

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

פרמטרים
pageSize

integer

מספר הפריטים המקסימלי שיוחזרו.

אם לא מציינים ערך, השירות משתמש בערך ברירת המחדל 1,000. ללא קשר לערך של pageSize, יכול להיות שהתגובה תכלול רשימה חלקית, והמתקשר צריך להסתמך רק על nextPageToken של התגובה כדי לקבוע אם יש עוד אשכולות שאפשר לשלוח להם שאילתה.
pageToken

string

הערך nextPageToken שמוחזר מבקשת clusters.list קודמת, אם יש כזה.

גוף הבקשה

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

גוף התשובה

תשובה לשאילתה clusters.list.

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

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

object (Cluster)

רשימה של אשכולות Redis בפרויקט במיקום שצוין, או בכל המיקומים.

אם הערך locationId בשדה parent של הבקשה הוא '-', המערכת תבצע שאילתה בכל האזורים שזמינים לפרויקט ותצבור את התוצאות. אם בבקשה כזו של נתונים מצטברים מיקום מסוים לא זמין, בתגובה ייכלל placeholder של רשומה ב-Redis עם השדה name שמוגדר לערך מהצורה projects/{projectId}/locations/{locationId}/clusters/- והשדה status שמוגדר ל-ERROR והשדה statusMessage שמוגדר ל-location not available for clusters.list.
nextPageToken

string

אסימון לאחזור של דף התוצאות הבא, או ערך ריק אם אין יותר תוצאות ברשימה.
unreachable[]

string

מיקומים שלא ניתן להגיע אליהם.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

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

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