- Solicitud HTTP
- Parámetros de ruta
- Parámetros de consulta
- Cuerpo de la solicitud
- Cuerpo de la respuesta
- Alcances de autorización
- PartitionCursor
- Cursor
Muestra toda la información del cursor confirmado de una suscripción.
Solicitud HTTP
GET https://{endpoint}/v1/cursor/{parent=projects/*/locations/*/subscriptions/*}/cursors
En el que {endpoint}
es uno de los extremos del servicio admitidos.
Las URL usan la sintaxis de transcodificación gRPC.
Parámetros de ruta
Parámetros | |
---|---|
parent |
Obligatorio La suscripción para la que se recuperan los cursores. Se estructura como |
Parámetros de consulta
Parámetros | |
---|---|
pageSize |
La cantidad máxima de cursores que se mostrarán. Es posible que el servicio muestre menos de este valor. Si no se configura o si es cero, se mostrarán todos los cursores del elemento principal. |
pageToken |
Un token de página, recibido desde una llamada Durante la paginación, todos los demás parámetros proporcionados a |
Cuerpo de la solicitud
El cuerpo de la solicitud debe estar vacío.
Cuerpo de la respuesta
Si se ejecuta correctamente, el cuerpo de la respuesta contiene datos con la siguiente estructura:
Respuesta para cursors.list
Representación JSON | |
---|---|
{
"partitionCursors": [
{
object ( |
Campos | |
---|---|
partitionCursors[] |
Los cursores de partición de esta solicitud. |
nextPageToken |
Un token, que se puede enviar como |
Permisos de autorización
Se requiere el siguiente permiso de OAuth:
https://www.googleapis.com/auth/cloud-platform
Para obtener más información, consulta Descripción general de la autenticación.
PartitionCursor
Un par de un cursor y la partición para la que es.
Representación JSON | |
---|---|
{
"partition": string,
"cursor": {
object ( |
Campos | |
---|---|
partition |
La partición es para esto. |
cursor |
El valor del cursor. |
Cursor
Un cursor que describe la posición de un mensaje dentro de una partición de tema.
Representación JSON | |
---|---|
{ "offset": string } |
Campos | |
---|---|
offset |
El desplazamiento de un mensaje dentro de una partición de tema. Debe ser mayor o igual que 0. |