ListLogs - OpenSearch - Centro de documentación de Alibaba Cloud

Descripción de la operación

Método

GET

URI

/openapi/ha3/instances/{instanceId}/logs

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

searchengine:ListLogs

list

*Instance

acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}

Ninguna

Sintaxis de la solicitud

GET /openapi/ha3/instances/{instanceId}/logs HTTP/1.1

Parámetros de ruta

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
instanceId	string	Sí	El ID de la instancia.	ha-cn-i7m2roiy504

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
type	string	No	El tipo de registro. Valores válidos: `select` (registros de consulta) y `push` (registros de escritura).	push
pageNum	string	No	El número de página. El valor predeterminado es 1.	1
pageSize	string	No	El número de entradas que se devolverán en cada página. El valor predeterminado es 10.	10
startTime	string	No	El inicio del intervalo de tiempo a consultar. Es una marca de tiempo UNIX en segundos.	1706340600
endTime	string	No	El final del intervalo de tiempo a consultar. Es una marca de tiempo UNIX en segundos.	1710432000
query	string	No	La instrucción de búsqueda.	status: 200 AND totalTime > 0.01

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object
requestId	string	El ID de la solicitud.	022F36C7-9FB4-5D67-BEBC-3D14B0984463
result	object	El resultado devuelto.
result	array	El conjunto de resultados.
	any	La información de los registros.	[{"requestTime":"2024-07-02T16:06:57+08:00","totalTime":"0.003","requestId":"6d63e7a9b58a04827cfxxxxx","host":"ha-cn-xxx.ha.aliyuncs.com","requestUri":"/vector-service/fetch","status":"200"}]
totalCount	integer	El número total de registros.	5

Ejemplos

Respuesta exitosa

JSON Formato

{
  "requestId": "022F36C7-9FB4-5D67-BEBC-3D14B0984463",
  "result": {
    "result": [
      "[{\"requestTime\":\"2024-07-02T16:06:57+08:00\",\"totalTime\":\"0.003\",\"requestId\":\"6d63e7a9b58a04827cfxxxxx\",\"host\":\"ha-cn-xxx.ha.aliyuncs.com\",\"requestUri\":\"/vector-service/fetch\",\"status\":\"200\"}]"
    ],
    "totalCount": 5
  }
}

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.