Method: projects.locations.collections.engines.getWorkspaceSettings

מקבלים את הגדרות Workspace למשתמש הקצה.

בקשת HTTP

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

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

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

פרמטרים
name

string

חובה. השם המלא של משאב המנוע. פורמט: projects/{project}/locations/{location}/collections/{collectionId}/engines/{engineId}

גוף הבקשה

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

גוף התשובה

הגדרות Workspace למשתמש הקצה.

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

ייצוג JSON 
{
  "workspaceAccessEnabled": boolean,
  "customerDomainValid": boolean
}
שדות
workspaceAccessEnabled

boolean

האם למשתמש קצה יש גישה ל-Workspace.
customerDomainValid

boolean

האם הדומיין של הלקוח של המשתמש המתקשר תואם למאגרי הנתונים של Workspace במסגרת המנוע הזה.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של 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 הבאה במשאב name:

  • discoveryengine.engines.get

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