Method: projects.locations.backupCollections.list

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

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

בקשת HTTP

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

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

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

פרמטרים
parent

string

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

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

פרמטרים
pageSize

integer

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

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

string

זה שינוי אופציונלי. הערך nextPageToken שמוחזר מבקשת [backupCollections.list] קודמת, אם יש כזה.

גוף הבקשה

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

גוף התשובה

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

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

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

object (BackupCollection)

רשימה של backupCollections בפרויקט.

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

string

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

string

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

היקפי הרשאות

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

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

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