Method: projects.locations.dataStores.sessions.list

Muestra todas las sesiones por su DataStore principal.

Solicitud HTTP

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

La URL utiliza la sintaxis de transcodificación a gRPC.

Parámetros de ruta

Parámetros
parent

string

Obligatorio. Nombre de recurso del almacén de datos. Formato: projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStoreId}

Los parámetros de consulta

Parámetros
pageSize

integer

Número máximo de resultados que se devolverán. Si no se especifica, el valor predeterminado es 50. El valor máximo permitido es 1000.
pageToken

string

Token de página recibido de una llamada sessions.list anterior. Proporciona este elemento para obtener la siguiente página.
filter

string

Lista separada por comas de los campos por los que se va a filtrar, en gramática EBNF.

Los campos admitidos son:

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

Ejemplos:

  • 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

Lista separada por comas de campos por los que se ordenará el resultado, ordenados de forma ascendente. Usa "desc" después del nombre de un campo para ordenarlo de forma descendente.

Campos admitidos:

  • update_time
  • create_time
  • session_name
  • is_pinned

Ejemplo:

  • update_time desc
  • create_time
  • is_pinned desc,update_time desc: lista las sesiones primero por is_pinned y, después, por update_time.

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

Si la solicitud se hace correctamente, en el cuerpo de la respuesta se incluye una instancia de ListSessionsResponse.

Permisos de autorización

Debes disponer de uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta el Authentication Overview.

Permisos de IAM

Requiere el siguiente permiso de gestión de identidades y accesos en el recurso parent:

  • discoveryengine.sessions.list

Para obtener más información, consulta la documentación de gestión de identidades y accesos.