Method: projects.locations.dataStores.get

הפונקציה מחזירה DataStore.

בקשת HTTP


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

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

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

פרמטרים
name

string

חובה. שם המשאב המלא של DataStore, למשל projects/{project}/locations/{location}/collections/{collectionId}/dataStores/{dataStoreId}.

אם למשתמש שקורא ל-API אין הרשאה לגשת אל DataStore, בין אם הוא קיים ובין אם לא, תוחזר שגיאת PERMISSION_DENIED.

אם ה-DataStore המבוקש לא קיים, מוחזרת שגיאת NOT_FOUND.

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

פרמטרים
view

enum (DataStoreView)

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

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

גוף הבקשה

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

גוף התשובה

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

היקפי הרשאות

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

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

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

הרשאות IAM

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

  • discoveryengine.dataStores.get

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