Method: projects.locations.collections.engines.getWorkspaceSettings

Obtenir les paramètres Workspace de l'utilisateur final.

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
name

string

Obligatoire. Nom complet de la ressource de moteur. Format: projects/{project}/locations/{location}/collections/{collectionId}/engines/{engineId}

Corps de la requête

Le corps de la requête doit être vide.

Corps de la réponse

Paramètres Workspace de l'utilisateur final.

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Représentation JSON 
{
  "workspaceAccessEnabled": boolean
}
Champs
workspaceAccessEnabled

boolean

Indique si l'accès Workspace est activé pour un utilisateur final.

Niveaux d'accès des autorisations

Nécessite l'un des niveaux d'accès OAuth suivants :

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

Pour plus d'informations, consultez la page Authentication Overview.

Autorisations IAM

Nécessite l'autorisation IAM suivante sur la ressource name :

  • discoveryengine.engines.get

Pour en savoir plus, consultez la documentation IAM.