GetCursor - Simple Log Service - Centro de documentación de Alibaba Cloud

Descripción de la operación

Descripción

El host consta de un nombre de proyecto y un endpoint de Simple Log Service. Debe especificar el nombre del proyecto en el host.
La relación entre un cursor, un proyecto, un Logstore y un shard es la siguiente:
- Un proyecto contiene múltiples Logstores.
- Cada Logstore contiene múltiples shards.
- Un cursor indica la posición de un registro específico.

Pruébelo ahora

Pruebe esta API en OpenAPI Explorer sin necesidad de firma manual. Las llamadas exitosas generan automáticamente código SDK acorde a sus parámetros. Descárguelo con seguridad de credenciales integrada para uso local.

Test

Autorización de RAM

La siguiente tabla describe la autorización necesaria para invocar esta API. Puede definirla en una directiva de Resource Access Management (RAM). A continuación, se detallan las columnas de la tabla:

Action: Estas acciones se utilizan en el elemento Action de las declaraciones de directivas de permisos de RAM para otorgar permisos que permitan realizar la operación.
API: La API que debe invocarse para llevar a cabo la acción.
Nivel de acceso: Nivel de acceso predefinido que se concede para cada API. Valores válidos: create, list, get, update y delete.
Tipo de recurso: Tipo de recurso que admite autorización para ejecutar la acción. Indica si la acción es compatible con permisos a nivel de recurso. El recurso especificado debe ser compatible con la acción; de lo contrario, la directiva no surtirá efecto.
- En las API con permisos a nivel de recurso, los tipos de recursos obligatorios se marcan con un asterisco (*). Especifique el Alibaba Cloud Resource Name (ARN) correspondiente en el elemento Resource de la directiva.
- Para las API sin permisos a nivel de recurso, se muestra All Resources. Utilice un asterisco (*) en el elemento Resource de la directiva.
Clave de condición: Claves de condición definidas por el servicio. Permiten un control granular y se aplican ya sea solo a acciones o a acciones asociadas con recursos específicos. Además de las claves de condición específicas del servicio, Alibaba Cloud proporciona un conjunto de common condition keys aplicables a todos los servicios compatibles con RAM.
Acción dependiente: Acciones dependientes necesarias para ejecutar la acción principal. Para completar la operación, el usuario de RAM o el rol de RAM debe contar con permisos para realizar todas las acciones dependientes.

Action

Nivel de acceso

Tipo de recurso

Clave de condición

Acción dependiente

log:GetCursorOrData

get

*LogStore

acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logstore/{#LogstoreName}

log:TLSVersion

Ninguna

Sintaxis de la solicitud

GET /logstores/{logstore}/shards/{shardId}?type=cursor HTTP/1.1

Parámetros de ruta

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
logstore	string	Sí	El nombre del Logstore.	sls-test-logstore
shardId	integer	Sí	El ID del shard.	1

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
project	string	Sí	El nombre del proyecto.	ali-test-project
from	string	Sí	Un punto en el tiempo. Puede ser una marca de tiempo UNIX o la cadena `begin` o `end`.	begin

Puede utilizar el parámetro from para localizar registros dentro del ciclo de vida de un shard. Si el ciclo de vida del Logstore es [begin_time,end_time) y el parámetro from se establece en from_time, el comportamiento es el siguiente:

Si from_time es menor o igual que begin_time, o si from_time se establece en 'begin', se devuelve el cursor correspondiente a la posición en begin_time.
Si from_time es mayor o igual que end_time, o si from_time se establece en 'end', se devuelve el cursor correspondiente a la posición donde se escribirá el siguiente registro. No existen datos en esta posición del cursor.
Si from_time es mayor que begin_time y menor que end_time, se devuelve el cursor del primer paquete de datos cuya hora de recepción en el servidor sea mayor o igual que from_time.

Nota

El ciclo de vida de un Logstore se especifica mediante el campo TTL en sus propiedades. Por ejemplo, si la hora actual es 2018-11-11 09:00:00 y el TTL es 5, el intervalo de tiempo de los datos que se pueden consumir en cada shard es [2018-11-05 09:00:00,2018-11-11 09:00:00). Esta hora corresponde a la hora del servidor. Para obtener más información, consulte Periodo de retención de datos.

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	El valor del cursor.
cursor	string	El valor del cursor.	MTQ0NzI5OTYwNjg5NjYzMjM1Ng==

Ejemplos

Respuesta exitosa

JSON Formato

{
  "cursor": "MTQ0NzI5OTYwNjg5NjYzMjM1Ng=="
}

Códigos de error

Consulte Códigos de error para ver la lista completa.

Notas de la versión

Consulte Notas de la versión para ver la lista completa.