CMDBQueryBuilderAPI - Global

A CMDBQueryBuilderAPI fornece métodos para recuperar detalhes de execução de consulta salvos do Construtor de consulta em scripts do lado do servidor.

Para acessar essa API, você deve ativar o plug-in Configuration Management (CMDB) (com.snc.cmdb).

Para obter mais informações sobre o Construtor de consulta do CMDB, consulte Consulta ao CMDB.

CMDBQueryBuilderAPI - getSavedQueryExecutionDetails(cadeia de caracteres "svagQueryName", Booliano executeQuery, Tempo limite do número)

Retorna os detalhes da execução de uma consulta salva do Construtor de consulta Configuration Management Database (CMDB) especificada.

Opcionalmente, você pode especificar se deseja executar a consulta ou não, para retornar os detalhes de execução da consulta mais recente. Você também pode substituir o limite de tempo limite padrão para a execução da consulta.

Em caso de um problema de tempo limite ou de memória durante a execução da consulta, você pode ajustar o tamanho do lote de consulta para ajudar a atenuar esses problemas. Para obter informações adicionais, consulte Tamanho do lote para consultas salvas do Construtor de consulta.

Tabela 1. Parâmetros

Nome	Tipo	Descrição
executeQuery	Booliano	Opcional. Sinalizador que indica se a consulta especificada deve ser executada ou não. Valores válidos: verdadeiro: execute a consulta especificada e retorne seus detalhes de execução. falso: não execute a consulta especificada. Retornar os detalhes da execução mais recente da consulta. Padrão: Falso
salvadoNomeDeConsulta	Cadeia de caracteres	Nome da consulta salva do Construtor de consulta do CMDB para a qual serão retornados detalhes de execução da consulta.
tempo limite	Número	Opcional. Valor inteiro que substitui o limite de tempo limite de execução de consulta padrão de cinco minutos. Unidade: segundos Padrão: cinco minutos

Tabela 2. Retorna

Tipo	Descrição
Erro	Código de erro e mensagem. Retornado quando a execução da consulta falha ou a consulta especificada não é encontrada. Exemplos de erros: {"error": "QUERY_EXECUTION_NOT_FOUND", "message": "Detalhes da execução da consulta não encontrados. Execute a consulta."} {"error": "QUERY_NOT_FOUND", "message": "Consulta salva fornecida não encontrada. Certifique-se de passar o nome de uma consulta salva."} {"error": "QUERY_EXECUTION_FAILED", "message": "Falha na execução da consulta. Use uma consulta válida."}
query_id	ID de execução de consulta salvo (sys_id). Obtido da tabela Status da consulta [qb_query_status].
table_name	Nome da tabela que contém os detalhes da consulta de execução.
status	Status da execução da consulta. CONCLUÍDO: a execução está concluída. FAILED: ocorreu um erro ao executar a consulta. TIME_OUT: tempo esgotado para a execução da consulta. MAX_LIMIT: o número máximo de resultados retornados foi atingido.

Este exemplo mostra como chamar o método getSavedQueryExecutionDetails().

SNC.CMDBQueryBuilderAPI.getSavedQueryExecutionDetails('Test', true);

Saída:

{"query_id":"024fd53a7773330033b5270bba106141",
"table_name":"u_cmdb_qb_result_598918aacb4dbf3f1a8dcf03fce6a5d57151a4e2",
"status":COMPLETE}

Este exemplo mostra como chamar o método getSavedQueryExecutionDetails() e substituir o valor de tempo limite de execução da consulta padrão para 10 minutos.

SNC.CMDBQueryBuilderAPI.getSavedQueryExecutionDetails('Test', true, 600);

Saída:

{"query_id":"024fd53a7773330033b5270bba106141",
"table_name":"u_cmdb_qb_result_598918aacb4dbf3f1a8dcf03fce6a5d57151a4e2",
"status":COMPLETE}