Method: projects.locations.dataStores.list

רשימה של כל ה-DataStore שמשויכים לפרויקט.

בקשת HTTP


GET https://discoveryengine.googleapis.com/v1alpha/{parent=projects/*/locations/*}/dataStores

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

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

פרמטרים
parent

string

חובה. שם המשאב של ענף ההורה, למשל projects/{project}/locations/{location}/collections/{collectionId}.

אם למבצע הקריאה אין הרשאה להציג רשימה של DataStores במיקום הזה, בין אם מאגר הנתונים הזה קיים ובין אם לא, מוחזרת שגיאת PERMISSION_DENIED.

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

פרמטרים
pageSize

integer

מספר המקסימלי של DataStores שיוחזרו. אם לא מציינים ערך, ברירת המחדל היא 10. הערך המקסימלי המותר הוא 50. ערכים מעל 50 יומרו ל-50.

אם הערך בשדה הזה שלילי, מוחזרת שגיאה INVALID_ARGUMENT.
pageToken

string

טוקן של דף ListDataStoresResponse.next_page_token שהתקבל מקריאה קודמת של DataStoreService.ListDataStores. צריך להזין את הטוקן כדי לאחזר את הדף הבא.

כשמבצעים חלוקה לעמודים, כל הפרמטרים האחרים שסופקו ל-DataStoreService.ListDataStores חייבים להיות זהים לקריאה שסיפקה את הטוקן של הדף. אחרת, מוחזרת שגיאת INVALID_ARGUMENT.
filter

string

מסננים לפי סוג הפתרון . לדוגמה: filter = 'solutionType:SOLUTION_TYPE_SEARCH'
view

enum (DataStoreView)

זה שינוי אופציונלי. התצוגה שרוצים להחיל על DataStores שהוחזרו. אם לא מציינים ערך, ברירת המחדל היא DataStoreView.DATA_STORE_VIEW_BASIC.

בנוסף, הפרמטר DataStoreView.DATA_STORE_VIEW_FULL מאכלס את הפרמטר DataStore.icon_uri במאגרי נתונים שמגובים על ידי מחבר. כדי לפתור סמלי מחברים נדרשות בדיקות נוספות, ולכן צריך לבקש אותם רק כשהמתקשר מעבד את הסמלים.

גוף הבקשה

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

גוף התשובה

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

היקפי הרשאות

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

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

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

הרשאות IAM

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

  • discoveryengine.dataStores.list

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