Tema anterior: Acerca de los ejemplos de API

Tema siguiente: getQueryList

GetObject

Puede utilizar este archivo de comandos para recuperar varios tipos de información. Puede utilizarlo para recuperar una lista de consultas, informes o parámetros globales, así como la gramática de eventos comunes (CEG). El comando getObject utiliza un calificador o argumento denominado “type” (tipo) para determinar los datos que se devolverán al llamador, tal como se muestra en el siguiente ejemplo:

https://ELMSERVER:5250/spin/calmapi/getObject.csp?type=type&tag=tagname1&tag=tagnamen&taglogic=OR|AND

En la lista que se muestra a continuación se incluye un resumen de los tipos de datos que se devuelven mediante las variaciones de este comando:

getQueryList

Devuelve una cadena XML en la que se muestran todas las consultas de CA Enterprise Log Manager. getQueryList admite varios parámetros de filtrado, lo que le permite seleccionar e incluir los nombres de consulta adecuados en las llamadas a API.

getReportList

Devuelve una cadena XML en la que se muestran todos los informes de CA Enterprise Log Manager. getReportList admite varios parámetros de filtrado, lo que le permite seleccionar e incluir los nombres de informe adecuados en las llamadas a API.

getDataModel

Devuelve la gramática de eventos comunes (CEG) en formato XML. Puede seleccionar los términos de la gramática de eventos comunes que desee incluir en el filtrado de la llamada a API.

getIdealModel

Devuelve los modelos ideales definidos en la gramática de eventos comunes. Puede seleccionar los términos de las áreas generales del producto que desee incluir en el filtrado de la llamada a API.

getIncidentModel

Devuelve los campos de la gramática de eventos comunes disponibles utilizados en incidentes generados por la correlación de eventos.

getCombinedModel

Devuelve la gramática de eventos comunes (CEG) en formato XML tanto para campos de evento como para campos de incidente. Puede seleccionar los términos de la gramática de eventos comunes que desee incluir en el filtrado de la llamada a API.

getGlobalSettings

Devuelve la configuración global del servidor de CA Enterprise Log Manager con la que se ejecuta el comando. Puede intentar conocer el filtrado que ya está en uso en las consultas de CA Enterprise Log Manager con el objetivo de crear filtros efectivos para la llamada a API.

getELMServers

Devuelve una lista de servidores de CA Enterprise Log Manager. Este comando resulta útil en un entorno federado, ya que permite dirigirse a los servidores primarios o secundarios que se desea incluir en la consulta.

getTimeZones

Obtiene una lista de las zonas horarias que pueden utilizarse a modo de argumento en la ejecución de consultas.

getVersion

Devuelve la versión de ELM, que coincide con la versión de las API, lo que resulta útil para realizar diagnósticos.

getObjectDefinition

Devuelve los metadatos de un informe o consulta cuando se proporciona un ID de objeto específico. Se califican como metadatos todos los datos de formato que determinan el modo de presentación de un informe o una consulta. Use los metadatos cuando deba utilizar la llamada runQuery con el fin de obtener datos de CA Enterprise Log Manager para una aplicación en la que no sea posible insertar directamente el visor de consultas o informes.

getQueryViewer

Devuelve la página HTML en la que se incluye el componente del visor de consultas cargado previamente con una consulta especificada.

getReportViewer

Devuelve la página HTML en la que se incluye el componente del visor de informes cargado previamente con un informe especificado.

Todos los comandos de GetObject, a excepción de getQueryViewer y getReportViewer, devuelven un error en caso de que no haya una sesión autenticada en el comando de API:

Respuesta incorrecta:
<?xml version="1.0" encoding="UTF-8" ?> 
<Result>
<Value>false</Value>
	<Description> User is not logged in</Description>
</Result>

En el ejemplo anterior, se ha obtenido el valor de resultado “false” (falso), lo que indica la existencia de un error cuyo motivo se incluye en la descripción, en este caso, “User is not logged in” (El usuario no ha iniciado sesión).

Más información:

Llamadas de los visores de consultas e informes