Method: projects.locations.collections.engines.sessions.list

Listet alle Sitzungen nach dem übergeordneten DataStore auf.

HTTP-Anfrage

GET https://discoveryengine.googleapis.com/v1/{parent=projects/*/locations/*/collections/*/engines/*}/sessions

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
parent

string

Erforderlich. Der Ressourcenname des Datenspeichers. Format: projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStoreId}

Suchparameter

Parameter
pageSize

integer

Maximale Anzahl der zurückzugebenden Ergebnisse. Wenn nicht angegeben, lautet die Standardeinstellung 50. Der maximal zulässige Wert beträgt 1.000.
pageToken

string

Ein Seitentoken, das von einem vorherigen sessions.list-Aufruf empfangen wurde. Geben Sie dieses an, um die nachfolgende Seite abzurufen.
filter

string

Eine durch Kommas getrennte Liste der Felder, nach denen gefiltert werden soll, in EBNF-Grammatik.

Folgende Felder werden unterstützt:

  • user_pseudo_id
  • state
  • display_name
  • starred
  • is_pinned
  • labels
  • create_time
  • update_time

Beispiele:

  • user_pseudo_id = some_id
  • display_name = "some_name"
  • starred = true
  • is_pinned=true AND (NOT labels:hidden)
  • create_time > "1970-01-01T12:00:00Z"
orderBy

string

Eine durch Kommas getrennte Liste von Feldern, nach denen in aufsteigender Reihenfolge sortiert werden soll. Verwenden Sie „desc“ nach einem Feldnamen für die absteigende Sortierung.

Unterstützte Felder:

  • update_time
  • create_time
  • session_name
  • is_pinned

Beispiel:

  • update_time desc
  • create_time
  • is_pinned desc,update_time desc: listet Sitzungen zuerst nach „is_pinned“ und dann nach „update_time“ auf.

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Wenn der Vorgang erfolgreich abgeschlossen wurde, enthält der Antworttext eine Instanz von ListSessionsResponse.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

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

Weitere Informationen finden Sie unter Authentication Overview.

IAM-Berechtigungen

Erfordert die folgende IAM-Berechtigung für die Ressource parent:

  • discoveryengine.sessions.list

Weitere Informationen finden Sie in der IAM-Dokumentation.