--- sourceDocument: Referência de API do Xanadu sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/pt-BR/xanadu/api-reference Release : - xanadu ft:locale : - pt-BR ft:publication_title : - Referência de API do Xanadu ft:clusterId : - crapiref bundleId : - crapiref workflow : - Creator --- # API Agent Client Collector # API Agent Client Collector {#ariaid-title1} * Versão de lançamento: Xanadu * * Atualizado 1 de ago. de 2024 * * ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 76 min. de leitura A API Agent Client Collector fornece endpoints para gerenciar ações em agentes disponíveis e gerenciar políticas. Esta API requer a aplicação da loja Agent Client Collector Framework (sn_agent) e é fornecida no namespace `sn_agent`. Os endpoints nesta API exigem a função agent_client_collector_admin. Para obter mais informações, consulte [Agent Client Collector](https://www.servicenow.com/docs/access?context=acc-landing-page&version=xanadu&pubname=xanadu-it-operations-management&ft:locale=en-US). Endpoints de gestão de agentes : * Obtenha informações abrangentes de um ou mais agentes. Esses endpoints também podem ser acessados por usuários com a função agent_client_collector_user. * [GET /agents/{agent_id}](https://servicenow-prod.fluidtopics.net/0hS64SPtXLuUBX2LjwGOfg#agnt_clnt_cll-GET-agent_id "Obtém as informações de um agente especificado.") * [GET /agentes/lista](https://servicenow-prod.fluidtopics.net/0hS64SPtXLuUBX2LjwGOfg#agnt_clnt_cll-GET-list "Obtém uma lista de agentes com informações relacionadas.") {#agnt_clnt_cll-api__ul_tsy_mkq_dpb} * Envie uma solicitação para obter um log do agente e recuperar informações sobre o andamento da solicitação. * [GET /agents/{agent_id}/log](https://servicenow-prod.fluidtopics.net/0hS64SPtXLuUBX2LjwGOfg#agnt_clnt_cll-GET-log "Solicita o log de um agente especificado com status ativo/ativo.") * [GET /agents/log/{request_id}/](https://servicenow-prod.fluidtopics.net/0hS64SPtXLuUBX2LjwGOfg#agnt_clnt_cll-GET-log-request_id "Verifica o status de uma solicitação de log de captura.") {#agnt_clnt_cll-api__ul_rpm_4kq_dpb} * Desabilite ou habilite a coleta de dados do agente. * [GET /agents/{agent_id}/data/off](https://servicenow-prod.fluidtopics.net/0hS64SPtXLuUBX2LjwGOfg#agnt_clnt_cll-GET-data-off "Desabilita a coleta de dados para um agente especificado no estado ativo/ativo.") * [GET /agents/{agent_id}/data/on](https://servicenow-prod.fluidtopics.net/0hS64SPtXLuUBX2LjwGOfg#agnt_clnt_cll-GET-data-on "Habilita a coleta de dados para um agente especificado no estado ativo/ativo.") {#agnt_clnt_cll-api__ul_z43_gkq_dpb} * Reinicie um agente com [GET /agents/{agent_id}/restart](https://servicenow-prod.fluidtopics.net/0hS64SPtXLuUBX2LjwGOfg#agnt_clnt_cll-GET-restart "Reinicia um agente especificado com status ativo/ativo."). * Execute a descoberta em um agente com [GET /agents/{agent_id}/discovery](https://servicenow-prod.fluidtopics.net/0hS64SPtXLuUBX2LjwGOfg#agnt_clnt_cll-GET-discovery "Executa uma verificação de descoberta para localizar ICs relacionados a um agente. O agente especificado deve estar no status ativo/ativo."). {#agnt_clnt_cll-api__ul_mlz_ckq_dpb} Para obter informações sobre como executar tarefas semelhantes em uma inclusão de script, consulte [AccAgentsAPI](https://developer.servicenow.com/go_to_api.do?ID=AccAgentsAPIAPIScoped&v=utah). Gestão de políticas e fluxo de trabalho : Use as APIs de gestão de políticas para exibir detalhes, ativar/desativar uma política, atualizar uma política e publicar uma política. : Para atualizar uma política: 1. Obtenha uma lista de políticas e detalhes com [GET /agents/policies/list](https://servicenow-prod.fluidtopics.net/0hS64SPtXLuUBX2LjwGOfg#agnt_clnt_cll-GET-policies-list "Obtém uma lista de políticas que estão no estado de rascunho publicado ou não publicado."). Este endpoint requer a função agent_client_collector_user. * Para atualizar uma política no estado Rascunho, use os sys_ids recuperados da lista de políticas nos endpoints de atualização. * Para atualizar uma política no estado Publicado ou Publicado\*, obtenha uma cópia editável da área restrita com [GET /agents/policy/sandbox_from_published/{policy_id}](https://servicenow-prod.fluidtopics.net/0hS64SPtXLuUBX2LjwGOfg#agnt_clnt_cll-GET-policy-sbox-fr "Obtém a cópia da área restrita de uma política publicada e fornece detalhes da política."). Use os sys_ids desta resposta para modificar propriedades usando um endpoint de atualização. {#agnt_clnt_cll-api__ul_mtj_whk_fpb} 2. Modifique os detalhes da política usando um endpoint de atualização. * [POST /agents/update/policy/{policy_id}](https://servicenow-prod.fluidtopics.net/0hS64SPtXLuUBX2LjwGOfg#agnt_clnt_cll-POST-update-policy "Atualiza uma cópia da área restrita de uma política.") * [POST /agents/update/check/{check_id}](https://servicenow-prod.fluidtopics.net/0hS64SPtXLuUBX2LjwGOfg#agnt_clnt_cll-POST-update-check-id "Atualiza uma verificação de política selecionada.") * [POST /agents/update/check_param/{param_id}](https://servicenow-prod.fluidtopics.net/0hS64SPtXLuUBX2LjwGOfg#agnt_clnt_cll-POST-update-check_param "Atualiza um parâmetro de verificação de política selecionado.") * [POST /agents/update/check_secure_param/{param_id}](https://servicenow-prod.fluidtopics.net/0hS64SPtXLuUBX2LjwGOfg#agnt_clnt_cll-POST-update-check_secure "Atualiza um parâmetro seguro de verificação de política selecionado.") {#agnt_clnt_cll-api__ul_mp4_xjk_fpb} 3. Publique a política usando [GET /agents/policy/publish/{policy_id}](https://servicenow-prod.fluidtopics.net/0hS64SPtXLuUBX2LjwGOfg#agnt_clnt_cll-GET-policy-publish "Publica uma política de rascunho."). {#agnt_clnt_cll-api__ol_rmk_chk_fpb} : Depois de publicada, a política se torna Ativa. Esta API também inclui endpoints para ativar ou desativar uma política publicada: * [GET /agents/policy/activate/{policy_id}](https://servicenow-prod.fluidtopics.net/0hS64SPtXLuUBX2LjwGOfg#agnt_clnt_cll-GET-policy-act "Ativa uma política publicada.") * [GET /agents/policy/deactivate/{policy_id}](https://servicenow-prod.fluidtopics.net/0hS64SPtXLuUBX2LjwGOfg#agnt_clnt_cll-GET-policy-deact "Desativa uma política publicada.") {#agnt_clnt_cll-api__ul_glm_flk_fpb} ## Agent Client Collector - GET /agents/{agent_id} {#ariaid-title2} Obtém as informações de um agente especificado. ### Formato da URL /api/sn_agent/agents/{agent_id} ### Parâmetros de solicitação compatíveis {#agnt_clnt_cll-GET-agent_id__entry__2} | Nome | Descrição | |-|-| | agent_id | ID exclusivo de um agente listado na coluna ID do agente da tabela Agent Client Collectors \[sn_agent_cmdb_ci_agent\]. Para obter uma lista de IDs de agente e outros detalhes, execute o endpoint GET /agents/list. Tipo de dados: cadeia de caracteres | [Tabela 1. Parâmetros de caminho] {#agnt_clnt_cll-GET-agent_id__entry__6} | Nome | Descrição | |-|-| | Nenhum(a) | | [Tabela 2. Parâmetros de consulta] {#agnt_clnt_cll-GET-agent_id__entry__10} | Nome | Descrição | |-|-| | Nenhum(a) | | [Tabela 3. Parâmetros do corpo da solicitação (JSON)] ### Cabeçalhos Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte [Cabeçalhos de REST API compatíveis](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles."). {#agnt_clnt_cll-GET-agent_id__entry__14}{#agnt_clnt_cll-GET-agent_id__accept-JSON-only-entry-RESTAPI} | Cabeçalho | Descrição | |-|-| | Aceitar | Formato de dados do corpo da resposta. Oferece suporte somente a application/json. | [Tabela 4. Cabeçalhos da solicitação] {#agnt_clnt_cll-GET-agent_id__entry__18} | Cabeçalho | Descrição | |-|-| | Nenhum(a) | | [Tabela 5. Cabeçalhos de resposta] ### Códigos de status Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte [Códigos de resposta HTTP de REST API](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles."). {#agnt_clnt_cll-GET-agent_id__entry__22}{#agnt_clnt_cll-GET-agent_id__entry-200-status-code}{#agnt_clnt_cll-GET-agent_id__agntCC-desc-403-user} | Código de status | Descrição | |-|-| | 200 | Bem-sucedido. A solicitação foi processada com sucesso. | | 403 | O usuário não tem a função agent_client_collector_user. | | 404 | Agente com o ID fornecido não encontrado. | [Tabela 6. Códigos de status] ### Parâmetros do corpo da resposta (JSON) {#agnt_clnt_cll-GET-agent_id__entry__30}{#agnt_clnt_cll-GET-agent_id__accAgents-parm-agent-obj-id-entry}{#agnt_clnt_cll-GET-agent_id__accAgents-parm-agent-obj-dataCollect-entry}{#agnt_clnt_cll-GET-agent_id__accAgents-parm-agent-obj-ip-entry}{#agnt_clnt_cll-GET-agent_id__accAgents-parm-agent-obj-dup-entry}{#agnt_clnt_cll-GET-agent_id__accAgents-parm-agent-obj-restart-entry}{#agnt_clnt_cll-GET-agent_id__accAgents-parm-agent-obj-name-entry}{#agnt_clnt_cll-GET-agent_id__accAgents-parm-agent-obj-numChecks-entry}{#agnt_clnt_cll-GET-agent_id__accAgents-parm-agent-obj-status-entry}{#agnt_clnt_cll-GET-agent_id__accAgents-parm-agent-obj-up-entry}{#agnt_clnt_cll-GET-agent_id__accAgents-parm-agent-obj-version-entry} | Nome | Descrição | |-|-| | \ | Matriz de objetos JSON que contém informações do agente estendido. { "agent_id": "String", "data_collection": Number, "ip_address": "String", "is_duplicate": Boolean, "is_restart_enabled": Boolean, "name": "String", "number_of_running_checks": Number, "status": Number, "up_since": "String", "version": "String" } | | agent_id | ID do agente conforme enviado. Tipo de dados: cadeia de caracteres | | coleta_dados | A coleta de dados indica se as verificações programadas devem ser executadas. Essas verificações fazem parte das políticas programadas para a execução deste agente. Valores possíveis: * 0: Ativado -- Verificações executadas conforme programado. * 1: Desativado (manual) -- As verificações foram desativadas manualmente. * 2: Desativado (automático) -- As verificações foram desativadas automaticamente devido ao alto consumo de CPU pelo {#agnt_clnt_cll-GET-agent_id__ul_w4n_53p_bpb} Tipo de dados: número | | ip_address | Endereço IP do agente. Tipo de dados: cadeia de caracteres | | está_duplicado | Sinalizador que indica se este agente é uma duplicata de outro. Deve haver apenas um único agente em um determinado host. Valores possíveis: * verdadeiro: o agente tem o mesmo host que um agente Ativo/Ativo com um ID de agente diferente. Desativar ou desinstalar a duplicata * falso: este agente não tem duplicatas no estado Ativo/Ativo. {#agnt_clnt_cll-GET-agent_id__ul_b34_ffl_bpb} Tipo de dados: booliano | | is_restart_enabled | Sinalizador que indica se a reinicialização está habilitada. A reinicialização do agente não é configurável. Depende do sistema operacional e da versão do sistema operacional em que o agente está sendo executado. Valores possíveis: * verdadeiro: a reinicialização está habilitada para este agente. * falso: a reinicialização está desabilitada para este agente. {#agnt_clnt_cll-GET-agent_id__ul_bvp_dfl_bpb} Tipo de dados: booliano | | nome | Nome do agente. Tipo de dados: cadeia de caracteres | | número_de_verificações_em_execução | O número de verificações que o agente está programado para executar. Essas verificações fazem parte das políticas programadas para a execução deste agente. Tipo de dados: número | | status | Status do agente. Valores possíveis: * 0: Ativo/Ativo -- O agente está ativo. * 1: Aviso -- O agente não recebeu uma mensagem de manutenção de atividade nos últimos minutos. * 2: Inativo -- O agente não recebe uma mensagem de manutenção de atividade há muito tempo. * 3: Reiniciando -- O agente está reiniciando. {#agnt_clnt_cll-GET-agent_id__ul_adg_ffp_bpb} Tipo de dados: número | | up_desde | Hora UTC desde que o status do agente se tornou ativo/ativo. O valor está no formato [GlideDateTime](https://servicenow-prod.fluidtopics.net/rM63LHg6OGy~hBdWP_QdHA#c_GlideDateTimeScoped "A classe GlideDateTime com escopo fornece métodos para executar operações em objetos GlideDateTime."). Tipo de dados: cadeia de caracteres | | versão | Versão de Agent Client Collector que o agente está executando. Tipo de dados: cadeia de caracteres | [ ] ### Solicitação de cURL O exemplo a seguir mostra como obter detalhes do agente. curl "https://instance.service-now.com/api/sn_agent/agents/" \ --request GET \ --header "Accept:application/json" \ --user 'username':'password' Saída: { "name": "WIN-V26KAP7PI2G", "status": 2, "agent_id": "074b14e2eb3ce9d4", "ip_address": "10.196.55.14", "number_of_running_checks": 11, "data_collection": 0, "is_restart_enabled": true, "is_duplicate": false, "up_since": "2021-03-31 12:02:17", "version": "2.3.0" } ## Agent Client Collector - GET /agents/{agent_id}/data/off {#ariaid-title3} Desabilita a coleta de dados para um agente especificado no estado ativo/ativo. Para determinar se a coleta de dados de um agente está ativada ou desativada, execute o endpoint GET /agents/{agent_id}. ### Formato da URL {#agnt_clnt_cll-GET-data-off__section_bbq_zyc_z4b} /api/sn_agent/agents/{agent_id}/data/off ### Parâmetros de solicitação compatíveis {#agnt_clnt_cll-GET-data-off__section_cbq_zyc_z4b} {#agnt_clnt_cll-GET-data-off__table_oyt_cd3_dpb__entry__2} | Nome | Descrição | |-|-| | agent_id | ID exclusivo de um agente listado na coluna ID do agente da tabela Agent Client Collectors \[sn_agent_cmdb_ci_agent\]. Para obter uma lista de IDs de agente e outros detalhes, execute o endpoint GET /agents/list. Tipo de dados: cadeia de caracteres | [Tabela 7. Parâmetros de caminho] {#agnt_clnt_cll-GET-data-off__table_oyt_cd3_dpb} {#agnt_clnt_cll-GET-data-off__table_ebq_zyc_z4b__entry__2} | Nome | Descrição | |-|-| | Nenhum(a) | | [Tabela 8. Parâmetros de consulta] {#agnt_clnt_cll-GET-data-off__table_ebq_zyc_z4b} {#agnt_clnt_cll-GET-data-off__table_fbq_zyc_z4b__entry__2} | Nome | Descrição | |-|-| | Nenhum(a) | | [Tabela 9. Parâmetros do corpo da solicitação (JSON)] {#agnt_clnt_cll-GET-data-off__table_fbq_zyc_z4b} ### Cabeçalhos {#agnt_clnt_cll-GET-data-off__section_gbq_zyc_z4b} Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte [Cabeçalhos de REST API compatíveis](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles."). {#agnt_clnt_cll-GET-data-off__table_hbq_zyc_z4b__entry__2}{#agnt_clnt_cll-GET-data-off__accept-JSON-only-entry-RESTAPI} | Cabeçalho | Descrição | |-|-| | Aceitar | Formato de dados do corpo da resposta. Oferece suporte somente a application/json. | [Tabela 10. Cabeçalhos da solicitação] {#agnt_clnt_cll-GET-data-off__table_hbq_zyc_z4b} {#agnt_clnt_cll-GET-data-off__table_ibq_zyc_z4b__entry__2} | Cabeçalho | Descrição | |-|-| | Nenhum(a) | | [Tabela 11. Cabeçalhos de resposta] {#agnt_clnt_cll-GET-data-off__table_ibq_zyc_z4b} ### Códigos de status {#agnt_clnt_cll-GET-data-off__section_jbq_zyc_z4b} Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte [Códigos de resposta HTTP de REST API](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles."). {#agnt_clnt_cll-GET-data-off__table_epg_2f3_dpb__entry__2}{#agnt_clnt_cll-GET-data-off__entry-200-status-code}{#agnt_clnt_cll-GET-data-off__agntCC-desc-403-admin} | Código de status | Descrição | |-|-| | 200 | Bem-sucedido. A solicitação foi processada com sucesso. | | 403 | O usuário não tem a função agent_client_collector_admin. | | 404 | Agente não encontrado ou não está no estado ativo/ativo. | [Tabela 12. Códigos de status] {#agnt_clnt_cll-GET-data-off__table_epg_2f3_dpb} ### Parâmetros do corpo da resposta (JSON) {#agnt_clnt_cll-GET-data-off__section_nwl_zyc_z4b} {#agnt_clnt_cll-GET-data-off__table_owl_zyc_z4b__entry__2} | Nome | Descrição | |-|-| | mensagem | Mensagem que contém resultados de sucesso ou falha da operação. Tipo de dados: cadeia de caracteres | [ ] {#agnt_clnt_cll-GET-data-off__table_owl_zyc_z4b} ### Solicitação de cURL {#agnt_clnt_cll-GET-data-off__example_nbq_zyc_z4b} O exemplo a seguir mostra como desativar a coleta de dados do agente. curl "https://instance.service-now.com/api/sn_agent/agents//data/off" \ --request GET \ --header "Accept:application/json" \ --user 'username':'password' Saída: { "message": "Data Collection Disabled For Agent With ID: " } ## Agent Client Collector - GET /agents/{agent_id}/data/on {#ariaid-title4} Habilita a coleta de dados para um agente especificado no estado ativo/ativo. Para determinar se a coleta de dados de um agente está ativada ou desativada, execute o endpoint GET /agents/{agent_id}. ### Formato da URL {#agnt_clnt_cll-GET-data-on__section_dwl_zyc_z4b} /api/sn_agent/agents/{agent_id}/data/on ### Parâmetros de solicitação compatíveis {#agnt_clnt_cll-GET-data-on__section_ewl_zyc_z4b} {#agnt_clnt_cll-GET-data-on__table_oyt_cd3_dpb__entry__2} | Nome | Descrição | |-|-| | agent_id | ID exclusivo de um agente listado na coluna ID do agente da tabela Agent Client Collectors \[sn_agent_cmdb_ci_agent\]. Para obter uma lista de IDs de agente e outros detalhes, execute o endpoint GET /agents/list. Tipo de dados: cadeia de caracteres | [Tabela 13. Parâmetros de caminho] {#agnt_clnt_cll-GET-data-on__table_oyt_cd3_dpb} {#agnt_clnt_cll-GET-data-on__table_gwl_zyc_z4b__entry__2} | Nome | Descrição | |-|-| | Nenhum(a) | | [Tabela 14. Parâmetros de consulta] {#agnt_clnt_cll-GET-data-on__table_gwl_zyc_z4b} {#agnt_clnt_cll-GET-data-on__table_hwl_zyc_z4b__entry__2} | Nome | Descrição | |-|-| | Nenhum(a) | | [Tabela 15. Parâmetros do corpo da solicitação (JSON)] {#agnt_clnt_cll-GET-data-on__table_hwl_zyc_z4b} ### Cabeçalhos {#agnt_clnt_cll-GET-data-on__section_iwl_zyc_z4b} Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte [Cabeçalhos de REST API compatíveis](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles."). {#agnt_clnt_cll-GET-data-on__table_jwl_zyc_z4b__entry__2}{#agnt_clnt_cll-GET-data-on__accept-JSON-only-entry-RESTAPI} | Cabeçalho | Descrição | |-|-| | Aceitar | Formato de dados do corpo da resposta. Oferece suporte somente a application/json. | [Tabela 16. Cabeçalhos da solicitação] {#agnt_clnt_cll-GET-data-on__table_jwl_zyc_z4b} {#agnt_clnt_cll-GET-data-on__table_kwl_zyc_z4b__entry__2} | Cabeçalho | Descrição | |-|-| | Nenhum(a) | | [Tabela 17. Cabeçalhos de resposta] {#agnt_clnt_cll-GET-data-on__table_kwl_zyc_z4b} ### Códigos de status {#agnt_clnt_cll-GET-data-on__section_lwl_zyc_z4b} Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte [Códigos de resposta HTTP de REST API](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles."). {#agnt_clnt_cll-GET-data-on__table_y2n_2f3_dpb__entry__2}{#agnt_clnt_cll-GET-data-on__entry-200-status-code}{#agnt_clnt_cll-GET-data-on__agntCC-desc-403-admin} | Código de status | Descrição | |-|-| | 200 | Bem-sucedido. A solicitação foi processada com sucesso. | | 403 | O usuário não tem a função agent_client_collector_admin. | | 404 | Agente não encontrado ou não está no estado ativo/ativo. | [Tabela 18. Códigos de status] {#agnt_clnt_cll-GET-data-on__table_y2n_2f3_dpb} ### Parâmetros do corpo da resposta (JSON) {#agnt_clnt_cll-GET-data-on__section_nwl_zyc_z4b} {#agnt_clnt_cll-GET-data-on__table_owl_zyc_z4b__entry__2} | Nome | Descrição | |-|-| | mensagem | Mensagem que contém resultados de sucesso ou falha da operação. Tipo de dados: cadeia de caracteres | [ ] {#agnt_clnt_cll-GET-data-on__table_owl_zyc_z4b} ### Solicitação de cURL {#agnt_clnt_cll-GET-data-on__example_pwl_zyc_z4b} O exemplo a seguir mostra como ativar a coleta de dados do agente. curl "https://instance.service-now.com/api/sn_agent/agents//data/on" \ --request GET \ --header "Accept:application/json" \ --user 'username':'password' Saída: { "message": "Data Collection Enabled For Agent With ID: " } ## Agent Client Collector - GET /agents/{agent_id}/discovery {#ariaid-title5} Executa uma verificação de descoberta para localizar ICs relacionados a um agente. O agente especificado deve estar no status ativo/ativo. ### Formato da URL /api/sn_agent/agents/{agent_id}/discovery ### Parâmetros de solicitação compatíveis {#agnt_clnt_cll-GET-discovery__section_ewl_zyc_z4b} {#agnt_clnt_cll-GET-discovery__table_oyt_cd3_dpb__entry__2} | Nome | Descrição | |-|-| | agent_id | ID exclusivo de um agente listado na coluna ID do agente da tabela Agent Client Collectors \[sn_agent_cmdb_ci_agent\]. Para obter uma lista de IDs de agente e outros detalhes, execute o endpoint GET /agents/list. Tipo de dados: cadeia de caracteres | [Tabela 19. Parâmetros de caminho] {#agnt_clnt_cll-GET-discovery__table_oyt_cd3_dpb} {#agnt_clnt_cll-GET-discovery__table_gwl_zyc_z4b__entry__2} | Nome | Descrição | |-|-| | Nenhum(a) | | [Tabela 20. Parâmetros de consulta] {#agnt_clnt_cll-GET-discovery__table_gwl_zyc_z4b} {#agnt_clnt_cll-GET-discovery__table_hwl_zyc_z4b__entry__2} | Nome | Descrição | |-|-| | Nenhum(a) | | [Tabela 21. Parâmetros do corpo da solicitação (JSON)] {#agnt_clnt_cll-GET-discovery__table_hwl_zyc_z4b} ### Cabeçalhos {#agnt_clnt_cll-GET-discovery__section_iwl_zyc_z4b} Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte [Cabeçalhos de REST API compatíveis](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles."). {#agnt_clnt_cll-GET-discovery__table_jwl_zyc_z4b__entry__2}{#agnt_clnt_cll-GET-discovery__accept-JSON-only-entry-RESTAPI} | Cabeçalho | Descrição | |-|-| | Aceitar | Formato de dados do corpo da resposta. Oferece suporte somente a application/json. | [Tabela 22. Cabeçalhos da solicitação] {#agnt_clnt_cll-GET-discovery__table_jwl_zyc_z4b} {#agnt_clnt_cll-GET-discovery__table_kwl_zyc_z4b__entry__2} | Cabeçalho | Descrição | |-|-| | Nenhum(a) | | [Tabela 23. Cabeçalhos de resposta] {#agnt_clnt_cll-GET-discovery__table_kwl_zyc_z4b} ### Códigos de status {#agnt_clnt_cll-GET-discovery__section_lwl_zyc_z4b} Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte [Códigos de resposta HTTP de REST API](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles."). {#agnt_clnt_cll-GET-discovery__table_y2n_2f3_dpb__entry__2}{#agnt_clnt_cll-GET-discovery__entry-200-status-code}{#agnt_clnt_cll-GET-discovery__agntCC-desc-403-admin} | Código de status | Descrição | |-|-| | 200 | Bem-sucedido. A solicitação foi processada com sucesso. | | 403 | O usuário não tem a função agent_client_collector_admin. | | 404 | Agente não encontrado ou não está no estado ativo/ativo. | [Tabela 24. Códigos de status] {#agnt_clnt_cll-GET-discovery__table_y2n_2f3_dpb} ### Parâmetros do corpo da resposta (JSON) {#agnt_clnt_cll-GET-discovery__section_nwl_zyc_z4b} {#agnt_clnt_cll-GET-discovery__table_owl_zyc_z4b__entry__2} | Nome | Descrição | |-|-| | mensagem | Mensagem que contém resultados de sucesso ou falha da operação. Tipo de dados: cadeia de caracteres | [ ] {#agnt_clnt_cll-GET-discovery__table_owl_zyc_z4b} ### Solicitação de cURL O exemplo a seguir mostra como executar a descoberta em um agente com status ativo/ativo. curl "https://instance.service-now.com/api/sn_agent/agents//discovery" \ --request GET \ --header "Accept:application/json" \ --user 'username':'password' Saída: { "message": "Running Discovery For Agent With ID: " } ## Agent Client Collector - GET /agents/check_defs/{check_def_id} {#ariaid-title6} Obtém uma definição de verificação especificada com detalhes. ### Formato da URL /api/sn_agent/agents/check_defs/{check_def_id} ### Parâmetros de solicitação compatíveis {#agnt_clnt_cll-GET-check_defs-id__entry__2} | Nome | Descrição | |-|-| | check_def_id | Sys_id da definição de verificação listada na tabela Definições de verificação \[sn_agent_check_def\]. Tipo de dados: cadeia de caracteres | [Tabela 25. Parâmetros de caminho] {#agnt_clnt_cll-GET-check_defs-id__entry__6} | Nome | Descrição | |-|-| | Nenhum(a) | | [Tabela 26. Parâmetros de consulta] {#agnt_clnt_cll-GET-check_defs-id__entry__10} | Nome | Descrição | |-|-| | X-Include-Verificar-Parâmetros | Sinalizador que indica se os detalhes do parâmetro de verificação existente são retornados. As informações de cada parâmetro de verificação padrão e seguro são incluídas em um objeto JSON. Valores válidos: * verdadeiro: retorna detalhes do parâmetro de verificação. * falso: não retorna detalhes do parâmetro de verificação. {#agnt_clnt_cll-GET-check_defs-id__ul_pv3_gqc_wqb} Tipo de dados: booliano Padrão: falso | [Tabela 27. Parâmetros do corpo da solicitação (JSON)] ### Cabeçalhos Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte [Cabeçalhos de REST API compatíveis](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles."). {#agnt_clnt_cll-GET-check_defs-id__entry__14}{#agnt_clnt_cll-GET-check_defs-id__accept-JSON-only-entry-RESTAPI} | Cabeçalho | Descrição | |-|-| | Aceitar | Formato de dados do corpo da resposta. Oferece suporte somente a application/json. | [Tabela 28. Cabeçalhos da solicitação] {#agnt_clnt_cll-GET-check_defs-id__entry__18} | Cabeçalho | Descrição | |-|-| | Nenhum(a) | | [Tabela 29. Cabeçalhos de resposta] ### Códigos de status Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte [Códigos de resposta HTTP de REST API](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles."). {#agnt_clnt_cll-GET-check_defs-id__entry__22}{#agnt_clnt_cll-GET-check_defs-id__entry-200-status-code} | Código de status | Descrição | |-|-| | 200 | Bem-sucedido. A solicitação foi processada com sucesso. | | 404 | A definição de verificação não foi encontrada com o sys_id fornecido. | [Tabela 30. Códigos de status] ### Parâmetros do corpo da resposta (JSON) {#agnt_clnt_cll-GET-check_defs-id__entry__28}{#agnt_clnt_cll-GET-check_defs-id__accCkDf-background-desc-ph}{#agnt_clnt_cll-GET-check_defs-id__accCkDf-chkGrp-desc-ph}{#agnt_clnt_cll-GET-check_defs-id__accCkDf-chkTyp-desc-ph}{#agnt_clnt_cll-GET-check_defs-id__accCkDf-command-desc-ph}{#agnt_clnt_cll-GET-check_defs-id__accCkDf-name-desc-ph}{#agnt_clnt_cll-GET-check_defs-id__accCkDf-p-desc-ph}{#agnt_clnt_cll-GET-check_defs-id__accCkDf-p-active-desc-ph}{#agnt_clnt_cll-GET-check_defs-id__accCkDf-p-default-desc-ph}{#agnt_clnt_cll-GET-check_defs-id__accCkDf-p-mando-desc-ph}{#agnt_clnt_cll-GET-check_defs-id__accCkDf-p-name-desc-ph}{#agnt_clnt_cll-GET-check_defs-id__accCkDf-p-id-desc-ph}{#agnt_clnt_cll-GET-check_defs-id__accCkDf-plugins-desc-ph}{#agnt_clnt_cll-GET-check_defs-id__accCkDf-proxy-desc-ph}{#agnt_clnt_cll-GET-check_defs-id__accCkDf-sp-desc-ph}{#agnt_clnt_cll-GET-check_defs-id__accCkDf-sp-active-desc-ph}{#agnt_clnt_cll-GET-check_defs-id__accCkDf-sp-name-desc-ph}{#agnt_clnt_cll-GET-check_defs-id__accCkDf-sp-order-desc-ph}{#agnt_clnt_cll-GET-check_defs-id__accCkDf-sp-id-desc-ph}{#agnt_clnt_cll-GET-check_defs-id__accCkDf-id-desc-ph}{#agnt_clnt_cll-GET-check_defs-id__accCkDf-timeout-desc-ph} | Propriedades | Descrição | |-|-| | verificação | Detalhes da definição de verificação especificada. { "background": Boolean, "check_group": "String", "check_type": "String", "command": "String", "error": "String", "name": "String", "params": [Array], "plugins": [Array], "proxy_valid": Boolean, "secure_params": [Array], "sys_id": "String", "timeout": Number } | | Plano de fundo | Sinalizador que indica se esta definição de verificação é uma verificação em segundo plano. Uma verificação em segundo plano é uma verificação em que o agente inicia a execução e não espera que ele termine. Valores válidos: * verdadeiro: esta definição de verificação é uma verificação em segundo plano. * falso: esta definição de verificação não é uma verificação em segundo plano. {#agnt_clnt_cll-GET-check_defs-id__ul_ypb_5ps_5qb} Tipo de dados: booliano | | verificar_grupo | Grupo especificado para esta definição de verificação. Tipo de dados: cadeia de caracteres | | check_type | Tipo de verificação. Valores possíveis: * Eventos - os resultados da verificação são transformados em um evento de gestão de eventos. * Métricas -- os valores do resultado da verificação são transformados em métricas. {#agnt_clnt_cll-GET-check_defs-id__ul_gtr_kfb_wqb} Tipo de dados: cadeia de caracteres | | comando | Comando que o Agent Client Collector executa. Tipo de dados: cadeia de caracteres | | erro | Mensagem se houver um erro. Caso contrário, nulo. Tipo de dados: cadeia de caracteres | | nome | Nome da verificação. Tipo de dados: cadeia de caracteres | | parâms | Lista de definições de parâmetro associadas à definição de verificação. Esses resultados só serão incluídos se o parâmetro withParams estiver definido como verdadeiro. "params": [ { "active": Boolean, "default_value": "String", "mandatory": Boolean, "name": "String", "sys_id": "String" } ] {#agnt_clnt_cll-GET-check_defs-id__accCkDf-p-code} Tipo de dados: matriz | | parâmetros.ativo | Sinalizador que indica se o parâmetro de verificação está ativo. Valores válidos: * verdadeiro: o parâmetro de verificação está ativo. * falso: o parâmetro de verificação está inativo. {#agnt_clnt_cll-GET-check_defs-id__ul_pnb_jyc_wqb} Tipo de dados: booliano | | parâmetros.valor_padrão | Especifica o valor padrão para este parâmetro de verificação. Tipo de dados: cadeia de caracteres | | parâmetros.obrigatório | Sinalizador que indica se o parâmetro de verificação é necessário. Valores válidos: * verdadeiro: o parâmetro de verificação é necessário. * falso: o parâmetro de verificação é opcional. {#agnt_clnt_cll-GET-check_defs-id__ul_wtg_2zc_wqb} Tipo de dados: booliano | | params.name | Nome do parâmetro de verificação. Tipo de dados: cadeia de caracteres | | params.sys_id | Sys_id do parâmetro de verificação listado na tabela Definições de parâmetro seguro de verificação \[sn_agent_check_param_def\]. Tipo de dados: cadeia de caracteres | | plug-ins | Lista de plug- [Agent Client Collector ins](https://www.servicenow.com/docs/access?context=acc-assets&version=xanadu&pubname=xanadu-it-operations-management&ft:locale=en-US) associados a esta verificação. Tipo de dados: matriz | | proxy_valid | Sinalizador que indica se a política de definição de verificação está definida para funcionar como um proxy. Valores válidos: * verdadeiro: esta política de definição de verificação está definida para funcionar como um proxy. * falso: esta política de definição de verificação não está definida para funcionar como um proxy. {#agnt_clnt_cll-GET-check_defs-id__ul_wbf_qps_5qb} Tipo de dados: booliano | | parâmetros_seguros | Lista de atribuídos a esta verificação. Esses resultados só serão incluídos se o parâmetro withParams estiver definido como verdadeiro. "secure_params": [ { "active": Boolean, "name": "String", "order": Number, "sys_id": "String" } ] {#agnt_clnt_cll-GET-check_defs-id__accCkDf-sp-code} Tipo de dados: matriz | | parâmetros_seguros.ativo | Sinalizador que indica se o parâmetro seguro está ativo. Valores válidos: * verdadeiro: o parâmetro de segurança está ativo. * falso: o parâmetro de segurança está inativo. {#agnt_clnt_cll-GET-check_defs-id__ul_g1b_3vc_wqb} Tipo de dados: booliano | | params_seguros.nome | Nome do parâmetro seguro. Tipo de dados: cadeia de caracteres | | parâmetros_seguros.ordem | Ordem na qual o parâmetro é enviado para o comando/script de verificação. Tipo de dados: número | | parâmetros_seguros.sys_id | Sys_id do parâmetro seguro listado na tabela Verificar definições de parâmetro seguro \[sn_agent_check_secure_param_def\]. Tipo de dados: cadeia de caracteres | | sys_id | Sys_id da definição de verificação listada na tabela Definições de verificação \[sn_agent_check_def\]. Tipo de dados: cadeia de caracteres | | tempo limite | Tempo limite em segundos. Tipo de dados: número | [ ] ### Solicitação de cURL O exemplo a seguir mostra como obter informações para uma definição de verificação especificada. curl "https://instance.service-now.com/api/sn_agent/agents/check_defs/94436b237f705300f128134f8dfa91a4" \ --request GET \ --header "Accept:application/json" \ --user 'username':'password' Saída: { "name": "app.apache.metrics-apache", "command": "metrics-apache-graphite.rb -p {{.labels.params_port}} --path {{.labels.params_path}} -h {{.labels.params_host}}", "plugins": [ "monitoring-plugin-common" ], "timeout": 60, "proxy_valid": true, "background": false, "check_type": "Metrics", "check_group": "Apache", "sys_id": "94436b237f705300f128134f8dfa91a4", "params": [ { "name": "port", "active": true, "mandatory": true, "default_value": "80", "sys_id": "58436b237f705300f128134f8dfa91a8" }, { "name": "path", "active": true, "mandatory": true, "default_value": "/server-status?auto", "sys_id": "98436b237f705300f128134f8dfa91aa" }, { "name": "scheme", "active": false, "mandatory": false, "default_value": null, "sys_id": "a4e57a96db3bbb4035305c55dc9619f6" }, { "name": "host", "active": true, "mandatory": true, "default_value": "127.0.0.1", "sys_id": "d4436b237f705300f128134f8dfa91a6" }, { "name": "ssl_secure_connection", "active": false, "mandatory": false, "default_value": null, "sys_id": "e3b272c4530100106ffeddeeff7b1275" } ], "secure_params": [ { "name": "cred_user_name", "active": true, "order": 1, "sys_id": "2494cd6e53170010f42cddeeff7b1273" }, { "name": "cred_password", "active": true, "order": 2, "sys_id": "35948d6e53170010f42cddeeff7b127f" } ] } ## Agent Client Collector - GET /agents/check_defs/list {#ariaid-title7} Obtém uma lista de definições de verificação com detalhes. ### Formato da URL /api/sn_agent/agents/check_defs/list ### Parâmetros de solicitação compatíveis {#agnt_clnt_cll-GET-check_defs-list__entry__2} | Nome | Descrição | |-|-| | Nenhum(a) | | [Tabela 31. Parâmetros de caminho] {#agnt_clnt_cll-GET-check_defs-list__entry__6} | Nome | Descrição | |-|-| | Nenhum(a) | | [Tabela 32. Parâmetros de consulta] {#agnt_clnt_cll-GET-check_defs-list__entry__10} | Nome | Descrição | |-|-| | X-Enc-Query | Uma [cadeia de caracteres de consulta codificada](https://www.servicenow.com/docs/access?context=c_EncodedQueryStrings&version=xanadu&pubname=xanadu-platform-user-interface&ft:locale=en-US) para filtrar a lista de resultados da definição de verificação. Use nulo para uma lista não filtrada de definições de verificação no sistema. Tipo de dados: cadeia de caracteres | | X-Include-Verificar-Parâmetros | Sinalizador que indica se os detalhes do parâmetro de verificação existente são retornados. As informações de cada parâmetro de verificação padrão e seguro são incluídas em um objeto JSON. Valores válidos: * verdadeiro: retorna detalhes do parâmetro de verificação. * falso: não retorna detalhes do parâmetro de verificação. {#agnt_clnt_cll-GET-check_defs-list__ul_pv3_gqc_wqb} Tipo de dados: booliano Padrão: falso | | Limite X | Limita o número de registros retornados. Defina como nulo para usar o valor padrão. Tipo de dados: número Padrão: 20.000 | [Tabela 33. Parâmetros do corpo da solicitação (JSON)] ### Cabeçalhos Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte [Cabeçalhos de REST API compatíveis](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles."). {#agnt_clnt_cll-GET-check_defs-list__entry__18}{#agnt_clnt_cll-GET-check_defs-list__accept-JSON-only-entry-RESTAPI} | Cabeçalho | Descrição | |-|-| | Aceitar | Formato de dados do corpo da resposta. Oferece suporte somente a application/json. | [Tabela 34. Cabeçalhos da solicitação] {#agnt_clnt_cll-GET-check_defs-list__table_ufx_wwq_wqb__entry__2} | Cabeçalho | Descrição | |-|-| | Nenhum(a) | | [Tabela 35. Cabeçalhos de resposta] {#agnt_clnt_cll-GET-check_defs-list__table_ufx_wwq_wqb} ### Códigos de status Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte [Códigos de resposta HTTP de REST API](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles."). {#agnt_clnt_cll-GET-check_defs-list__entry__26}{#agnt_clnt_cll-GET-check_defs-list__entry-200-status-code} | Código de status | Descrição | |-|-| | 200 | Bem-sucedido. A solicitação foi processada com sucesso. | [Tabela 36. Códigos de status] ### Parâmetros do corpo da resposta (JSON) {#agnt_clnt_cll-GET-check_defs-list__entry__30}{#agnt_clnt_cll-GET-check_defs-list__accCkDf-background-desc-ph}{#agnt_clnt_cll-GET-check_defs-list__accCkDf-chkGrp-desc-ph}{#agnt_clnt_cll-GET-check_defs-list__accCkDf-chkTyp-desc-ph}{#agnt_clnt_cll-GET-check_defs-list__accCkDf-command-desc-ph}{#agnt_clnt_cll-GET-check_defs-list__accCkDf-name-desc-ph}{#agnt_clnt_cll-GET-check_defs-list__accCkDf-p-desc-ph}{#agnt_clnt_cll-GET-check_defs-list__accCkDf-p-active-desc-ph}{#agnt_clnt_cll-GET-check_defs-list__accCkDf-p-default-desc-ph}{#agnt_clnt_cll-GET-check_defs-list__accCkDf-p-mando-desc-ph}{#agnt_clnt_cll-GET-check_defs-list__accCkDf-p-name-desc-ph}{#agnt_clnt_cll-GET-check_defs-list__accCkDf-p-id-desc-ph}{#agnt_clnt_cll-GET-check_defs-list__accCkDf-plugins-desc-ph}{#agnt_clnt_cll-GET-check_defs-list__accCkDf-proxy-desc-ph}{#agnt_clnt_cll-GET-check_defs-list__accCkDf-sp-desc-ph}{#agnt_clnt_cll-GET-check_defs-list__accCkDf-sp-active-desc-ph}{#agnt_clnt_cll-GET-check_defs-list__accCkDf-sp-name-desc-ph}{#agnt_clnt_cll-GET-check_defs-list__accCkDf-sp-order-desc-ph}{#agnt_clnt_cll-GET-check_defs-list__accCkDf-sp-id-desc-ph}{#agnt_clnt_cll-GET-check_defs-list__accCkDf-id-desc-ph}{#agnt_clnt_cll-GET-check_defs-list__accCkDf-timeout-desc-ph} | Nome | Descrição | |-|-| | verificar definições | Lista de definição de verificação e detalhes fornecidos como objetos JSON. [ { "background": Boolean, "check_group": "String", "check_type": "String", "command": "String", "name": "String", "params": [Array], "plugins": [Array], "proxy_valid": Boolean, "secure_params": [Array], "sys_id": "String", "timeout": Number } ] Tipo de dados: matriz | | Plano de fundo | Sinalizador que indica se esta definição de verificação é uma verificação em segundo plano. Uma verificação em segundo plano é uma verificação em que o agente inicia a execução e não espera que ele termine. Valores válidos: * verdadeiro: esta definição de verificação é uma verificação em segundo plano. * falso: esta definição de verificação não é uma verificação em segundo plano. {#agnt_clnt_cll-GET-check_defs-list__ul_ypb_5ps_5qb} Tipo de dados: booliano | | verificar_grupo | Grupo especificado para esta definição de verificação. Tipo de dados: cadeia de caracteres | | check_type | Tipo de verificação. Valores possíveis: * Eventos - os resultados da verificação são transformados em um evento de gestão de eventos. * Métricas -- os valores do resultado da verificação são transformados em métricas. {#agnt_clnt_cll-GET-check_defs-list__ul_gtr_kfb_wqb} Tipo de dados: cadeia de caracteres | | comando | Comando que o Agent Client Collector executa. Tipo de dados: cadeia de caracteres | | nome | Nome da verificação. Tipo de dados: cadeia de caracteres | | parâms | Lista de definições de parâmetro associadas à definição de verificação. Esses resultados só serão incluídos se o parâmetro withParams estiver definido como verdadeiro. "params": [ { "active": Boolean, "default_value": "String", "mandatory": Boolean, "name": "String", "sys_id": "String" } ] {#agnt_clnt_cll-GET-check_defs-list__accCkDf-p-code} Tipo de dados: matriz | | parâmetros.ativo | Sinalizador que indica se o parâmetro de verificação está ativo. Valores válidos: * verdadeiro: o parâmetro de verificação está ativo. * falso: o parâmetro de verificação está inativo. {#agnt_clnt_cll-GET-check_defs-list__ul_pnb_jyc_wqb} Tipo de dados: booliano | | parâmetros.valor_padrão | Especifica o valor padrão para este parâmetro de verificação. Tipo de dados: cadeia de caracteres | | parâmetros.obrigatórios | Sinalizador que indica se o parâmetro de verificação é necessário. Valores válidos: * verdadeiro: o parâmetro de verificação é necessário. * falso: o parâmetro de verificação é opcional. {#agnt_clnt_cll-GET-check_defs-list__ul_wtg_2zc_wqb} Tipo de dados: booliano | | params.name | Nome do parâmetro de verificação. Tipo de dados: cadeia de caracteres | | params.sys_id | Sys_id do parâmetro de verificação listado na tabela Definições de parâmetro seguro de verificação \[sn_agent_check_param_def\]. Tipo de dados: cadeia de caracteres | | plug-ins | Lista de plug- [Agent Client Collector ins](https://www.servicenow.com/docs/access?context=acc-assets&version=xanadu&pubname=xanadu-it-operations-management&ft:locale=en-US) associados a esta verificação. Tipo de dados: matriz | | proxy_valid | Sinalizador que indica se a política de definição de verificação está definida para funcionar como um proxy. Valores válidos: * verdadeiro: esta política de definição de verificação está definida para funcionar como um proxy. * falso: esta política de definição de verificação não está definida para funcionar como um proxy. {#agnt_clnt_cll-GET-check_defs-list__ul_wbf_qps_5qb} Tipo de dados: booliano | | parâmetros_seguros | Lista de atribuídos a esta verificação. Esses resultados só serão incluídos se o parâmetro withParams estiver definido como verdadeiro. "secure_params": [ { "active": Boolean, "name": "String", "order": Number, "sys_id": "String" } ] {#agnt_clnt_cll-GET-check_defs-list__accCkDf-sp-code} Tipo de dados: matriz | | parâmetros_seguros.ativo | Sinalizador que indica se o parâmetro seguro está ativo. Valores válidos: * verdadeiro: o parâmetro de segurança está ativo. * falso: o parâmetro de segurança está inativo. {#agnt_clnt_cll-GET-check_defs-list__ul_g1b_3vc_wqb} Tipo de dados: booliano | | params_seguros.nome | Nome do parâmetro seguro. Tipo de dados: cadeia de caracteres | | parâmetros_seguros.ordem | Ordem na qual o parâmetro é enviado para o comando/script de verificação. Tipo de dados: número | | parâmetros_seguros.sys_id | Sys_id do parâmetro seguro listado na tabela Verificar definições de parâmetro seguro \[sn_agent_check_secure_param_def\]. Tipo de dados: cadeia de caracteres | | sys_id | Sys_id da definição de verificação listada na tabela Definições de verificação \[sn_agent_check_def\]. Tipo de dados: cadeia de caracteres | | tempo limite | Tempo limite em segundos. Tipo de dados: número | [ ] ### Solicitação de cURL O exemplo a seguir mostra como recuperar uma lista de duas definições de verificação com valores de parâmetro. curl "https://instance.service-now.com/api/sn_agent/agents/check_defs/list" \ --request GET \ --header "Accept:application/json" \ --user 'username':'password' Saída: { "check_definitions": [ { "name": "checks_api_test", "command": "echo hello", "plugins": [], "timeout": 9, "proxy_valid": true, "background": false, "check_type": "TestCheck", "check_group": "computer", "sys_id": "7f1f9026dba530106f4810284b96194f", "params": [], "secure_params": [ { "name": "check_api_test_check_secure_param2", "active": true, "order": 2, "sys_id": "2d30a066dba530106f4810284b9619c1" }, { "name": "check_api_test_check_secure_param1", "active": true, "order": 100, "sys_id": "4c20a066dba530106f4810284b9619a8" } ] }, { "name": "checks_api_test222", "command": "echo hello1212121", "plugins": [], "timeout": 60, "proxy_valid": true, "background": false, "check_type": "TestCheck", "check_group": "computer", "sys_id": "99e12466dba530106f4810284b961976", "params": [ { "name": "check_api_test_check_param_222", "active": true, "mandatory": false, "default_value": "test_test_test", "sys_id": "44026466dba530106f4810284b9619b2" } ], "secure_params": [] } ] } ## Agent Client Collector - GET /agents/exec/background/stop/{request_id} {#ariaid-title8} Interrompe uma verificação em segundo plano. Para iniciar uma verificação em segundo plano, use a API POST /agents/check_defs/{check_def_id}/run. ### Formato da URL /api/sn_agent/agents/exec/background/stop/{request_id} ### Parâmetros de solicitação compatíveis {#agnt_clnt_cll-GET-exec-bkgrd-stop__entry__2} | Nome | Descrição | |-|-| | request_id | O ID de uma solicitação de verificação em segundo plano gerada pela execução da API POST /agents/check_defs/{check_def_id}/run. | [Tabela 37. Parâmetros de caminho] {#agnt_clnt_cll-GET-exec-bkgrd-stop__entry__6} | Nome | Descrição | |-|-| | Nenhum(a) | | [Tabela 38. Parâmetros de consulta] {#agnt_clnt_cll-GET-exec-bkgrd-stop__entry__10} | Nome | Descrição | |-|-| | Nenhum(a) | | [Tabela 39. Parâmetros do corpo da solicitação (JSON)] ### Cabeçalhos Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte [Cabeçalhos de REST API compatíveis](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles."). {#agnt_clnt_cll-GET-exec-bkgrd-stop__entry__14}{#agnt_clnt_cll-GET-exec-bkgrd-stop__accept-JSON-only-entry-RESTAPI} | Cabeçalho | Descrição | |-|-| | Aceitar | Formato de dados do corpo da resposta. Oferece suporte somente a application/json. | [Tabela 40. Cabeçalhos da solicitação] {#agnt_clnt_cll-GET-exec-bkgrd-stop__entry__18} | Cabeçalho | Descrição | |-|-| | Nenhum(a) | | [Tabela 41. Cabeçalhos de resposta] ### Códigos de status Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte [Códigos de resposta HTTP de REST API](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles."). {#agnt_clnt_cll-GET-exec-bkgrd-stop__entry__22}{#agnt_clnt_cll-GET-exec-bkgrd-stop__entry-200-status-code} | Código de status | Descrição | |-|-| | 200 | Bem-sucedido. A solicitação foi processada com sucesso. | | 404 | A solicitação com o ID fornecido não foi encontrada. | [Tabela 42. Códigos de status] ### Parâmetros do corpo da resposta (JSON) {#agnt_clnt_cll-GET-exec-bkgrd-stop__entry__28} | Nome | Descrição | |-|-| | Nenhum(a) | | [ ] ### Solicitação de cURL O exemplo a seguir mostra como interromper uma verificação em segundo plano. curl "https://instance.service-now.com/api/sn_agent/agents/exec/background/stop/02359174db2a30108a0751f4f3961997" \ --request GET \ --header "Accept:application/json" \ --user 'username':'password' ## Agent Client Collector - GET /agents/exec/run/{request_id} {#ariaid-title9} Obtém o status da solicitação com o ID fornecido. ### Formato da URL /api/sn_agent/agents/exec/run/{request_id} ### Parâmetros de solicitação compatíveis {#agnt_clnt_cll-GET-exec-run__table_vmf_44q_wqb__entry__2} | Nome | Descrição | |-|-| | request_id | O ID de uma solicitação de verificação em segundo plano gerada pela execução da API POST /agents/check_defs/{check_def_id}/run. | [Tabela 43. Parâmetros de caminho] {#agnt_clnt_cll-GET-exec-run__table_vmf_44q_wqb} {#agnt_clnt_cll-GET-exec-run__entry__6} | Nome | Descrição | |-|-| | Nenhum(a) | | [Tabela 44. Parâmetros de consulta] {#agnt_clnt_cll-GET-exec-run__entry__10} | Nome | Descrição | |-|-| | Nenhum(a) | | [Tabela 45. Parâmetros do corpo da solicitação (JSON)] ### Cabeçalhos Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte [Cabeçalhos de REST API compatíveis](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles."). {#agnt_clnt_cll-GET-exec-run__entry__14}{#agnt_clnt_cll-GET-exec-run__accept-JSON-only-entry-RESTAPI} | Cabeçalho | Descrição | |-|-| | Aceitar | Formato de dados do corpo da resposta. Oferece suporte somente a application/json. | [Tabela 46. Cabeçalhos da solicitação] {#agnt_clnt_cll-GET-exec-run__entry__18} | Cabeçalho | Descrição | |-|-| | Nenhum(a) | | [Tabela 47. Cabeçalhos de resposta] ### Códigos de status Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte [Códigos de resposta HTTP de REST API](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles."). {#agnt_clnt_cll-GET-exec-run__table_zdx_xmq_wqb__entry__2}{#agnt_clnt_cll-GET-exec-run__entry-200-status-code} | Código de status | Descrição | |-|-| | 200 | Bem-sucedido. A solicitação foi processada com sucesso. | | 202 | Mensagem com o ID fornecido indicando que a solicitação está em andamento. | | 400 | Erro nos argumentos fornecidos no corpo da solicitação. | | 404 | A solicitação com o ID fornecido não foi encontrada. | | 408 | Tempo limite de execução para a solicitação com o ID fornecido. | | 500 | Erro ao verificar o status ou a solicitação com o ID fornecido. | [Tabela 48. Códigos de status] {#agnt_clnt_cll-GET-exec-run__table_zdx_xmq_wqb} ### Parâmetros do corpo da resposta (JSON) {#agnt_clnt_cll-GET-exec-run__entry__36} | Nome | Descrição | |-|-| | status | Status da solicitação. Valores possíveis: * Done -- Verificação bem-sucedida. * falha -- Falha na verificação. Consulte a mensagem de erro para obter detalhes. * mid_flow -- A saída da solicitação está sendo processada pelo MID Server. * processando -- A verificação está em andamento. * timeout -- O processamento da verificação excedeu o limite de tempo definido no método runCheckForCis(). {#agnt_clnt_cll-GET-exec-run__ul_edm_1rr_5qb} Tipo de dados: cadeia de caracteres | | erro_msg | Mensagem de erro, se houver. Valores possíveis: * Nenhum agente encontrado para ICs relevantes. * Nenhuma solicitação de verificação em segundo plano com o ID fornecido. * Nenhuma solicitação com o ID fornecido. * Nenhum resultado de testes com o ID fornecido. * Tempo limite da solicitação. {#agnt_clnt_cll-GET-exec-run__ul_qcf_zcq_5qb} Tipo de dados: cadeia de caracteres | [ ] ### Solicitação de cURL O exemplo a seguir mostra como obter o status de uma solicitação. curl "https://instance.service-now.com/api/sn_agent/agents/exec/run/12fed13cdb2a30108a0751f4f3961981" \ --request GET \ --header "Accept:application/json" \ --user 'username':'password' ## Agent Client Collector - GET /agents/exec/test/{test_result_id} {#ariaid-title10} Obtém o status de verificação do resultado de teste fornecido. ### Formato da URL /api/sn_agent/agents/exec/test/{test_result_id} ### Parâmetros de solicitação compatíveis {#agnt_clnt_cll-GET-exec-test-result__entry__2} | Nome | Descrição | |-|-| | test_result_id | Um ID de resultado de testes gerado pela criação de uma solicitação de verificação de teste. | [Tabela 49. Parâmetros de caminho] {#agnt_clnt_cll-GET-exec-test-result__entry__6} | Nome | Descrição | |-|-| | Nenhum(a) | | [Tabela 50. Parâmetros de consulta] {#agnt_clnt_cll-GET-exec-test-result__entry__10} | Nome | Descrição | |-|-| | Nenhum(a) | | [Tabela 51. Parâmetros do corpo da solicitação (JSON)] ### Cabeçalhos Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte [Cabeçalhos de REST API compatíveis](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles."). {#agnt_clnt_cll-GET-exec-test-result__entry__14}{#agnt_clnt_cll-GET-exec-test-result__accept-JSON-only-entry-RESTAPI} | Cabeçalho | Descrição | |-|-| | Aceitar | Formato de dados do corpo da resposta. Oferece suporte somente a application/json. | [Tabela 52. Cabeçalhos da solicitação] {#agnt_clnt_cll-GET-exec-test-result__entry__18} | Cabeçalho | Descrição | |-|-| | Nenhum(a) | | [Tabela 53. Cabeçalhos de resposta] ### Códigos de status Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte [Códigos de resposta HTTP de REST API](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles."). {#agnt_clnt_cll-GET-exec-test-result__entry__22}{#agnt_clnt_cll-GET-exec-test-result__entry-200-status-code} | Código de status | Descrição | |-|-| | 200 | Bem-sucedido. A solicitação foi processada com sucesso. | | 202 | Mensagem com o ID fornecido indicando que a solicitação está em andamento. | | 404 | A solicitação com o ID fornecido não foi encontrada. | | 408 | Tempo limite de execução para a solicitação com o ID fornecido. | | 500 | Erro ao verificar o status da solicitação com o ID fornecido. | [Tabela 54. Códigos de status] ### Parâmetros do corpo da resposta (JSON) {#agnt_clnt_cll-GET-exec-test-result__entry__34} | Propriedades | Descrição | |-|-| | status | Status dos resultados de testes. Valores possíveis: * 0: Pendente * 1: Em andamento * 2: Concluído * 3: Nenhum resultado de teste com o ID fornecido {#agnt_clnt_cll-GET-exec-test-result__ul_yyq_4bq_5qb} Tipo de dados: cadeia de caracteres | | saída | Saída que descreve o status. Tipo de dados: cadeia de caracteres | [ ] ### Solicitação de cURL O exemplo a seguir mostra como obter o status do resultado de uma solicitação de verificação de teste concluída. curl "https://instance.service-now.com/api/sn_agent/agents/check_instances/99e12466dba530106f4810284b961976/test" \ --request POST \ --header "Accept:application/json" \ --user 'username':'password' ## Agent Client Collector - GET /agents/list {#ariaid-title11} Obtém uma lista de agentes com informações relacionadas. ### Formato da URL /api/sn_agent/agents/list ### Parâmetros de solicitação compatíveis {#agnt_clnt_cll-GET-list__entry__2} | Nome | Descrição | |-|-| | Nenhum(a) | | [Tabela 55. Parâmetros de caminho] {#agnt_clnt_cll-GET-list__entry__6} | Nome | Descrição | |-|-| | Nenhum(a) | | [Tabela 56. Parâmetros de consulta] {#agnt_clnt_cll-GET-list__entry__10} | Nome | Descrição | |-|-| | Nenhum(a) | | [Tabela 57. Parâmetros do corpo da solicitação (JSON)] ### Cabeçalhos Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte [Cabeçalhos de REST API compatíveis](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles."). {#agnt_clnt_cll-GET-list__entry__14}{#agnt_clnt_cll-GET-list__accept-JSON-only-entry-RESTAPI} | Cabeçalho | Descrição | |-|-| | Aceitar | Formato de dados do corpo da resposta. Oferece suporte somente a application/json. | | X-Enc-Query | Consulta codificada na tabela Agent Client Collectors \[sn_agent_cmdb_ci_agent\] no formato Glide padrão. Consulte Cadeias de [caracteres de consulta codificadas](https://www.servicenow.com/docs/access?context=c_EncodedQueryStrings&version=xanadu&pubname=xanadu-platform-user-interface&ft:locale=en-US). | | Limite X | Restringe os resultados a um número máximo de agentes. Use nulo ou indefinido para ambos se não forem necessários.Padrão/Máximo: 20.000 Tipo de dados: número | [Tabela 58. Cabeçalhos da solicitação] {#agnt_clnt_cll-GET-list__entry__22} | Cabeçalho | Descrição | |-|-| | Nenhum(a) | | [Tabela 59. Cabeçalhos de resposta] ### Códigos de status Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte [Códigos de resposta HTTP de REST API](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles."). {#agnt_clnt_cll-GET-list__table_vxl_353_dpb__entry__2}{#agnt_clnt_cll-GET-list__entry-200-status-code}{#agnt_clnt_cll-GET-list__agntCC-desc-403-user} | Código de status | Descrição | |-|-| | 200 | Bem-sucedido. A solicitação foi processada com sucesso. | | 403 | O usuário não tem a função agent_client_collector_user. | [Tabela 60. Códigos de status] {#agnt_clnt_cll-GET-list__table_vxl_353_dpb} ### Parâmetros do corpo da resposta (JSON) {#agnt_clnt_cll-GET-list__entry__32}{#agnt_clnt_cll-GET-list__accAgents-parm-agent-obj-id-entry}{#agnt_clnt_cll-GET-list__accAgents-parm-agent-obj-dataCollect-entry}{#agnt_clnt_cll-GET-list__accAgents-parm-agent-obj-ip-entry}{#agnt_clnt_cll-GET-list__accAgents-parm-agent-obj-dup-entry}{#agnt_clnt_cll-GET-list__accAgents-parm-agent-obj-restart-entry}{#agnt_clnt_cll-GET-list__accAgents-parm-agent-obj-name-entry}{#agnt_clnt_cll-GET-list__accAgents-parm-agent-obj-numChecks-entry}{#agnt_clnt_cll-GET-list__accAgents-parm-agent-obj-status-entry}{#agnt_clnt_cll-GET-list__accAgents-parm-agent-obj-up-entry}{#agnt_clnt_cll-GET-list__accAgents-parm-agent-obj-version-entry} | Propriedade | Descrição | |-|-| | \ | Matriz de objetos JSON que contém informações do agente estendido. [ { "agent_id": "String", "data_collection": Number, "ip_address": "String", "is_duplicate": Boolean, "is_restart_enabled": Boolean, "name": "String", "number_of_running_checks": Number, "status": Number, "up_since": "String", "version": "String" } ] | | agent_id | ID do agente conforme enviado. Tipo de dados: cadeia de caracteres | | coleta_dados | A coleta de dados indica se as verificações programadas devem ser executadas. Essas verificações fazem parte das políticas programadas para a execução deste agente. Valores possíveis: * 0: Ativado -- Verificações executadas conforme programado. * 1: Desativado (manual) -- As verificações foram desativadas manualmente. * 2: Desativado (automático) -- As verificações foram desativadas automaticamente devido ao alto consumo de CPU pelo {#agnt_clnt_cll-GET-list__ul_w4n_53p_bpb} Tipo de dados: número | | ip_address | Endereço IP do agente. Tipo de dados: cadeia de caracteres | | está_duplicado | Sinalizador que indica se este agente é uma duplicata de outro. Deve haver apenas um único agente em um determinado host. Valores possíveis: * verdadeiro: o agente tem o mesmo host que um agente Ativo/Ativo com um ID de agente diferente. Desativar ou desinstalar a duplicata * falso: este agente não tem duplicatas no estado Ativo/Ativo. {#agnt_clnt_cll-GET-list__ul_b34_ffl_bpb} Tipo de dados: booliano | | is_restart_enabled | Sinalizador que indica se a reinicialização está habilitada. A reinicialização do agente não é configurável. Depende do sistema operacional e da versão do sistema operacional em que o agente está sendo executado. Valores possíveis: * verdadeiro: a reinicialização está habilitada para este agente. * falso: a reinicialização está desabilitada para este agente. {#agnt_clnt_cll-GET-list__ul_bvp_dfl_bpb} Tipo de dados: booliano | | nome | Nome do agente. Tipo de dados: cadeia de caracteres | | número_de_verificações_em_execução | O número de verificações que o agente está programado para executar. Essas verificações fazem parte das políticas programadas para a execução deste agente. Tipo de dados: número | | status | Status do agente. Valores possíveis: * 0: Ativo/Ativo -- O agente está ativo. * 1: Aviso -- O agente não recebeu uma mensagem de manutenção de atividade nos últimos minutos. * 2: Inativo -- O agente não recebe uma mensagem de manutenção de atividade há muito tempo. * 3: Reiniciando -- O agente está reiniciando. {#agnt_clnt_cll-GET-list__ul_adg_ffp_bpb} Tipo de dados: número | | up_desde | Hora UTC desde que o status do agente se tornou ativo/ativo. O valor está no formato [GlideDateTime](https://servicenow-prod.fluidtopics.net/rM63LHg6OGy~hBdWP_QdHA#c_GlideDateTimeScoped "A classe GlideDateTime com escopo fornece métodos para executar operações em objetos GlideDateTime."). Tipo de dados: cadeia de caracteres | | versão | Versão de Agent Client Collector que o agente está executando. Tipo de dados: cadeia de caracteres | [ ] ### Solicitação de cURL O exemplo a seguir mostra como restringir resultados por consulta e número. A consulta retorna todos os agentes que não estão no estado inativo com um máximo de dois resultados. curl "https://instance.service-now.com/api/sn_agent/agents/list" \ --request GET \ --header "Accept:application/json" \ --header "X-Enc-Query: agent_extended_info.status!=2" \ --header "X-Limit: 2" \ --user 'username':'password' Saída: { "agents": [ { "name": "007-175", "status": 0, "agent_id": "007-175", "ip_address": "11.222.63.66", "number_of_running_checks": 0, "data_collection": 0, "is_restart_enabled": false, "is_duplicate": false, "up_since": "2021-03-24 14:36:45", "version": "2.4.0" }, { "name": "win2016-dc-64bit", "status": 0, "agent_id": "007-64", "ip_address": "10.222.333.42", "number_of_running_checks": 1, "data_collection": 0, "is_restart_enabled": true, "is_duplicate": false, "up_since": "2021-03-24 11:04:38", "version": "2.4.0" } ] } ### Solicitação de cURL {#agnt_clnt_cll-GET-list__example_es5_ycj_dpb} O exemplo a seguir mostra como listar todos os agentes do sistema. Este exemplo não usa nenhuma consulta e nenhum número máximo de resultados. curl "https://instance.service-now.com/api/sn_agent/agents/list" \ --request GET \ --header "Accept:application/json" \ --user 'username':'password' ## Agent Client Collector - GET /agents/{agent_id}/log {#ariaid-title12} Solicita o log de um agente especificado com status ativo/ativo. Nota: Para recuperar o log e verificar seu andamento, passe o ID da solicitação retornado para o endpoint GET /agents/log/{request_id}/. ### Formato da URL {#agnt_clnt_cll-GET-log__section_kpf_zyc_z4b} /api/sn_agent/agents/{agent_id}/log ### Parâmetros de solicitação compatíveis {#agnt_clnt_cll-GET-log__section_ewl_zyc_z4b} {#agnt_clnt_cll-GET-log__table_oyt_cd3_dpb__entry__2} | Nome | Descrição | |-|-| | agent_id | ID exclusivo de um agente listado na coluna ID do agente da tabela Agent Client Collectors \[sn_agent_cmdb_ci_agent\]. Para obter uma lista de IDs de agente e outros detalhes, execute o endpoint GET /agents/list. Tipo de dados: cadeia de caracteres | [Tabela 61. Parâmetros de caminho] {#agnt_clnt_cll-GET-log__table_oyt_cd3_dpb} {#agnt_clnt_cll-GET-log__table_gwl_zyc_z4b__entry__2} | Nome | Descrição | |-|-| | Nenhum(a) | | [Tabela 62. Parâmetros de consulta] {#agnt_clnt_cll-GET-log__table_gwl_zyc_z4b} {#agnt_clnt_cll-GET-log__table_hwl_zyc_z4b__entry__2} | Nome | Descrição | |-|-| | Nenhum(a) | | [Tabela 63. Parâmetros do corpo da solicitação (JSON)] {#agnt_clnt_cll-GET-log__table_hwl_zyc_z4b} ### Cabeçalhos {#agnt_clnt_cll-GET-log__section_iwl_zyc_z4b} Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte [Cabeçalhos de REST API compatíveis](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles."). {#agnt_clnt_cll-GET-log__table_jwl_zyc_z4b__entry__2}{#agnt_clnt_cll-GET-log__accept-JSON-only-entry-RESTAPI} | Cabeçalho | Descrição | |-|-| | Aceitar | Formato de dados do corpo da resposta. Oferece suporte somente a application/json. | [Tabela 64. Cabeçalhos da solicitação] {#agnt_clnt_cll-GET-log__table_jwl_zyc_z4b} {#agnt_clnt_cll-GET-log__table_kwl_zyc_z4b__entry__2} | Cabeçalho | Descrição | |-|-| | Nenhum(a) | | [Tabela 65. Cabeçalhos de resposta] {#agnt_clnt_cll-GET-log__table_kwl_zyc_z4b} ### Códigos de status {#agnt_clnt_cll-GET-log__section_lwl_zyc_z4b} Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte [Códigos de resposta HTTP de REST API](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles."). {#agnt_clnt_cll-GET-log__table_y2n_2f3_dpb__entry__2}{#agnt_clnt_cll-GET-log__entry-200-status-code}{#agnt_clnt_cll-GET-log__agntCC-desc-403-admin} | Código de status | Descrição | |-|-| | 200 | Bem-sucedido. A solicitação foi processada com sucesso. | | 403 | O usuário não tem a função agent_client_collector_admin. | | 404 | Agente não encontrado ou não está no estado ativo/ativo. | [Tabela 66. Códigos de status] {#agnt_clnt_cll-GET-log__table_y2n_2f3_dpb} ### Parâmetros do corpo da resposta (JSON) {#agnt_clnt_cll-GET-log__section_upf_zyc_z4b} {#agnt_clnt_cll-GET-log__table_vpf_zyc_z4b__entry__2} | Nome | Descrição | |-|-| | request_id | Sys_id de uma solicitação na tabela Solicitações do Agent Client Collector \[sn_agent_request\]. Você pode usar este ID para recuperar o log e verificar seu andamento com o endpoint GET /agents/log/{request_id}/. Tipo de dados: cadeia de caracteres | [ ] {#agnt_clnt_cll-GET-log__table_vpf_zyc_z4b} ### Solicitação de cURL O exemplo a seguir mostra como obter um ID de solicitação de log. curl "https://instance.service-now.com/api/sn_agent/agents//log" \ --request GET \ --header "Accept:application/json" \ --user 'username':'password' Saída: "request_id": "" ## Agent Client Collector - GET /agents/log/{request_id}/ {#ariaid-title13} Verifica o status de uma solicitação de log de captura. Detecta mudanças na solicitação de recuperação de log enviada com GET /api/sn_agent/agents/{agent_id}/log. ### Formato da URL /api/sn_agent/agents/log/{request_id}/ ### Parâmetros de solicitação compatíveis {#agnt_clnt_cll-GET-log-request_id__entry__2} | Nome | Descrição | |-|-| | request_id | Sys_id de uma solicitação na tabela Solicitações do Agent Client Collector \[sn_agent_request\]. Para o ID da solicitação, execute GET /api/sn_agent/agents/{agent_id}/log. Tipo de dados: cadeia de caracteres | [Tabela 67. Parâmetros de caminho] {#agnt_clnt_cll-GET-log-request_id__entry__6} | Nome | Descrição | |-|-| | Nenhum(a) | | [Tabela 68. Parâmetros de consulta] {#agnt_clnt_cll-GET-log-request_id__entry__10} | Nome | Descrição | |-|-| | Nenhum(a) | | [Tabela 69. Parâmetros do corpo da solicitação (JSON)] ### Cabeçalhos Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte [Cabeçalhos de REST API compatíveis](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles."). {#agnt_clnt_cll-GET-log-request_id__entry__14}{#agnt_clnt_cll-GET-log-request_id__accept-JSON-only-entry-RESTAPI} | Cabeçalho | Descrição | |-|-| | Aceitar | Formato de dados do corpo da resposta. Oferece suporte somente a application/json. | [Tabela 70. Cabeçalhos da solicitação] {#agnt_clnt_cll-GET-log-request_id__entry__18} | Cabeçalho | Descrição | |-|-| | Nenhum(a) | | [Tabela 71. Cabeçalhos de resposta] ### Códigos de status {#agnt_clnt_cll-GET-log-request_id__section_lwl_zyc_z4b} Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte [Códigos de resposta HTTP de REST API](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles."). {#agnt_clnt_cll-GET-log-request_id__table_y2n_2f3_dpb__entry__2}{#agnt_clnt_cll-GET-log-request_id__agntCC-desc-403-admin} | Código de status | Descrição | |-|-| | 200 | O status da solicitação é concluído e o log capturado está pronto. | | 202 | A solicitação de log de captura com o ID fornecido ainda está em andamento. | | 403 | O usuário não tem a função agent_client_collector_admin. | | 404 | Obter solicitação de log com o ID fornecido não encontrado. | | 408 | A solicitação de log de obtenção expirou. | | 500 | A solicitação de log de captura encontrou um erro. | [Tabela 72. Códigos de status] {#agnt_clnt_cll-GET-log-request_id__table_y2n_2f3_dpb} ### Parâmetros do corpo da resposta (JSON) {#agnt_clnt_cll-GET-log-request_id__entry__36} | Propriedades | Descrição | |-|-| | saída | Informações que descrevem o status. | [ ] ### Solicitação de cURL O exemplo a seguir mostra como usar um ID de solicitação para obter o status de uma solicitação de log de captura. curl "https://instance.service-now.com/api/sn_agent/agents/log/" \ --request GET \ --header "Accept:application/json" \ --user 'username':'password' Saída: { "output": "SensuSnReadFile OK: {\"component\":\"agent\",\"level\":\"info\",\"msg\":\"Agent Protection: cpu of all checks: 0%\",\"time\":\"2021-04-05T00:21:41-07:00\"},... } ## Agent Client Collector - GET /agents/policies/list {#ariaid-title14} Obtém uma lista de políticas que estão no estado de rascunho publicado ou não publicado. ### Formato da URL /api/sn_agent/agents/policies/list ### Parâmetros de solicitação compatíveis {#agnt_clnt_cll-GET-policies-list__entry__2} | Nome | Descrição | |-|-| | Nenhum(a) | | [Tabela 73. Parâmetros de caminho] {#agnt_clnt_cll-GET-policies-list__entry__6} | Nome | Descrição | |-|-| | Nenhum(a) | | [Tabela 74. Parâmetros de consulta] {#agnt_clnt_cll-GET-policies-list__entry__10} | Nome | Descrição | |-|-| | Nenhum(a) | | [Tabela 75. Parâmetros do corpo da solicitação (JSON)] ### Cabeçalhos Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte [Cabeçalhos de REST API compatíveis](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles."). {#agnt_clnt_cll-GET-policies-list__table_d1q_x5w_dpb__entry__2}{#agnt_clnt_cll-GET-policies-list__accept-JSON-only-entry-RESTAPI} | Cabeçalho | Descrição | |-|-| | Aceitar | Formato de dados do corpo da resposta. Oferece suporte somente a application/json. | | X-Enc-Query | Opcional. Cadeia de caracteres de consulta codificada no formato Glide padrão. Consulte Cadeias de [caracteres de consulta codificadas](https://www.servicenow.com/docs/access?context=c_EncodedQueryStrings&version=xanadu&pubname=xanadu-platform-user-interface&ft:locale=en-US). | | X-Include-Verificar-Parâmetros | Opcional. Sinalizador que indica se as instâncias de verificação e seus parâmetros devem ser retornados nos resultados. Valores válidos: * verdadeiro: inclui instâncias de verificação e seus parâmetros nos resultados. * falso: não inclui instâncias de verificação e seus parâmetros nos resultados. {#agnt_clnt_cll-GET-policies-list__ul_xmj_pyw_dpb} Padrão: falso Tipo de dados: booliano | | X-Incluir-Verificações-E-Agentes | Opcional. Sinalizador que indica se as instâncias de verificação e os agentes devem ser incluídos nos resultados. Valores válidos: * verdadeiro: inclui instâncias de verificação e agentes nos resultados. * falso: não inclui verificações e agentes nos resultados. {#agnt_clnt_cll-GET-policies-list__ul_asz_gvw_dpb} Padrão: falso Tipo de dados: booliano | [Tabela 76. Cabeçalhos da solicitação] {#agnt_clnt_cll-GET-policies-list__table_d1q_x5w_dpb} {#agnt_clnt_cll-GET-policies-list__table_abd_scx_dpb__entry__2} | Cabeçalho | Descrição | |-|-| | Nenhum(a) | | [Tabela 77. Cabeçalhos de resposta] {#agnt_clnt_cll-GET-policies-list__table_abd_scx_dpb} ### Códigos de status {#agnt_clnt_cll-GET-policies-list__section_bbd_scx_dpb} Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte [Códigos de resposta HTTP de REST API](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles."). {#agnt_clnt_cll-GET-policies-list__table_tmf_2gr_z4b__entry__2}{#agnt_clnt_cll-GET-policies-list__entry-200-status-code}{#agnt_clnt_cll-GET-policies-list__agntCC-desc-403-user} | Código de status | Descrição | |-|-| | 200 | Bem-sucedido. A solicitação foi processada com sucesso. | | 403 | O usuário não tem a função agent_client_collector_user. | [Tabela 78. Códigos de status] {#agnt_clnt_cll-GET-policies-list__table_tmf_2gr_z4b} ### Parâmetros do corpo da resposta (JSON) {#agnt_clnt_cll-GET-policies-list__entry__34}{#agnt_clnt_cll-GET-policies-list__agntCC-ph-rb-checks-sbox} | Propriedade | Descrição | |-|-| | políticas | Lista de políticas recuperadas. Inclui verificações e agente nos resultados se consultados usando cabeçalhos de solicitação específicos. Para obter informações sobre políticas, consulte [verificações e políticas padrão](https://www.servicenow.com/docs/access?context=agent-policies-checks&version=xanadu&pubname=xanadu-it-operations-management&ft:locale=en-US). { "policies": [ { "active": Boolean, "agent_ids": "String", "checks": [Array], "cred_alias": "String", "credential_alias": "String", "filter": "String", "interval": "Number", "monitored_ci_group": "String", "monitored_ci_script": "String", "monitored_ci_type_filter": Boolean, "monitored_ci_type_group": Boolean, "monitored_ci_type_script": "String", "name": "String", "params": [Array], "publish_status": "String", "secure_params": [Array], "sys_id": "String", "sys_updated_on": "String", "table": "String" } ] } Tipo de dados: matriz | | políticas.ativas | Sinalizador que indica se a política está ativa. Valores válidos: * verdadeiro: a política está ativa. * falso: a política não está ativa. {#agnt_clnt_cll-GET-policies-list__ul_qr2_g3x_dpb} Tipo de dados: booliano | | políticas.agente_ids | ID exclusivo de um agente listado na coluna ID do agente da tabela Agent Client Collectors \[sn_agent_cmdb_ci_agent\]. Esses resultados serão exibidos somente se o parâmetro de cabeçalho X-Include-Checks-And-Agents estiver definido como verdadeiro. Para obter informações estendidas de um agente, execute o ID no endpoint [GET /agents/{agent_id}](https://servicenow-prod.fluidtopics.net/0hS64SPtXLuUBX2LjwGOfg#agnt_clnt_cll-GET-agent_id "Obtém as informações de um agente especificado."). | | políticas.verificações | Lista de objetos que definem as verificações listadas na tabela Instâncias de verificação \[sn_agent_check\]. Esses resultados serão exibidos somente se o parâmetro de cabeçalho X-Include-Checks-And-Agents ou X-Include-Check-Params estiver definido como verdadeiro. Tipo de dados: matriz de objetos "checks": [ { "active": Boolean, "auto_generate": Boolean, "check_type": "String" "command_prefix": "String", "command": "String", "event_status_change_threshold": Number, "event_status_repair_threshold": Number, "interval": Number, "name": "String", "sys_id": "String", "timeout": "String" } ] {#agnt_clnt_cll-GET-policies-list__agntCC-code-rb-checks-sbox} | | policies.checks.active | Sinalizador que indica se a verificação de política está ativa. Valores válidos: * verdadeiro: a verificação de política está ativa. * falso: a verificação de política está inativa. {#agnt_clnt_cll-GET-policies-list__ul_j2p_sdt_2pb} Tipo de dados: booliano | | políticas.verificações.auto_generate | Sinalizador que indica se o comando deve ser gerado automaticamente com o valor command_prefix. Valores válidos: * verdadeiro: preenche automaticamente a propriedade command com valores de parâmetro ativos. * falso: o comando não é gerado automaticamente. {#agnt_clnt_cll-GET-policies-list__ul_myc_x2t_2pb} Tipo de dados: booliano | | políticas.verificações.check_type | Tipo de verificação que especifica a opção de monitoramento. Valores possíveis: * Descoberta: verificação que localiza ICs relacionados ao agente. * Eventos: o resultado da verificação é transformado em um evento de gestão de eventos. * Métricas: os valores do resultado da verificação são transformados em métricas. {#agnt_clnt_cll-GET-policies-list__ul_pgd_42t_2pb} Tipo de dados: cadeia de caracteres | | políticas.verificações.comando | Comando que o Agent Client Collector executa. Parâmetro obtido de um modelo ou IC monitorado. Nota: Se auto_generate for verdadeiro, esta propriedade será preenchida automaticamente com o prefixo e os sinalizadores dos parâmetros ativos listados no objeto parameters. Tipo de dados: cadeia de caracteres | | políticas.verificações.command_prefix | Se a propriedade auto_generate for verdadeira, este comando será usado para geração automática. O prefixo consiste em qualquer parte do comando que é estática (não muda), como o nome do script. Tipo de dados: cadeia de caracteres | | políticas.verificações.event_status_change_threshold | Número de vezes consecutivas em que o status de resposta de uma verificação deve ocorrer antes que um novo evento seja enviado. Retorna nulo se não estiver definido. Por exemplo, se este valor for 3, uma verificação cujo status de resposta muda de OK para Erro gerará um novo evento com um status de Erro após a terceira ocorrência consecutiva da mudança de status. Tipo de dados: número | | políticas.verificações.event_status_repair_threshold | Número de vezes consecutivas em que o status de resposta de uma verificação deve melhorar para fechar o evento anterior. Retorna nulo se não estiver definido. Por exemplo, se este valor for 3, uma verificação cujo status de resposta muda de Erro para OK fechará o evento anterior e gerará um novo evento com um status OK após a terceira ocorrência consecutiva da mudança de status. Tipo de dados: número | | políticas.verificações.intervalo | Quantidade de tempo em segundos de espera entre execuções de verificação. Por exemplo, um valor de 60 significa que a verificação é executada a cada 60 segundos. Tipo de dados: número | | policies.checks.name | Nome da verificação. Tipo de dados: cadeia de caracteres | | políticas.verificações.sys_id | Sys_id da verificação listada na tabela Instâncias de verificação \[sn_agent_check\]. Tipo de dados: cadeia de caracteres | | políticas.verificações.tempo limite | Quantidade de tempo, em segundos, após a qual a execução da verificação é interrompida quando nenhuma saída é retornada. Por exemplo, um valor de 60 significa que quando a execução de verificação não retorna um valor por 60 segundos, a execução é interrompida. Tipo de dados: cadeia de caracteres | | políticas.cred_alias | Nome listado na tabela Credenciais \[discovery_credentials\]. Tipo de dados: cadeia de caracteres | | políticas.credential_alias | Sys_id do alias de credencial na tabela Aliases de conexão e credencial \[sys_alias\]. Tipo de dados: cadeia de caracteres | | políticas.filtro | Filtro que restringe as verificações da política para monitorar somente os critérios especificados. Tipo de dados: cadeia de caracteres | | políticas.intervalo | Quantidade de tempo em segundos de espera entre verificações de política. Por exemplo, um valor de 60 significa que a verificação é executada a cada 60 segundos. Nota: O valor da propriedade checks.interval substitui o valor configurado neste campo. Tipo de dados: número | | políticas.monitored_ci_group | Nome dos [grupos do CMDB](https://www.servicenow.com/docs/access?context=cmdb-groups&version=xanadu&pubname=xanadu-servicenow-platform&ft:locale=en-US) associados à política. Este CMDB está listado na tabela Grupos do CMDB \[cmdb_group\]. Este campo só será aplicado se o valor da propriedade monitored_ci_type_group for verdadeiro. Tipo de dados: cadeia de caracteres | | políticas.script_ci_monitorado | Script para monitoramento de ICs. Este campo só será aplicado se o valor da propriedade policies.monitored_ci_type_script for verdadeiro. Tipo de dados: cadeia de caracteres | | políticas.monitored_ci_type_filter | Sinalizador que indica se a filtragem por tipo de IC está habilitada. O tipo de IC está listado na propriedade table. Valores válidos: * verdadeiro: a filtragem por grupo de verificações está habilitada. * falso: a filtragem por grupo de verificações está desabilitada. {#agnt_clnt_cll-GET-policies-list__ul_tvm_fvt_2pb} Tipo de dados: booliano | | políticas.monitored_ci_type_group | Sinalizador que indica se o monitoramento por tipo de grupo do CMDB está habilitado. Valores válidos: * verdadeiro: o tipo de grupo do CMDB está habilitado. * falso: o tipo de grupo do CMDB está desabilitado. {#agnt_clnt_cll-GET-policies-list__ul_jrc_fvt_2pb} Tipo de dados: booliano | | políticas.monitorado_ci_tipo_script | Sinalizador que indica se o script para monitoramento de ICs está habilitado. Valores válidos: * verdadeiro: o script para monitoramento de ICs está habilitado. * falso: o script para monitoramento de ICs está desabilitado. {#agnt_clnt_cll-GET-policies-list__ul_bs4_3wt_2pb} Tipo de dados: booliano | | policies.name | Nome da política. Tipo de dados: cadeia de caracteres | | políticas.publish_status | Indica se a política foi publicada. Valores possíveis: * Rascunho: a política não foi publicada e pode ser editada usando os endpoints de atualização. * Publicado: a política foi publicada. O rascunho (cópia da área restrita) e a cópia publicada são idênticos. * Publicado\*: a política foi publicada, mas a cópia de rascunho (exibição da área restrita) tem mudanças não encontradas na cópia publicada. {#agnt_clnt_cll-GET-policies-list__ul_d3k_qzm_fpb} Tipo de dados: cadeia de caracteres | | políticas.sys_id | Sys_id da política listada na tabela Políticas \[sn_agent_policy\]. Tipo de dados: cadeia de caracteres | | políticas.sys_updated_on | Data e hora em que a política foi atualizada pela última vez. Tipo de dados: cadeia de caracteres | | políticas.tabela | Campo de tipo de IC monitorado na política. Este campo só será aplicado se monitored_ci_type_filter for verdadeiro. Tipo de dados: cadeia de caracteres | | políticas.parâmetros | Lista de objetos que contém informações de parâmetros de verificação listados na tabela Parâmetros de verificação \[sn_agent_check_param\]. Esses resultados serão exibidos somente se o parâmetro de cabeçalho X-Include-Check-Params estiver definido como verdadeiro. Tipo de dados: matriz de objetos "params": [ { "active": Boolean, "flag": "String", "mandatory: Boolean, "name": "String", "sys_id": "String", "value": "String", "value_required": Boolean } ] | | policies.params.active | Sinalizador que indica se o parâmetro de verificação está ativo. Valores válidos: * verdadeiro: verificar se o parâmetro está ativo. * falso: o parâmetro de verificação está inativo. {#agnt_clnt_cll-GET-policies-list__ul_u2x_5fv_2pb} Tipo de dados: booliano | | policys.params.flag | Sinalizador de parâmetro a ser usado durante a invocação de verificação. Tipo de dados: cadeia de caracteres | | políticas.parâmetros.obrigatórios | Sinalizador que indica se esta verificação é obrigatória. Valores válidos: * verdadeiro: esta verificação é obrigatória. * falso: esta verificação é opcional. {#agnt_clnt_cll-GET-policies-list__ul_flq_qkv_2pb} Tipo de dados: booliano | | policies.params.name | Nome do parâmetro. Tipo de dados: cadeia de caracteres | | políticas.params.sys_id | Sys_id do parâmetro listado na tabela Parâmetros de verificação \[sn_agent_check_param\]. Tipo de dados: cadeia de caracteres | | políticas.parâmetros.valor | Valor do parâmetro. Tipo de dados: cadeia de caracteres | | políticas.params.value_required | Sinalizador que indica se as informações fornecidas pela propriedade de valor são necessárias. Valores válidos: * verdadeiro: a propriedade de valor é obrigatória. * falso: a propriedade de valor é nula ou não é necessária. {#agnt_clnt_cll-GET-policies-list__ul_ug3_3jv_2pb} Tipo de dados: booliano | | políticas.parâmetros_seguros | Lista de objetos que contém informações de parâmetros seguros de verificação listados na tabela Verificar parâmetros seguros \[sn_agent_check_secure_param\]. Para obter mais informações, consulte [Criação de um parâmetro seguro para uma verificação](https://www.servicenow.com/docs/access?context=acc-create-secure-params&version=xanadu&pubname=xanadu-it-operations-management&ft:locale=en-US). Esses resultados serão exibidos somente se o parâmetro de cabeçalho X-Include-Check-Params estiver definido como verdadeiro. Tipo de dados: matriz de objetos "secure_params": [ { "active": Boolean, "name": "String", "order": Number, "sys_id": "String" } ] | | policies.secure_params.active | Sinalizador que indica se o parâmetro de verificação de segurança está ativo. Valores válidos: * verdadeiro: o parâmetro de verificação de segurança está ativo. * falso: o parâmetro de verificação de segurança está inativo. {#agnt_clnt_cll-GET-policies-list__ul_xwy_vfv_2pb} Tipo de dados: booliano | | policies.secure_params.name | Nome do parâmetro seguro. Tipo de dados: cadeia de caracteres | | políticas.parâmetros_seguros.ordem | Ordem na qual o parâmetro é enviado para o comando/script de verificação. Tipo de dados: número | | políticas.secure_params.sys_id | Sys_id do registro na tabela Verificar parâmetro seguro \[sn_agent_check_secure_param\]. Tipo de dados: cadeia de caracteres | [Tabela 79. Objeto] ### Solicitação de cURL {#agnt_clnt_cll-GET-policies-list__example_dy2_wbx_dpb} O exemplo a seguir mostra como restringir resultados por consulta e número. A consulta retorna todas as políticas ativas e o ID do agente associado. curl "https://instance.service-now.com/api/sn_agent/agents/policies/list" \ --request GET \ --header "Accept:application/json" \ --header 'X-Enc-Query: active=true ' \ --header 'X-Include-Checks-And-Agents: true' \ --user 'username' : 'password' Saída: { "policies": [ { "name": "Basic Discovery", "sys_id": "68bfd27c536113006dfeddeeff7b12be", "active": "true", "interval": "43200", "sys_updated_on": "2020-07-21 10:14:12", "monitored_ci_type_filter": "true", "filter": "discovery_source=AgentClientCollector^ORlast_discoveredRELATIVELT@dayofweek@ago@14", "table": "cmdb_ci_server", "monitored_ci_type_script": "false", "monitored_ci_script": "/*\n Provide a script to get monitored CI type. ...", "monitored_ci_type_group": "false", "monitored_ci_group": "null// group name as seen in cmdb_group table", "cred_alias": "null// credential name as seen in discovery_credentials table", "credential_alias": "null// credential alias sys id as seen in sys_alias table", "publish_status": "Published", "checks": [ { "name": "check-discovery-basic", "sys_id": "5b10c644c7e10010b9a4362c14c260aa", "active": "true", "command": "check_discover.rb", "command_prefix": "check_discover.rb", "auto_generate": "true", "timeout": "60", "interval": "43200", "event_status_change_threshold": null, "event_status_repair_threshold": null, "check_type": "Discovery" } ], "agent_ids": "b1faba21b066256f,a088b75b1b25b0a0" } ] } ## Agent Client Collector - GET /agents/policy/activate/{policy_id} {#ariaid-title15} Ativa uma política publicada. Para obter uma lista de políticas publicadas, use [GET /agents/policies/list](https://servicenow-prod.fluidtopics.net/0hS64SPtXLuUBX2LjwGOfg#agnt_clnt_cll-GET-policies-list "Obtém uma lista de políticas que estão no estado de rascunho publicado ou não publicado."). Este endpoint só oferece suporte a sys_ids nos quais o valor da propriedade publish_status da política é `Published` ou `Published*`. ### Formato da URL /api/sn_agent/agents/policy/activate/{policy_id} ### Parâmetros de solicitação compatíveis {#agnt_clnt_cll-GET-policy-act__section_g4n_tcx_dpb} {#agnt_clnt_cll-GET-policy-act__table_n3g_1fs_2pb__entry__2}{#agnt_clnt_cll-GET-policy-act__agntCC-entry-parm-policyID-pub} | Nome | Descrição | |-|-| | policy_id | Sys_id da política publicada listada na tabela Políticas \[sn_agent_policy\]. Tipo de dados: cadeia de caracteres | [Tabela 80. Parâmetros de caminho] {#agnt_clnt_cll-GET-policy-act__table_n3g_1fs_2pb} {#agnt_clnt_cll-GET-policy-act__table_i4n_tcx_dpb__entry__2} | Nome | Descrição | |-|-| | Nenhum(a) | | [Tabela 81. Parâmetros de consulta] {#agnt_clnt_cll-GET-policy-act__table_i4n_tcx_dpb} {#agnt_clnt_cll-GET-policy-act__table_j4n_tcx_dpb__entry__2} | Nome | Descrição | |-|-| | Nenhum(a) | | [Tabela 82. Parâmetros do corpo da solicitação (JSON)] {#agnt_clnt_cll-GET-policy-act__table_j4n_tcx_dpb} ### Cabeçalhos Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte [Cabeçalhos de REST API compatíveis](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles."). {#agnt_clnt_cll-GET-policy-act__entry__14}{#agnt_clnt_cll-GET-policy-act__accept-JSON-only-entry-RESTAPI} | Cabeçalho | Descrição | |-|-| | Aceitar | Formato de dados do corpo da resposta. Oferece suporte somente a application/json. | [Tabela 83. Cabeçalhos da solicitação] {#agnt_clnt_cll-GET-policy-act__entry__18} | Cabeçalho | Descrição | |-|-| | Nenhum(a) | | [Tabela 84. Cabeçalhos de resposta] ### Códigos de status Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte [Códigos de resposta HTTP de REST API](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles."). {#agnt_clnt_cll-GET-policy-act__table_ckp_2gr_z4b__entry__2}{#agnt_clnt_cll-GET-policy-act__entry-200-status-code}{#agnt_clnt_cll-GET-policy-act__agntCC-desc-403-admin}{#agnt_clnt_cll-GET-policy-act__entry-500-status-code} | Código de status | Descrição | |-|-| | 200 | Bem-sucedido. A solicitação foi processada com sucesso. | | 403 | O usuário não tem a função agent_client_collector_admin. | | 404 | Nenhum registro encontrado com o sys_id fornecido. | | 500 | Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro. | [Tabela 85. Códigos de status] {#agnt_clnt_cll-GET-policy-act__table_ckp_2gr_z4b} ### Parâmetros do corpo da resposta (JSON) {#agnt_clnt_cll-GET-policy-act__table_h5l_bgs_2pb__entry__2} | Cabeçalho | Descrição | |-|-| | mensagem | Mensagem que contém resultados de sucesso ou falha da operação. Tipo de dados: cadeia de caracteres | [ ] {#agnt_clnt_cll-GET-policy-act__table_h5l_bgs_2pb} ### Solicitação de cURL O exemplo a seguir mostra como ativar uma política. curl "https://instance.service-now.com/api/sn_agent/agents/policy/activate/" \ --request GET \ --header "Accept:application/json" \ --user 'username' : 'password' Saída: { "message": "Operation was successful" } ## Agent Client Collector - GET /agents/policy/deactivate/{policy_id} {#ariaid-title16} Desativa uma política publicada. Para obter uma lista de políticas publicadas, use [GET /agents/policies/list](https://servicenow-prod.fluidtopics.net/0hS64SPtXLuUBX2LjwGOfg#agnt_clnt_cll-GET-policies-list "Obtém uma lista de políticas que estão no estado de rascunho publicado ou não publicado."). Este endpoint só oferece suporte a sys_ids nos quais o valor da propriedade publish_status da política é `Published` ou `Published*`. ### Formato da URL {#agnt_clnt_cll-GET-policy-deact__section_f4n_tcx_dpb} /api/sn_agent/agents/policy/activate/{policy_id} ### Parâmetros de solicitação compatíveis {#agnt_clnt_cll-GET-policy-deact__section_g4n_tcx_dpb} {#agnt_clnt_cll-GET-policy-deact__table_f4v_qfs_2pb__entry__2}{#agnt_clnt_cll-GET-policy-deact__agntCC-entry-parm-policyID-pub} | Nome | Descrição | |-|-| | policy_id | Sys_id da política publicada listada na tabela Políticas \[sn_agent_policy\]. Tipo de dados: cadeia de caracteres | [Tabela 86. Parâmetros de caminho] {#agnt_clnt_cll-GET-policy-deact__table_f4v_qfs_2pb} {#agnt_clnt_cll-GET-policy-deact__table_i4n_tcx_dpb__entry__2} | Nome | Descrição | |-|-| | Nenhum(a) | | [Tabela 87. Parâmetros de consulta] {#agnt_clnt_cll-GET-policy-deact__table_i4n_tcx_dpb} {#agnt_clnt_cll-GET-policy-deact__table_j4n_tcx_dpb__entry__2} | Nome | Descrição | |-|-| | Nenhum(a) | | [Tabela 88. Parâmetros do corpo da solicitação (JSON)] {#agnt_clnt_cll-GET-policy-deact__table_j4n_tcx_dpb} ### Cabeçalhos Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte [Cabeçalhos de REST API compatíveis](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles."). {#agnt_clnt_cll-GET-policy-deact__table_l4n_tcx_dpb__entry__2}{#agnt_clnt_cll-GET-policy-deact__accept-JSON-only-entry-RESTAPI} | Cabeçalho | Descrição | |-|-| | Aceitar | Formato de dados do corpo da resposta. Oferece suporte somente a application/json. | [Tabela 89. Cabeçalhos da solicitação] {#agnt_clnt_cll-GET-policy-deact__table_l4n_tcx_dpb} {#agnt_clnt_cll-GET-policy-deact__table_m4n_tcx_dpb__entry__2} | Cabeçalho | Descrição | |-|-| | Nenhum(a) | | [Tabela 90. Cabeçalhos de resposta] {#agnt_clnt_cll-GET-policy-deact__table_m4n_tcx_dpb} ### Códigos de status {#agnt_clnt_cll-GET-policy-deact__section_n4n_tcx_dpb} Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte [Códigos de resposta HTTP de REST API](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles."). {#agnt_clnt_cll-GET-policy-deact__table_ckp_2gr_z4b__entry__2}{#agnt_clnt_cll-GET-policy-deact__entry-200-status-code}{#agnt_clnt_cll-GET-policy-deact__agntCC-desc-403-admin}{#agnt_clnt_cll-GET-policy-deact__entry-500-status-code} | Código de status | Descrição | |-|-| | 200 | Bem-sucedido. A solicitação foi processada com sucesso. | | 403 | O usuário não tem a função agent_client_collector_admin. | | 404 | Nenhum registro encontrado com o sys_id fornecido. | | 500 | Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro. | [Tabela 91. Códigos de status] {#agnt_clnt_cll-GET-policy-deact__table_ckp_2gr_z4b} ### Parâmetros do corpo da resposta (JSON) {#agnt_clnt_cll-GET-policy-deact__section_znm_1mq_fpb} {#agnt_clnt_cll-GET-policy-deact__table_h5l_bgs_2pb__entry__2} | Cabeçalho | Descrição | |-|-| | mensagem | Mensagem que contém resultados de sucesso ou falha da operação. Tipo de dados: cadeia de caracteres | [ ] {#agnt_clnt_cll-GET-policy-deact__table_h5l_bgs_2pb} ### Solicitação de cURL {#agnt_clnt_cll-GET-policy-deact__example_bgj_chs_2pb} O exemplo a seguir mostra como desativar uma política. curl "https://instance.service-now.com/api/sn_agent/agents/policy/deactivate/" \ --request GET \ --header "Accept:application/json" \ --user 'username' : 'password' Saída: { "message": "Operation was successful" } ## Agent Client Collector - GET /agents/policy/publish/{policy_id} {#ariaid-title17} Publica uma política de rascunho. Use qualquer um dos seguintes endpoints para modificar uma cópia de rascunho ou de área restrita antes da publicação: * [POST /agents/update/policy/{policy_id}](https://servicenow-prod.fluidtopics.net/0hS64SPtXLuUBX2LjwGOfg#agnt_clnt_cll-POST-update-policy "Atualiza uma cópia da área restrita de uma política.") * [POST /agents/update/check/{check_id}](https://servicenow-prod.fluidtopics.net/0hS64SPtXLuUBX2LjwGOfg#agnt_clnt_cll-POST-update-check-id "Atualiza uma verificação de política selecionada.") * [POST /agents/update/check_param/{param_id}](https://servicenow-prod.fluidtopics.net/0hS64SPtXLuUBX2LjwGOfg#agnt_clnt_cll-POST-update-check_param "Atualiza um parâmetro de verificação de política selecionado.") * [POST /agents/update/check_secure_param/{param_id}](https://servicenow-prod.fluidtopics.net/0hS64SPtXLuUBX2LjwGOfg#agnt_clnt_cll-POST-update-check_secure "Atualiza um parâmetro seguro de verificação de política selecionado.") {#agnt_clnt_cll-GET-policy-publish__ul_p14_jbh_fpb} ### Formato da URL /api/sn_agent/agents/policy/publish/{policy_id} ### Parâmetros de solicitação compatíveis {#agnt_clnt_cll-GET-policy-publish__section_g4n_tcx_dpb} {#agnt_clnt_cll-GET-policy-publish__table_n3g_1fs_2pb__entry__2} | Nome | Descrição | |-|-| | policy_id | Sys_id de uma política na tabela Políticas \[sn_agent_policy\] que está no estado Rascunho ou uma cópia da área restrita. * Para obter uma lista de políticas e detalhes, incluindo o estado de publicação, use [GET /agents/policies/list](https://servicenow-prod.fluidtopics.net/0hS64SPtXLuUBX2LjwGOfg#agnt_clnt_cll-GET-policies-list "Obtém uma lista de políticas que estão no estado de rascunho publicado ou não publicado."). * Para recuperar a cópia da área restrita de uma política, use [GET /agents/policy/sandbox_from_published/{policy_id}](https://servicenow-prod.fluidtopics.net/0hS64SPtXLuUBX2LjwGOfg#agnt_clnt_cll-GET-policy-sbox-fr "Obtém a cópia da área restrita de uma política publicada e fornece detalhes da política."). {#agnt_clnt_cll-GET-policy-publish__ul_icv_npn_fpb} Tipo de dados: cadeia de caracteres | [Tabela 92. Parâmetros de caminho] {#agnt_clnt_cll-GET-policy-publish__table_n3g_1fs_2pb} {#agnt_clnt_cll-GET-policy-publish__table_i4n_tcx_dpb__entry__2} | Nome | Descrição | |-|-| | Nenhum(a) | | [Tabela 93. Parâmetros de consulta] {#agnt_clnt_cll-GET-policy-publish__table_i4n_tcx_dpb} {#agnt_clnt_cll-GET-policy-publish__table_j4n_tcx_dpb__entry__2} | Nome | Descrição | |-|-| | Nenhum(a) | | [Tabela 94. Parâmetros do corpo da solicitação (JSON)] {#agnt_clnt_cll-GET-policy-publish__table_j4n_tcx_dpb} ### Cabeçalhos Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte [Cabeçalhos de REST API compatíveis](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles."). {#agnt_clnt_cll-GET-policy-publish__entry__14}{#agnt_clnt_cll-GET-policy-publish__accept-JSON-only-entry-RESTAPI} | Cabeçalho | Descrição | |-|-| | Aceitar | Formato de dados do corpo da resposta. Oferece suporte somente a application/json. | [Tabela 95. Cabeçalhos da solicitação] {#agnt_clnt_cll-GET-policy-publish__entry__18} | Cabeçalho | Descrição | |-|-| | Nenhum(a) | | [Tabela 96. Cabeçalhos de resposta] ### Códigos de status Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte [Códigos de resposta HTTP de REST API](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles."). {#agnt_clnt_cll-GET-policy-publish__table_ckp_2gr_z4b__entry__2}{#agnt_clnt_cll-GET-policy-publish__entry-200-status-code}{#agnt_clnt_cll-GET-policy-publish__agntCC-desc-403-admin}{#agnt_clnt_cll-GET-policy-publish__entry-500-status-code} | Código de status | Descrição | |-|-| | 200 | Bem-sucedido. A solicitação foi processada com sucesso. | | 403 | O usuário não tem a função agent_client_collector_admin. | | 404 | Nenhum registro encontrado com o sys_id fornecido. | | 500 | Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro. | [Tabela 97. Códigos de status] {#agnt_clnt_cll-GET-policy-publish__table_ckp_2gr_z4b} ### Parâmetros do corpo da resposta (JSON) {#agnt_clnt_cll-GET-policy-publish__section_m1q_bmq_fpb} {#agnt_clnt_cll-GET-policy-publish__table_h5l_bgs_2pb__entry__2} | Cabeçalho | Descrição | |-|-| | mensagem | Mensagem que contém resultados de sucesso ou falha da operação. Tipo de dados: cadeia de caracteres | [ ] {#agnt_clnt_cll-GET-policy-publish__table_h5l_bgs_2pb} ### Solicitação de cURL O exemplo a seguir mostra como publicar uma política. curl "https://instance.service-now.com/api/sn_agent/agents/policy/publish/" \ --request GET \ --header "Accept:application/json" \ --user 'username' : 'password' Saída: { "message": "Operation was successful" } ## Agent Client Collector - GET /agents/policy/sandbox_from_published/{policy_id} {#ariaid-title18} Obtém a cópia da área restrita de uma política publicada e fornece detalhes da política. Use a cópia da área restrita para fazer atualizações em uma política e publicar. Você pode usar os sys_ids no corpo da resposta para trabalhar com os seguintes endpoints: * [POST /agents/update/policy/{policy_id}](https://servicenow-prod.fluidtopics.net/0hS64SPtXLuUBX2LjwGOfg#agnt_clnt_cll-POST-update-policy "Atualiza uma cópia da área restrita de uma política.") * [POST /agents/update/check/{check_id}](https://servicenow-prod.fluidtopics.net/0hS64SPtXLuUBX2LjwGOfg#agnt_clnt_cll-POST-update-check-id "Atualiza uma verificação de política selecionada.") * [POST /agents/update/check_param/{param_id}](https://servicenow-prod.fluidtopics.net/0hS64SPtXLuUBX2LjwGOfg#agnt_clnt_cll-POST-update-check_param "Atualiza um parâmetro de verificação de política selecionado.") * [POST /agents/update/check_secure_param/{param_id}](https://servicenow-prod.fluidtopics.net/0hS64SPtXLuUBX2LjwGOfg#agnt_clnt_cll-POST-update-check_secure "Atualiza um parâmetro seguro de verificação de política selecionado.") {#agnt_clnt_cll-GET-policy-sbox-fr__ul_p14_jbh_fpb} Para obter uma lista de políticas publicadas, use [GET /agents/policies/list](https://servicenow-prod.fluidtopics.net/0hS64SPtXLuUBX2LjwGOfg#agnt_clnt_cll-GET-policies-list "Obtém uma lista de políticas que estão no estado de rascunho publicado ou não publicado."). Este endpoint só oferece suporte a sys_ids nos quais o valor da propriedade publish_status da política é `Published` ou `Published*`. ### Formato da URL /api/sn_agent/agents/policy/sandbox_from_published/{policy_id} ### Parâmetros de solicitação compatíveis {#agnt_clnt_cll-GET-policy-sbox-fr__section_g4n_tcx_dpb} {#agnt_clnt_cll-GET-policy-sbox-fr__table_n3g_1fs_2pb__entry__2}{#agnt_clnt_cll-GET-policy-sbox-fr__agntCC-entry-parm-policyID-pub} | Nome | Descrição | |-|-| | policy_id | Sys_id da política publicada listada na tabela Políticas \[sn_agent_policy\]. Tipo de dados: cadeia de caracteres | [Tabela 98. Parâmetros de caminho] {#agnt_clnt_cll-GET-policy-sbox-fr__table_n3g_1fs_2pb} {#agnt_clnt_cll-GET-policy-sbox-fr__table_i4n_tcx_dpb__entry__2} | Nome | Descrição | |-|-| | Nenhum(a) | | [Tabela 99. Parâmetros de consulta] {#agnt_clnt_cll-GET-policy-sbox-fr__table_i4n_tcx_dpb} {#agnt_clnt_cll-GET-policy-sbox-fr__table_j4n_tcx_dpb__entry__2} | Nome | Descrição | |-|-| | Nenhum(a) | | [Tabela 100. Parâmetros do corpo da solicitação (JSON)] {#agnt_clnt_cll-GET-policy-sbox-fr__table_j4n_tcx_dpb} ### Cabeçalhos Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte [Cabeçalhos de REST API compatíveis](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles."). {#agnt_clnt_cll-GET-policy-sbox-fr__entry__14}{#agnt_clnt_cll-GET-policy-sbox-fr__accept-JSON-only-entry-RESTAPI} | Cabeçalho | Descrição | |-|-| | Aceitar | Formato de dados do corpo da resposta. Oferece suporte somente a application/json. | [Tabela 101. Cabeçalhos da solicitação] {#agnt_clnt_cll-GET-policy-sbox-fr__entry__18} | Cabeçalho | Descrição | |-|-| | Nenhum(a) | | [Tabela 102. Cabeçalhos de resposta] ### Códigos de status Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte [Códigos de resposta HTTP de REST API](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles."). {#agnt_clnt_cll-GET-policy-sbox-fr__table_ckp_2gr_z4b__entry__2}{#agnt_clnt_cll-GET-policy-sbox-fr__entry-200-status-code}{#agnt_clnt_cll-GET-policy-sbox-fr__agntCC-desc-403-admin}{#agnt_clnt_cll-GET-policy-sbox-fr__entry-500-status-code} | Código de status | Descrição | |-|-| | 200 | Bem-sucedido. A solicitação foi processada com sucesso. | | 403 | O usuário não tem a função agent_client_collector_admin. | | 404 | Nenhum registro encontrado com o sys_id fornecido. | | 500 | Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro. | [Tabela 103. Códigos de status] {#agnt_clnt_cll-GET-policy-sbox-fr__table_ckp_2gr_z4b} ### Parâmetros do corpo da resposta (JSON) {#agnt_clnt_cll-GET-policy-sbox-fr__entry__32} | Propriedade | Descrição | |-|-| | \ | Detalhes estendidos da cópia da área restrita associada à política. Para obter informações sobre políticas, consulte [verificações e políticas padrão](https://www.servicenow.com/docs/access?context=agent-policies-checks&version=xanadu&pubname=xanadu-it-operations-management&ft:locale=en-US). { "active": Boolean" "agent_ids": "String", "checks": [Array], "cred_alias": "String", "credential_alias": "String", "filter": "String", "interval": "Number", "monitored_ci_group": "String", "monitored_ci_script": "String", "monitored_ci_type_filter": Boolean, "monitored_ci_type_group": Boolean, "monitored_ci_type_script": "String", "name": "String", "params": [Array], "publish_status": "String", "secure_params": [Array], "sys_id": "String", "sys_updated_on": "String", "table": "String" } | | ativo | Sinalizador que indica se a política está ativa. Valores válidos: * verdadeiro: a política está ativa. * falso: a política não está ativa. {#agnt_clnt_cll-GET-policy-sbox-fr__ul_qr2_g3x_dpb} Tipo de dados: booliano | | agent_ids | ID exclusivo de um agente listado na coluna ID do agente da tabela Agent Client Collectors \[sn_agent_cmdb_ci_agent\]. Esses resultados serão exibidos somente se o parâmetro de cabeçalho X-Include-Checks-And-Agents estiver definido como verdadeiro. Para obter informações estendidas de um agente, execute o ID no endpoint [GET /agents/{agent_id}](https://servicenow-prod.fluidtopics.net/0hS64SPtXLuUBX2LjwGOfg#agnt_clnt_cll-GET-agent_id "Obtém as informações de um agente especificado."). | | verificações | Lista de objetos que definem as verificações listadas na tabela Instâncias de verificação \[sn_agent_check\]. "checks": [ { "active": Boolean, "auto_generate": Boolean, "check_type": "String" "command_prefix": "String", "command": "String", "event_status_change_threshold": Number, "event_status_repair_threshold": Number, "interval": Number, "name": "String", "sys_id": "String", "timeout": "String" } ] Tipo de dados: matriz | | verificações.ativo | Sinalizador que indica se a verificação de política está ativa. Valores válidos: * verdadeiro: a verificação de política está ativa. * falso: a verificação de política está inativa. {#agnt_clnt_cll-GET-policy-sbox-fr__ul_j2p_sdt_2pb} Tipo de dados: booliano | | verificações.auto_generate | Sinalizador que indica se o comando deve ser gerado automaticamente com o valor command_prefix. Valores válidos: * verdadeiro: preenche automaticamente a propriedade command com valores de parâmetro ativos. * falso: o comando não é gerado automaticamente. {#agnt_clnt_cll-GET-policy-sbox-fr__ul_myc_x2t_2pb} Tipo de dados: booliano | | verificações.check_type | Tipo de verificação que especifica a opção de monitoramento. Valores possíveis: * Descoberta: verificação que localiza ICs relacionados ao agente. * Eventos: o resultado da verificação é transformado em um evento de gestão de eventos. * Métricas: os valores do resultado da verificação são transformados em métricas. {#agnt_clnt_cll-GET-policy-sbox-fr__ul_pgd_42t_2pb} Tipo de dados: cadeia de caracteres | | verificações.comando | Comando que o Agent Client Collector executa. Parâmetro obtido de um modelo ou IC monitorado. Nota: Se auto_generate for verdadeiro, esta propriedade será preenchida automaticamente com o prefixo e os sinalizadores dos parâmetros ativos listados no objeto parameters. Tipo de dados: cadeia de caracteres | | checks.command_prefix | Se a propriedade auto_generate for verdadeira, este comando será usado para geração automática. O prefixo consiste em qualquer parte do comando que é estática (não muda), como o nome do script. Tipo de dados: cadeia de caracteres | | checks.event_status_change_threshold | Número de vezes consecutivas em que o status de resposta de uma verificação deve ocorrer antes que um novo evento seja enviado. Retorna nulo se não estiver definido. Por exemplo, se este valor for 3, uma verificação cujo status de resposta muda de OK para Erro gerará um novo evento com um status de Erro após a terceira ocorrência consecutiva da mudança de status. Tipo de dados: número | | checks.event_status_repair_threshold | Número de vezes consecutivas em que o status de resposta de uma verificação deve melhorar para fechar o evento anterior. Retorna nulo se não estiver definido. Por exemplo, se este valor for 3, uma verificação cujo status de resposta muda de Erro para OK fechará o evento anterior e gerará um novo evento com um status OK após a terceira ocorrência consecutiva da mudança de status. Tipo de dados: número | | verificações.intervalo | Quantidade de tempo em segundos de espera entre execuções de verificação. Por exemplo, um valor de 60 significa que a verificação é executada a cada 60 segundos. Tipo de dados: número | | checks.name | Nome da verificação. Tipo de dados: cadeia de caracteres | | verificações.sys_id | Sys_id da verificação listada na tabela Instâncias de verificação \[sn_agent_check\]. O endpoint [POST /agents/update/check/{check_id}](https://servicenow-prod.fluidtopics.net/0hS64SPtXLuUBX2LjwGOfg#agnt_clnt_cll-POST-update-check-id "Atualiza uma verificação de política selecionada.") usa este valor para atualizar a cópia da área restrita. Tipo de dados: cadeia de caracteres | | verificações.tempo limite | Quantidade de tempo, em segundos, após a qual a execução da verificação é interrompida quando nenhuma saída é retornada. Por exemplo, um valor de 60 significa que quando a execução de verificação não retorna um valor por 60 segundos, a execução é interrompida. Tipo de dados: cadeia de caracteres | | alias_cred | Nome listado na tabela Credenciais \[discovery_credentials\]. Tipo de dados: cadeia de caracteres | | credential_alias | Sys_id do alias de credencial na tabela Aliases de conexão e credencial \[sys_alias\]. Tipo de dados: cadeia de caracteres | | filtros | Filtro que restringe as verificações da política para monitorar somente os critérios especificados. Tipo de dados: cadeia de caracteres | | intervalo | Quantidade de tempo em segundos de espera entre verificações de política. Por exemplo, um valor de 60 significa que a verificação é executada a cada 60 segundos. Nota: O valor da propriedade checks.interval substitui o valor configurado neste campo. Tipo de dados: número | | monitor_ci_group | Nome dos [grupos do CMDB](https://www.servicenow.com/docs/access?context=cmdb-groups&version=xanadu&pubname=xanadu-servicenow-platform&ft:locale=en-US) associados à política. Este CMDB está listado na tabela Grupos do CMDB \[cmdb_group\]. Este campo só será aplicado se o valor da propriedade monitored_ci_type_group for verdadeiro. Tipo de dados: cadeia de caracteres | | script_ci_monitorado | Script para monitoramento de ICs. Este campo só será aplicado se o valor da propriedade policies.monitored_ci_type_script for verdadeiro. Tipo de dados: cadeia de caracteres | | monitorado_ci_type_filter | Sinalizador que indica se a filtragem por tipo de IC está habilitada. O tipo de IC está listado na propriedade table. Valores válidos: * verdadeiro: a filtragem por grupo de verificações está habilitada. * falso: a filtragem por grupo de verificações está desabilitada. {#agnt_clnt_cll-GET-policy-sbox-fr__ul_tvm_fvt_2pb} Tipo de dados: booliano | | monitorado_ci_type_group | Sinalizador que indica se o monitoramento por tipo de grupo do CMDB está habilitado. Valores válidos: * verdadeiro: o tipo de grupo do CMDB está habilitado. * falso: o tipo de grupo do CMDB está desabilitado. {#agnt_clnt_cll-GET-policy-sbox-fr__ul_jrc_fvt_2pb} Tipo de dados: booliano | | monitorado_ci_type_script | Sinalizador que indica se o script para monitoramento de ICs está habilitado. Valores válidos: * verdadeiro: o script para monitoramento de ICs está habilitado. * falso: o script para monitoramento de ICs está desabilitado. {#agnt_clnt_cll-GET-policy-sbox-fr__ul_bs4_3wt_2pb} Tipo de dados: booliano | | nome | Nome da política. Tipo de dados: cadeia de caracteres | | publicar_status | Indica se a política foi publicada. Valores possíveis: * Rascunho: a política não foi publicada e pode ser editada usando os endpoints de atualização. * Publicado: a política foi publicada. O rascunho (cópia da área restrita) e a cópia publicada são idênticos. * Publicado\*: a política foi publicada, mas a cópia de rascunho (exibição da área restrita) tem mudanças não encontradas na cópia publicada. {#agnt_clnt_cll-GET-policy-sbox-fr__ul_d3k_qzm_fpb} Tipo de dados: cadeia de caracteres | | parâms | Lista de objetos que contém informações de parâmetros de verificação listados na tabela Parâmetros de verificação \[sn_agent_check_param\]. Esses resultados serão exibidos somente se o parâmetro de cabeçalho X-Include-Check-Params estiver definido como verdadeiro. Tipo de dados: matriz de objetos "params": [ { "active": Boolean, "flag": "String", "mandatory: Boolean, "name": "String", "sys_id": "String", "value": "String", "value_required": Boolean } ] | | parâmetros.ativo | Sinalizador que indica se o parâmetro de verificação está ativo. Valores válidos: * verdadeiro: verificar se o parâmetro está ativo. * falso: o parâmetro de verificação está inativo. {#agnt_clnt_cll-GET-policy-sbox-fr__ul_u2x_5fv_2pb} Tipo de dados: booliano | | params.flag | Sinalizador de parâmetro a ser usado durante a invocação de verificação. Tipo de dados: cadeia de caracteres | | parâmetros.obrigatório | Sinalizador que indica se esta verificação é obrigatória. Valores válidos: * verdadeiro: esta verificação é obrigatória. * falso: esta verificação é opcional. {#agnt_clnt_cll-GET-policy-sbox-fr__ul_flq_qkv_2pb} Tipo de dados: booliano | | params.name | Nome do parâmetro. Tipo de dados: cadeia de caracteres | | params.sys_id | Sys_id do parâmetro listado na tabela Parâmetros de verificação \[sn_agent_check_param\]. O endpoint [POST /agents/update/check_param/{param_id}](https://servicenow-prod.fluidtopics.net/0hS64SPtXLuUBX2LjwGOfg#agnt_clnt_cll-POST-update-check_param "Atualiza um parâmetro de verificação de política selecionado.") usa este valor para atualizar a cópia da área restrita. Tipo de dados: cadeia de caracteres | | params.value | Valor do parâmetro. Tipo de dados: cadeia de caracteres | | params.value_required | Sinalizador que indica se as informações fornecidas pela propriedade de valor são necessárias. Valores válidos: * verdadeiro: a propriedade de valor é obrigatória. * falso: a propriedade de valor é nula ou não é necessária. {#agnt_clnt_cll-GET-policy-sbox-fr__ul_ug3_3jv_2pb} Tipo de dados: booliano | | parâmetros_seguros | Lista de objetos que contém informações de parâmetros seguros de verificação listados na tabela Verificar parâmetros seguros \[sn_agent_check_secure_param\]. Para obter mais informações, consulte [Criação de um parâmetro seguro para uma verificação](https://www.servicenow.com/docs/access?context=acc-create-secure-params&version=xanadu&pubname=xanadu-it-operations-management&ft:locale=en-US). Esses resultados serão exibidos somente se o parâmetro de cabeçalho X-Include-Check-Params estiver definido como verdadeiro. Tipo de dados: matriz de objetos "secure_params": [ { "active": Boolean, "name": "String", "order": Number, "sys_id": "String" } ] | | parâmetros_seguros.ativo | Sinalizador que indica se o parâmetro de verificação de segurança está ativo. Valores válidos: * verdadeiro: o parâmetro de verificação de segurança está ativo. * falso: o parâmetro de verificação de segurança está inativo. {#agnt_clnt_cll-GET-policy-sbox-fr__ul_xwy_vfv_2pb} Tipo de dados: booliano | | params_seguros.nome | Nome do parâmetro seguro. Tipo de dados: cadeia de caracteres | | parâmetros_seguros.ordem | Ordem na qual o parâmetro é enviado para o comando/script de verificação. Tipo de dados: número | | parâmetros_seguros.sys_id | Sys_id do registro localizado na tabela Verificar parâmetro de segurança \[sn_agent_check_secure_param\]. O endpoint [POST /agents/update/check_secure_param/{param_id}](https://servicenow-prod.fluidtopics.net/0hS64SPtXLuUBX2LjwGOfg#agnt_clnt_cll-POST-update-check_secure "Atualiza um parâmetro seguro de verificação de política selecionado.") usa este valor para atualizar a cópia da área restrita. Tipo de dados: cadeia de caracteres | | sys_id | Sys_id da política listada na tabela Políticas \[sn_agent_policy\]. O endpoint [POST /agents/update/policy/{policy_id}](https://servicenow-prod.fluidtopics.net/0hS64SPtXLuUBX2LjwGOfg#agnt_clnt_cll-POST-update-policy "Atualiza uma cópia da área restrita de uma política.") usa este valor para atualizar a cópia da área restrita. Tipo de dados: cadeia de caracteres | | sys_updated_on | Data e hora em que a política foi atualizada pela última vez. Tipo de dados: cadeia de caracteres | | tabela | Campo de tipo de IC monitorado na política. Este campo só será aplicado se monitored_ci_type_filter for verdadeiro. Tipo de dados: cadeia de caracteres | [ ] ### Solicitação de cURL Veja a seguir como obter informações da política de métricas de contêiner do Docker. curl "https://instance.service-now.com/api/sn_agent/agents/policy/sandbox_from_published/" \ --request GET \ --header "Accept:application/json" \ --user 'username':'password' Saída: { "name": "Docker Container Metrics", "sys_id": "b01e609a1b9fe4943e7f0b05464bcb91", "active": "false", "interval": "60", "sys_updated_on": "2021-04-05 19:52:28", "monitored_ci_type_filter": "true", "filter": "operational_status=1", "table": "cmdb_ci_docker_container", "monitored_ci_type_script": "false", "monitored_ci_script": "/*\n Provide a script to get monitored CI type.", "monitored_ci_type_group": "false", "monitored_ci_group": "null// group name as seen in cmdb_group table", "cred_alias": "null// credential name as seen in discovery_credentials table", "credential_alias": "null// credential alias sys id as seen in sys_alias table", "publish_status": "Published", "checks": [ { "name": "container.docker.metrics-docker", "sys_id": "701e609a1b9fe4943e7f0b05464bcb94", "active": "true", "command": "metrics-docker-stats.rb -N {{.labels.params_ci_container_id}} -P -n -i", "command_prefix": "metrics-docker-stats.rb -N {{.labels.params_ci_container_id}}", "auto_generate": "true", "timeout": "60", "interval": "60", "event_status_change_threshold": null, "event_status_repair_threshold": null, "check_type": "Metrics", "params": [ { "name": "scheme", "sys_id": "c11e609a1b9fe4943e7f0b05464bcb97", "value": null, "active": "false", "mandatory": "false", "value_required": "true", "flag": "-s" }, ... { "name": "docker_host", "sys_id": "cd1e609a1b9fe4943e7f0b05464bcb97", "value": null, "active": "false", "mandatory": "false", "value_required": "true", "flag": "-H" } ], "secure_params": [] } ] } ## Agent Client Collector - GET /agents/{agent_id}/restart {#ariaid-title19} Reinicia um agente especificado com status ativo/ativo. Se ocorrerem Agent Client Collector problemas de desempenho, você poderá reiniciar o agente. A reinicialização manual é compatível com os seguintes ambientes: * Agentes baseados em Linux usando `systemd` * Agentes do Windows {#agnt_clnt_cll-GET-restart__ul_zzv_z4q_dpb} ### Formato da URL {#agnt_clnt_cll-GET-restart__section_nf5_zyc_z4b} /api/sn_agent/agents/{agent_id}/restart ### Parâmetros de solicitação compatíveis {#agnt_clnt_cll-GET-restart__section_ewl_zyc_z4b} {#agnt_clnt_cll-GET-restart__table_oyt_cd3_dpb__entry__2} | Nome | Descrição | |-|-| | agent_id | ID exclusivo de um agente listado na coluna ID do agente da tabela Agent Client Collectors \[sn_agent_cmdb_ci_agent\]. Para obter uma lista de IDs de agente e outros detalhes, execute o endpoint GET /agents/list. Tipo de dados: cadeia de caracteres | [Tabela 104. Parâmetros de caminho] {#agnt_clnt_cll-GET-restart__table_oyt_cd3_dpb} {#agnt_clnt_cll-GET-restart__table_gwl_zyc_z4b__entry__2} | Nome | Descrição | |-|-| | Nenhum(a) | | [Tabela 105. Parâmetros de consulta] {#agnt_clnt_cll-GET-restart__table_gwl_zyc_z4b} {#agnt_clnt_cll-GET-restart__table_hwl_zyc_z4b__entry__2} | Nome | Descrição | |-|-| | Nenhum(a) | | [Tabela 106. Parâmetros do corpo da solicitação (JSON)] {#agnt_clnt_cll-GET-restart__table_hwl_zyc_z4b} ### Cabeçalhos {#agnt_clnt_cll-GET-restart__section_iwl_zyc_z4b} Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte [Cabeçalhos de REST API compatíveis](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles."). {#agnt_clnt_cll-GET-restart__table_jwl_zyc_z4b__entry__2}{#agnt_clnt_cll-GET-restart__accept-JSON-only-entry-RESTAPI} | Cabeçalho | Descrição | |-|-| | Aceitar | Formato de dados do corpo da resposta. Oferece suporte somente a application/json. | [Tabela 107. Cabeçalhos da solicitação] {#agnt_clnt_cll-GET-restart__table_jwl_zyc_z4b} {#agnt_clnt_cll-GET-restart__table_kwl_zyc_z4b__entry__2} | Cabeçalho | Descrição | |-|-| | Nenhum(a) | | [Tabela 108. Cabeçalhos de resposta] {#agnt_clnt_cll-GET-restart__table_kwl_zyc_z4b} ### Códigos de status {#agnt_clnt_cll-GET-restart__section_lwl_zyc_z4b} Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte [Códigos de resposta HTTP de REST API](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles."). {#agnt_clnt_cll-GET-restart__table_y2n_2f3_dpb__entry__2}{#agnt_clnt_cll-GET-restart__entry-200-status-code}{#agnt_clnt_cll-GET-restart__agntCC-desc-403-admin} | Código de status | Descrição | |-|-| | 200 | Bem-sucedido. A solicitação foi processada com sucesso. | | 403 | O usuário não tem a função agent_client_collector_admin. | | 404 | Nenhum registro encontrado com o sys_id fornecido ou este agente não é compatível com a reinicialização. | [Tabela 109. Códigos de status] {#agnt_clnt_cll-GET-restart__table_y2n_2f3_dpb} ### Parâmetros do corpo da resposta (JSON) {#agnt_clnt_cll-GET-restart__section_nwl_zyc_z4b} {#agnt_clnt_cll-GET-restart__table_owl_zyc_z4b__entry__2} | Nome | Descrição | |-|-| | mensagem | Mensagem que contém resultados de sucesso ou falha da operação. Tipo de dados: cadeia de caracteres | [ ] {#agnt_clnt_cll-GET-restart__table_owl_zyc_z4b} ### Solicitação de cURL {#agnt_clnt_cll-GET-restart__example_zf5_zyc_z4b} O exemplo a seguir mostra como reiniciar um agente. curl "https://instance.service-now.com/api/sn_agent/agents//restart" \ --request GET \ --header "Accept:application/json" \ --user 'username':'password' Saída: { "message": "Restarting Agent With ID: " } ## Agent Client Collector - POST /agents/check_defs/{check_def_id}/run {#ariaid-title20} Executa uma verificação em relação ao item de configuração fornecido. Para interromper uma verificação em segundo plano, use o ID de solicitação fornecido na API GET /agents/exec/background/stop/{request_id}. ### Formato da URL /api/sn_agent/agents/check_defs/{check_def_id}/run ### Parâmetros de solicitação compatíveis {#agnt_clnt_cll-POST-check-def-run__entry__2} | Nome | Descrição | |-|-| | check_def_id | Sys_id de uma definição de verificação na tabela Definições de verificação \[sn_agent_check_def\]. | [Tabela 110. Parâmetros de caminho] {#agnt_clnt_cll-POST-check-def-run__entry__6} | Nome | Descrição | |-|-| | Nenhum(a) | | [Tabela 111. Parâmetros de consulta] {#agnt_clnt_cll-POST-check-def-run__table_cvh_5gq_wqb__entry__2} | Nome | Descrição | |-|-| | parâms | Mapa de nomes e valores de parâmetro. Essas configurações podem ser usadas para substituir os registros de parâmetro da definição de verificação e seus valores especificados. "params": { "": "String" } Tipo de dados: objeto | | prioridade | Prioridade da solicitação a ser definida na fila do ECC. Valores possíveis: * 0: interativo * 1: agilizado * 2: padrão {#agnt_clnt_cll-POST-check-def-run__ul_bkf_hnq_wqb} Tipo de dados: número | | consulta | Consulta codificada para recuperar o GlideRecord da tabela especificada na propriedade table. Tipo de dados: cadeia de caracteres | | tabela | Nome da tabela cmdb_ci para esta verificação em segundo plano. Tipo de dados: cadeia de caracteres | | tempo limite | Valor do tempo limite da solicitação em segundos. Tipo de dados: número | [Tabela 112. Parâmetros do corpo da solicitação (JSON)] {#agnt_clnt_cll-POST-check-def-run__table_cvh_5gq_wqb} ### Cabeçalhos {#agnt_clnt_cll-POST-check-def-run__section_dvh_5gq_wqb} Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte [Cabeçalhos de REST API compatíveis](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles."). {#agnt_clnt_cll-POST-check-def-run__table_evh_5gq_wqb__entry__2}{#agnt_clnt_cll-POST-check-def-run__accept-JSON-only-entry-RESTAPI} | Cabeçalho | Descrição | |-|-| | Aceitar | Formato de dados do corpo da resposta. Oferece suporte somente a application/json. | [Tabela 113. Cabeçalhos da solicitação] {#agnt_clnt_cll-POST-check-def-run__table_evh_5gq_wqb} {#agnt_clnt_cll-POST-check-def-run__table_fvh_5gq_wqb__entry__2} | Cabeçalho | Descrição | |-|-| | Nenhum(a) | | [Tabela 114. Cabeçalhos de resposta] {#agnt_clnt_cll-POST-check-def-run__table_fvh_5gq_wqb} ### Códigos de status {#agnt_clnt_cll-POST-check-def-run__section_gvh_5gq_wqb} Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte [Códigos de resposta HTTP de REST API](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles."). {#agnt_clnt_cll-POST-check-def-run__table_hvh_5gq_wqb__entry__2}{#agnt_clnt_cll-POST-check-def-run__entry-200-status-code} | Código de status | Descrição | |-|-| | 200 | Bem-sucedido. A solicitação foi processada com sucesso. | | 400 | O é um erro nos argumentos fornecidos no corpo da solicitação. | | 404 | A definição de verificação com o ID fornecido não foi encontrada. | | 500 | Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro. | [Tabela 115. Códigos de status] {#agnt_clnt_cll-POST-check-def-run__table_hvh_5gq_wqb} ### Parâmetros do corpo da resposta (JSON) {#agnt_clnt_cll-POST-check-def-run__section_ivh_5gq_wqb} {#agnt_clnt_cll-POST-check-def-run__table_jvh_5gq_wqb__entry__2} | Nome | Descrição | |-|-| | requestId | Sys_id da solicitação de verificação em segundo plano gerada. | [ ] {#agnt_clnt_cll-POST-check-def-run__table_jvh_5gq_wqb} ### Solicitação de cURL {#agnt_clnt_cll-POST-check-def-run__example_kvh_5gq_wqb} O exemplo a seguir mostra como executar uma verificação em segundo plano e obter seu ID de solicitação. curl "https://instance.service-now.com/api/sn_agent/agents/check_defs/a90d3c361be1301060d2773ad54bcb6f/run" \ --request POST \ --header "Accept:application/json" \ --header "Content-Type:application/json" \ --data "{\"table\":\"sn_agent_check_def\"}" \ --user 'username':'password' Saída: { "request_id": "278c0170db2a30108a0751f4f3961926" } ## Agent Client Collector - POST /agents/check_defs/{check_def_id}/test {#ariaid-title21} Habilita a criação de solicitações de verificação de teste em definições de verificação. Use esta API para as seguintes tarefas: * Definir a definição de verificação como teste * Definir o item de configuração para executar o teste {#agnt_clnt_cll-POST-check-def-test__ul_tdb_gpk_5qb}Você também pode especificar um dos seguintes identificadores para usar durante o teste: * sys_id de credencial * ID do alias de credencial * Nome da credencial {#agnt_clnt_cll-POST-check-def-test__ul_tft_qwk_5qb} ### Formato da URL /api/sn_agent/agents/check_defs/{check_def_id}/test ### Parâmetros de solicitação compatíveis {#agnt_clnt_cll-POST-check-def-test__entry__2} | Nome | Descrição | |-|-| | check_def_id | Sys_id da definição de verificação listada na tabela Definições de verificação \[sn_agent_check_def\]. | [Tabela 116. Parâmetros de caminho] {#agnt_clnt_cll-POST-check-def-test__entry__6} | Nome | Descrição | |-|-| | Nenhum(a) | | [Tabela 117. Parâmetros de consulta] {#agnt_clnt_cll-POST-check-def-test__entry__10} | Nome | Descrição | |-|-| | ci_id | Sys_id de um item de configuração do CMDB. | | credentials_id | Sys_id de um registro de credenciais. | | credenciais_nome | Nome do registro de credenciais. | | credenciais_alias_id | Sys_id de um registro de alias de credenciais. | | credenciais_alias_name | Nome de um alias de credenciais. | [Tabela 118. Parâmetros do corpo da solicitação (JSON)] ### Cabeçalhos Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte [Cabeçalhos de REST API compatíveis](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles."). {#agnt_clnt_cll-POST-check-def-test__entry__22}{#agnt_clnt_cll-POST-check-def-test__accept-JSON-only-entry-RESTAPI} | Cabeçalho | Descrição | |-|-| | Aceitar | Formato de dados do corpo da resposta. Oferece suporte somente a application/json. | [Tabela 119. Cabeçalhos da solicitação] {#agnt_clnt_cll-POST-check-def-test__entry__26} | Cabeçalho | Descrição | |-|-| | Nenhum(a) | | [Tabela 120. Cabeçalhos de resposta] ### Códigos de status Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte [Códigos de resposta HTTP de REST API](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles."). {#agnt_clnt_cll-POST-check-def-test__entry__30}{#agnt_clnt_cll-POST-check-def-test__entry-200-status-code} | Código de status | Descrição | |-|-| | 200 | Bem-sucedido. A solicitação foi processada com sucesso. | | 500 | Erro ao criar a solicitação de teste. | [Tabela 121. Códigos de status] ### Parâmetros do corpo da resposta (JSON) {#agnt_clnt_cll-POST-check-def-test__section_d5l_yrv_wqb} {#agnt_clnt_cll-POST-check-def-test__table_e5l_yrv_wqb__entry__2} | Nome | Descrição | |-|-| | result_id | Sys_id do registro do resultado de testes. | [ ] {#agnt_clnt_cll-POST-check-def-test__table_e5l_yrv_wqb} ## Agent Client Collector - POST /agents/check_instances/{check_instance_id}/test {#ariaid-title22} Habilita a criação de solicitações de verificação de teste em instâncias de verificação. Use esta API para as seguintes tarefas: * Definir a instância de verificação como teste * Definir o item de configuração para executar o teste {#agnt_clnt_cll-POST-check-inst-test__ul_tdb_gpk_5qb}Você também pode especificar um dos seguintes identificadores para usar durante o teste: * sys_id de credencial * ID do alias de credencial * Nome da credencial {#agnt_clnt_cll-POST-check-inst-test__ul_tft_qwk_5qb} ### Formato da URL /api/sn_agent/agents/check_instances/{check_instance_id}/test ### Parâmetros de solicitação compatíveis {#agnt_clnt_cll-POST-check-inst-test__entry__2} | Nome | Descrição | |-|-| | verificação_instance_id | Sys_id da definição de verificação listada na tabela Definições de verificação \[sn_agent_check_def\]. | [Tabela 122. Parâmetros de caminho] {#agnt_clnt_cll-POST-check-inst-test__entry__6} | Nome | Descrição | |-|-| | Nenhum(a) | | [Tabela 123. Parâmetros de consulta] {#agnt_clnt_cll-POST-check-inst-test__table_obs_krv_wqb__entry__2} | Nome | Descrição | |-|-| | ci_id | Sys_id de um item de configuração do CMDB. | | credentials_id | Sys_id de um registro de credenciais. | | credenciais_nome | Nome do registro de credenciais. | | credenciais_alias_id | Sys_id de um registro de alias de credenciais. | | credenciais_alias_name | Nome de um alias de credenciais. | | proxy_agent_id | ID exclusivo de um proxy do agente para executar esta verificação. Este valor está listado na coluna ID do agente da tabela Agent Client Collectors \[sn_agent_cmdb_ci_agent\]. | [Tabela 124. Parâmetros do corpo da solicitação (JSON)] {#agnt_clnt_cll-POST-check-inst-test__table_obs_krv_wqb} ### Cabeçalhos Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte [Cabeçalhos de REST API compatíveis](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles."). {#agnt_clnt_cll-POST-check-inst-test__entry__24}{#agnt_clnt_cll-POST-check-inst-test__accept-JSON-only-entry-RESTAPI} | Cabeçalho | Descrição | |-|-| | Aceitar | Formato de dados do corpo da resposta. Oferece suporte somente a application/json. | [Tabela 125. Cabeçalhos da solicitação] {#agnt_clnt_cll-POST-check-inst-test__entry__28} | Cabeçalho | Descrição | |-|-| | Nenhum(a) | | [Tabela 126. Cabeçalhos de resposta] ### Códigos de status Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte [Códigos de resposta HTTP de REST API](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles."). {#agnt_clnt_cll-POST-check-inst-test__table_b2r_5gr_wqb__entry__2}{#agnt_clnt_cll-POST-check-inst-test__entry-200-status-code} | Código de status | Descrição | |-|-| | 200 | Bem-sucedido. A solicitação foi processada com sucesso. | | 500 | Erro ao criar a solicitação de teste. | [Tabela 127. Códigos de status] {#agnt_clnt_cll-POST-check-inst-test__table_b2r_5gr_wqb} ### Parâmetros do corpo da resposta (JSON) {#agnt_clnt_cll-POST-check-inst-test__entry__38} | Nome | Descrição | |-|-| | result_id | Sys_id do registro do resultado de testes. | [ ] ## Agent Client Collector - POST /agents/update/check/{check_id} {#ariaid-title23} Atualiza uma verificação de política selecionada. Para recuperar as propriedades de uma cópia da área restrita de política, use [GET /agents/policy/sandbox_from_published/{policy_id}](https://servicenow-prod.fluidtopics.net/0hS64SPtXLuUBX2LjwGOfg#agnt_clnt_cll-GET-policy-sbox-fr "Obtém a cópia da área restrita de uma política publicada e fornece detalhes da política."). ### Formato da URL /api/sn_agent/agents/update/check/{check_id} ### Parâmetros de solicitação compatíveis {#agnt_clnt_cll-POST-update-check-id__section_vvx_g2z_2pb} {#agnt_clnt_cll-POST-update-check-id__table_n3g_1fs_2pb__entry__2} | Nome | Descrição | |-|-| | check_id | Sys_id de uma cópia da área restrita de verificação de política na tabela Verificar instâncias \[sn_agent_check\]. Tipo de dados: cadeia de caracteres | [Tabela 128. Parâmetros de caminho] {#agnt_clnt_cll-POST-update-check-id__table_n3g_1fs_2pb} {#agnt_clnt_cll-POST-update-check-id__table_wvx_g2z_2pb__entry__2} | Nome | Descrição | |-|-| | Nenhum(a) | | [Tabela 129. Parâmetros de consulta] {#agnt_clnt_cll-POST-update-check-id__table_wvx_g2z_2pb} {#agnt_clnt_cll-POST-update-check-id__table_xvx_g2z_2pb__entry__2} | Nome | Descrição | |-|-| | ativo | Sinalizador que indica se a verificação de política está ativa. Valores válidos: * verdadeiro: a verificação de política está ativa. * falso: a verificação de política está inativa. {#agnt_clnt_cll-POST-update-check-id__ul_j2p_sdt_2pb} Tipo de dados: booliano | | auto_generate | Sinalizador que indica se o comando deve ser gerado automaticamente com o valor command_prefix. Valores válidos: * verdadeiro: preenche automaticamente a propriedade command com valores de parâmetro ativos. * falso: o comando não é gerado automaticamente. {#agnt_clnt_cll-POST-update-check-id__ul_myc_x2t_2pb} Tipo de dados: booliano | | check_type | Tipo de verificação que especifica a opção de monitoramento. Valores possíveis: * Descoberta: verificação que localiza ICs relacionados ao agente. * Eventos: o resultado da verificação é transformado em um evento de gestão de eventos. * Métricas: os valores do resultado da verificação são transformados em métricas. {#agnt_clnt_cll-POST-update-check-id__ul_pgd_42t_2pb} Tipo de dados: cadeia de caracteres | | comando | Comando que o Agent Client Collector executa. Parâmetro obtido de um modelo ou IC monitorado. Nota: Se auto_generate for verdadeiro, esta propriedade será preenchida automaticamente com o prefixo e os sinalizadores dos parâmetros ativos listados no objeto parameters. Tipo de dados: cadeia de caracteres | | command_prefix | Se a propriedade auto_generate for verdadeira, este comando será usado para geração automática. O prefixo consiste em qualquer parte do comando que é estática (não muda), como o nome do script. Tipo de dados: cadeia de caracteres | | event_status_change_threshold | Número de vezes consecutivas em que o status de resposta de uma verificação deve ocorrer antes que um novo evento seja enviado. Retorna nulo se não estiver definido. Por exemplo, se este valor for 3, uma verificação cujo status de resposta muda de OK para Erro gerará um novo evento com um status de Erro após a terceira ocorrência consecutiva da mudança de status. Tipo de dados: número | | event_status_repair_threshold | Número de vezes consecutivas em que o status de resposta de uma verificação deve melhorar para fechar o evento anterior. Retorna nulo se não estiver definido. Por exemplo, se este valor for 3, uma verificação cujo status de resposta muda de Erro para OK fechará o evento anterior e gerará um novo evento com um status OK após a terceira ocorrência consecutiva da mudança de status. Tipo de dados: número | | intervalo | Quantidade de tempo em segundos de espera entre execuções de verificação. Por exemplo, um valor de 60 significa que a verificação é executada a cada 60 segundos. Tipo de dados: número | | nome | Nome da verificação. Tipo de dados: cadeia de caracteres | | tempo limite | Quantidade de tempo, em segundos, após a qual a execução da verificação é interrompida quando nenhuma saída é retornada. Por exemplo, um valor de 60 significa que quando a execução de verificação não retorna um valor por 60 segundos, a execução é interrompida. Tipo de dados: cadeia de caracteres | [Tabela 130. Parâmetros do corpo da solicitação (JSON)] {#agnt_clnt_cll-POST-update-check-id__table_xvx_g2z_2pb} ### Cabeçalhos {#agnt_clnt_cll-POST-update-check-id__section_yvx_g2z_2pb} Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte [Cabeçalhos de REST API compatíveis](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles."). {#agnt_clnt_cll-POST-update-check-id__table_zvx_g2z_2pb__entry__2}{#agnt_clnt_cll-POST-update-check-id__accept-JSON-only-entry-RESTAPI} | Cabeçalho | Descrição | |-|-| | Aceitar | Formato de dados do corpo da resposta. Oferece suporte somente a application/json. | [Tabela 131. Cabeçalhos da solicitação] {#agnt_clnt_cll-POST-update-check-id__table_zvx_g2z_2pb} {#agnt_clnt_cll-POST-update-check-id__table_awx_g2z_2pb__entry__2} | Cabeçalho | Descrição | |-|-| | Nenhum(a) | | [Tabela 132. Cabeçalhos de resposta] {#agnt_clnt_cll-POST-update-check-id__table_awx_g2z_2pb} ### Códigos de status {#agnt_clnt_cll-POST-update-check-id__section_bwx_g2z_2pb} Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte [Códigos de resposta HTTP de REST API](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles."). {#agnt_clnt_cll-POST-update-check-id__table_cwx_g2z_2pb__entry__2}{#agnt_clnt_cll-POST-update-check-id__entry-200-status-code}{#agnt_clnt_cll-POST-update-check-id__agntCC-desc-403-admin}{#agnt_clnt_cll-POST-update-check-id__entry-500-status-code} | Código de status | Descrição | |-|-| | 200 | Bem-sucedido. A solicitação foi processada com sucesso. | | 403 | O usuário não tem a função agent_client_collector_admin. | | 404 | Nenhum registro encontrado com o sys_id fornecido. | | 500 | Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro. | [Tabela 133. Códigos de status] {#agnt_clnt_cll-POST-update-check-id__table_cwx_g2z_2pb} ### Parâmetros do corpo da resposta (JSON) {#agnt_clnt_cll-POST-update-check-id__section_dwx_g2z_2pb} {#agnt_clnt_cll-POST-update-check-id__table_ewx_g2z_2pb__entry__2} | Nome | Descrição | |-|-| | mensagem | Mensagem que contém resultados de sucesso ou falha da operação. Tipo de dados: cadeia de caracteres | [ ] {#agnt_clnt_cll-POST-update-check-id__table_ewx_g2z_2pb} ### Solicitação de cURL {#agnt_clnt_cll-POST-update-check-id__example_fwx_g2z_2pb} O exemplo a seguir mostra como atualizar as propriedades de mudança e reparo do evento de uma verificação de política. curl "https://instance.service-now.com/api/sn_agent/agents/update/check/" \ --request POST \ --header "Accept:application/json" \ --header "Content-Type:application/json" \ --data "{ \"event_status_change_threshold\" : \"2\", \"event_status_repair_threshold\" : \"1\" }" \ --user 'username':'password' Saída: { "message": "Operation was successful" } ## Agent Client Collector - POST /agents/update/check_def_params/{check_def_param_id} {#ariaid-title24} Habilita a mudança de um ou mais valores de campo de um parâmetro de verificação especificado. ### Formato da URL /api/sn_agent/agents/update/check_def_params/{check_def_param_id} ### Parâmetros de solicitação compatíveis {#agnt_clnt_cll-POST-up-check-def-p__entry__2} | Nome | Descrição | |-|-| | check_def_param_id | Sys_id do parâmetro de verificação listado na tabela Definições de parâmetro de verificação \[sn_agent_check_param_def\]. Tipo de dados: cadeia de caracteres | [Tabela 134. Parâmetros de caminho] {#agnt_clnt_cll-POST-up-check-def-p__entry__6} | Nome | Descrição | |-|-| | Nenhum(a) | | [Tabela 135. Parâmetros de consulta] {#agnt_clnt_cll-POST-up-check-def-p__table_fhm_klr_wqb__entry__2} | Nome | Descrição | |-|-| | ativo | Sinalizador que indica se o parâmetro de verificação está ativo. Valores válidos: * verdadeiro: o parâmetro de verificação está ativo. * falso: o parâmetro de verificação está inativo. {#agnt_clnt_cll-POST-up-check-def-p__ul_pnb_jyc_wqb} Tipo de dados: booliano | | default_value | Especifica o valor padrão para este parâmetro de verificação. Tipo de dados: cadeia de caracteres | | obrigatória | Sinalizador que indica se o parâmetro de verificação é necessário. Valores válidos: * verdadeiro: o parâmetro de verificação é necessário. * falso: o parâmetro de verificação é opcional. {#agnt_clnt_cll-POST-up-check-def-p__ul_wtg_2zc_wqb} Tipo de dados: booliano | | nome | Nome do parâmetro de verificação. Tipo de dados: cadeia de caracteres | [Tabela 136. Parâmetros do corpo da solicitação (JSON)] {#agnt_clnt_cll-POST-up-check-def-p__table_fhm_klr_wqb} Nota: Consulte o dicionário de dados para obter uma lista abrangente de campos e tipos de definição de verificação. ### Cabeçalhos Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte [Cabeçalhos de REST API compatíveis](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles."). {#agnt_clnt_cll-POST-up-check-def-p__entry__20}{#agnt_clnt_cll-POST-up-check-def-p__accept-JSON-only-entry-RESTAPI} | Cabeçalho | Descrição | |-|-| | Aceitar | Formato de dados do corpo da resposta. Oferece suporte somente a application/json. | [Tabela 137. Cabeçalhos da solicitação] {#agnt_clnt_cll-POST-up-check-def-p__entry__24} | Cabeçalho | Descrição | |-|-| | Nenhum(a) | | [Tabela 138. Cabeçalhos de resposta] ### Códigos de status Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte [Códigos de resposta HTTP de REST API](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles."). {#agnt_clnt_cll-POST-up-check-def-p__table_tfm_ykr_wqb__entry__2}{#agnt_clnt_cll-POST-up-check-def-p__entry-200-status-code} | Código de status | Descrição | |-|-| | 200 | Bem-sucedido. A solicitação foi processada com sucesso. | | 404 | O parâmetro de verificação não foi encontrado com o sys_id fornecido. | | 500 | Erro ao atualizar o parâmetro de verificação. | [Tabela 139. Códigos de status] {#agnt_clnt_cll-POST-up-check-def-p__table_tfm_ykr_wqb} ### Parâmetros do corpo da resposta (JSON) {#agnt_clnt_cll-POST-up-check-def-p__table_t3p_kmr_wqb__entry__2} | Nome | Descrição | |-|-| | Nenhum(a) | Mensagem de sucesso ou erro | [ ] {#agnt_clnt_cll-POST-up-check-def-p__table_t3p_kmr_wqb} ### Solicitação de cURL O exemplo a seguir mostra como ativar um parâmetro de verificação. curl "https://instance.service-now.com/api/sn_agent/agents/update/check_def_params/02d89bb01b307490f271ea42b24bcb63" \ --request POST \ --header "Accept:application/json" \ --header "Content-Type:application/json" \ --data "{\"active\":\"true\"}" \ --user 'username':'password' Saída: "message": "Check Definition Parameter Updated Successfully" ## Agent Client Collector - POST /agents/update/check_def_secure_params/{check_def_secure_param_id} {#ariaid-title25} Habilita a mudança de um ou mais valores de campo de um parâmetro de verificação seguro especificado. ### Formato da URL /api/sn_agent/agents/update/check_def_secure_params/{check_def_secure_param_id} ### Parâmetros de solicitação compatíveis {#agnt_clnt_cll-POST-up-check-def-sp__entry__2} | Nome | Descrição | |-|-| | check_def_secure_param_id | Sys_id do parâmetro seguro listado na tabela Verificar definições de parâmetro seguro \[sn_agent_check_secure_param_def\]. Tipo de dados: cadeia de caracteres | [Tabela 140. Parâmetros de caminho] {#agnt_clnt_cll-POST-up-check-def-sp__entry__6} | Nome | Descrição | |-|-| | Nenhum(a) | | [Tabela 141. Parâmetros de consulta] {#agnt_clnt_cll-POST-up-check-def-sp__entry__10} | Nome | Descrição | |-|-| | ativo | Sinalizador que indica se o parâmetro seguro está ativo. Valores válidos: * verdadeiro: o parâmetro de segurança está ativo. * falso: o parâmetro de segurança está inativo. {#agnt_clnt_cll-POST-up-check-def-sp__ul_g1b_3vc_wqb} Tipo de dados: booliano | | nome | Nome do parâmetro seguro. Tipo de dados: cadeia de caracteres | | pedido | Ordem na qual o parâmetro é enviado para o comando/script de verificação. Tipo de dados: cadeia de caracteres | [Tabela 142. Parâmetros do corpo da solicitação (JSON)] ### Cabeçalhos Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte [Cabeçalhos de REST API compatíveis](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles."). {#agnt_clnt_cll-POST-up-check-def-sp__entry__18}{#agnt_clnt_cll-POST-up-check-def-sp__accept-JSON-only-entry-RESTAPI} | Cabeçalho | Descrição | |-|-| | Aceitar | Formato de dados do corpo da resposta. Oferece suporte somente a application/json. | [Tabela 143. Cabeçalhos da solicitação] {#agnt_clnt_cll-POST-up-check-def-sp__entry__22} | Cabeçalho | Descrição | |-|-| | Nenhum(a) | | [Tabela 144. Cabeçalhos de resposta] ### Códigos de status Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte [Códigos de resposta HTTP de REST API](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles."). {#agnt_clnt_cll-POST-up-check-def-sp__table_rst_ykr_wqb__entry__2}{#agnt_clnt_cll-POST-up-check-def-sp__entry-200-status-code} | Código de status | Descrição | |-|-| | 200 | Bem-sucedido. A solicitação foi processada com sucesso. | | 404 | O parâmetro de verificação segura não foi encontrado com o sys_id fornecido. | | 500 | Erro ao atualizar o parâmetro de verificação de segurança. | [Tabela 145. Códigos de status] {#agnt_clnt_cll-POST-up-check-def-sp__table_rst_ykr_wqb} ### Parâmetros do corpo da resposta (JSON) {#agnt_clnt_cll-POST-up-check-def-sp__table_lfq_5kr_wqb__entry__2} | Nome | Descrição | |-|-| | Nenhum(a) | Mensagem de sucesso ou erro | [ ] {#agnt_clnt_cll-POST-up-check-def-sp__table_lfq_5kr_wqb} ### Solicitação de cURL O exemplo a seguir mostra como ativar um parâmetro de verificação segura. curl "https://instance.service-now.com/api/sn_agent/agents/update/check_def_secure_params/2d30a066dba530106f4810284b9619c1" \ --request POST \ --header "Accept:application/json" \ --header "Content-Type:application/json" \ --data "{\"active\":\"true\"}" \ --user 'username':'password' Saída: "message": "Check Definition Secure Parameter Updated Successfully" ## Agent Client Collector - POST /agents/update/check_defs/{check_def_id} {#ariaid-title26} Habilita a mudança de um ou mais valores de campo de uma definição de verificação especificada. ### Formato da URL /api/sn_agent/agents/update/check_defs/{check_def_id} ### Parâmetros de solicitação compatíveis {#agnt_clnt_cll-POST-up-check-def-cd__entry__2} | Nome | Descrição | |-|-| | check_def_id | Sys_id da definição de verificação listada na tabela Definições de verificação \[sn_agent_check_def\]. Tipo de dados: cadeia de caracteres | [Tabela 146. Parâmetros de caminho] {#agnt_clnt_cll-POST-up-check-def-cd__entry__6} | Nome | Descrição | |-|-| | Nenhum(a) | | [Tabela 147. Parâmetros de consulta] {#agnt_clnt_cll-POST-up-check-def-cd__entry__10} | Nome | Descrição | |-|-| | ativo | Indica se esta definição de verificação está ativa. Valores válidos: * 0: esta definição de verificação está inativa. * 1: esta definição de verificação está ativa. {#agnt_clnt_cll-POST-up-check-def-cd__ul_gdc_4wj_wqb} Tipo de dados: número | | Plano de fundo | Sinalizador que indica se esta definição de verificação é uma verificação em segundo plano. Uma verificação em segundo plano é uma verificação em que o agente inicia a execução e não espera que ele termine. Valores válidos: * verdadeiro: esta definição de verificação é uma verificação em segundo plano. * falso: esta definição de verificação não é uma verificação em segundo plano. {#agnt_clnt_cll-POST-up-check-def-cd__ul_ypb_5ps_5qb} Tipo de dados: booliano | | verificar_grupo | Grupo especificado para esta definição de verificação. | | check_type | Tipo de verificação. Valores possíveis: * Eventos - os resultados da verificação são transformados em um evento de gestão de eventos. * Métricas -- os valores do resultado da verificação são transformados em métricas. {#agnt_clnt_cll-POST-up-check-def-cd__ul_gtr_kfb_wqb} Tipo de dados: cadeia de caracteres | | comando | Comando que o Agent Client Collector executa. Tipo de dados: cadeia de caracteres | | nome | Nome da verificação. Tipo de dados: cadeia de caracteres | | parâms | Mapa de nomes e valores de parâmetro. Essas configurações podem ser usadas para substituir os registros de parâmetro da definição de verificação e seus valores especificados. "params": { "": "String" } Tipo de dados: objeto | | plug-ins | Lista de [Agent Client Collector plug-ins](https://www.servicenow.com/docs/access?context=acc-assets&version=xanadu&pubname=xanadu-it-operations-management&ft:locale=en-US) associado a esta verificação. Tipo de dados: matriz | | proxy_valid | Sinalizador que indica se a política de definição de verificação está definida para funcionar como um proxy. Valores válidos: * verdadeiro: esta política de definição de verificação está definida para funcionar como um proxy. * falso: esta política de definição de verificação não está definida para funcionar como um proxy. {#agnt_clnt_cll-POST-up-check-def-cd__ul_wbf_qps_5qb} Tipo de dados: booliano | | consulta | Consulta codificada para recuperar o GlideRecord da tabela especificada na propriedade table. Tipo de dados: cadeia de caracteres | | tabela | Nome da tabela cmdb_ci para esta verificação. Tipo de dados: cadeia de caracteres | | tempo limite | Tempo limite em segundos. Tipo de dados: número | [Tabela 148. Parâmetros do corpo da solicitação (JSON)] Nota: Consulte o dicionário de dados para obter uma lista abrangente de campos e tipos de definição de verificação. ### Cabeçalhos Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte [Cabeçalhos de REST API compatíveis](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles."). {#agnt_clnt_cll-POST-up-check-def-cd__entry__36}{#agnt_clnt_cll-POST-up-check-def-cd__accept-JSON-only-entry-RESTAPI} | Cabeçalho | Descrição | |-|-| | Aceitar | Formato de dados do corpo da resposta. Oferece suporte somente a application/json. | [Tabela 149. Cabeçalhos da solicitação] {#agnt_clnt_cll-POST-up-check-def-cd__entry__40} | Cabeçalho | Descrição | |-|-| | Nenhum(a) | | [Tabela 150. Cabeçalhos de resposta] ### Códigos de status Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte [Códigos de resposta HTTP de REST API](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles."). {#agnt_clnt_cll-POST-up-check-def-cd__entry__44}{#agnt_clnt_cll-POST-up-check-def-cd__entry-200-status-code} | Código de status | Descrição | |-|-| | 200 | Bem-sucedido. A solicitação foi processada com sucesso. | | 404 | A definição de verificação não foi encontrada com o sys_id fornecido. | | 500 | Erro ao atualizar a definição de verificação. | [Tabela 151. Códigos de status] ### Parâmetros do corpo da resposta (JSON) {#agnt_clnt_cll-POST-up-check-def-cd__entry__52} | Nome | Descrição | |-|-| | Nenhum(a) | Mensagem de sucesso ou erro | [ ] ### Solicitação de cURL O exemplo a seguir mostra como desativar uma definição de verificação. curl "https://instance.service-now.com/api/sn_agent/agents/update/check_defs/99e12466dba530106f4810284b961976" \ --request POST \ --header "Accept:application/json" \ --header "Content-Type:application/json" \ --data "{\"active\":\"false\"}" \ --user 'username':'password' Saída: "message": "Check Definition Updated Successfully" ## Agent Client Collector - POST /agents/update/check_param/{param_id} {#ariaid-title27} Atualiza um parâmetro de verificação de política selecionado. Para recuperar as propriedades de uma cópia da área restrita de política, use [GET /agents/policy/sandbox_from_published/{policy_id}](https://servicenow-prod.fluidtopics.net/0hS64SPtXLuUBX2LjwGOfg#agnt_clnt_cll-GET-policy-sbox-fr "Obtém a cópia da área restrita de uma política publicada e fornece detalhes da política."). ### Formato da URL /api/sn_agent/agents/update/check_param/{param_id} ### Parâmetros de solicitação compatíveis {#agnt_clnt_cll-POST-update-check_param__section_dvh_g2z_2pb} {#agnt_clnt_cll-POST-update-check_param__table_n3g_1fs_2pb__entry__2} | Nome | Descrição | |-|-| | param_id | Sys_id da cópia da área restrita do parâmetro de verificação de política na tabela Parâmetros de verificação \[sn_agent_check_param\]. Tipo de dados: cadeia de caracteres | [Tabela 152. Parâmetros de caminho] {#agnt_clnt_cll-POST-update-check_param__table_n3g_1fs_2pb} {#agnt_clnt_cll-POST-update-check_param__table_evh_g2z_2pb__entry__2} | Nome | Descrição | |-|-| | Nenhum(a) | | [Tabela 153. Parâmetros de consulta] {#agnt_clnt_cll-POST-update-check_param__table_evh_g2z_2pb} {#agnt_clnt_cll-POST-update-check_param__table_fvh_g2z_2pb__entry__2} | Nome | Descrição | |-|-| | ativo | Sinalizador que indica se o parâmetro de verificação está ativo. Valores válidos: * verdadeiro: verificar se o parâmetro está ativo. * falso: o parâmetro de verificação está inativo. {#agnt_clnt_cll-POST-update-check_param__ul_u2x_5fv_2pb} Tipo de dados: booliano | | sinalizador | | | obrigatória | Sinalizador que indica se esta verificação é obrigatória. Valores válidos: * verdadeiro: esta verificação é obrigatória. * falso: esta verificação é opcional. {#agnt_clnt_cll-POST-update-check_param__ul_flq_qkv_2pb} Tipo de dados: booliano | | nome | Nome do parâmetro. Tipo de dados: cadeia de caracteres | | valor | Valor do parâmetro. Tipo de dados: cadeia de caracteres | | valor_necessário | Sinalizador que indica se as informações fornecidas pela propriedade de valor são necessárias. Valores válidos: * verdadeiro: a propriedade de valor é obrigatória. * falso: a propriedade de valor é nula ou não é necessária. {#agnt_clnt_cll-POST-update-check_param__ul_ug3_3jv_2pb} Tipo de dados: booliano | [Tabela 154. Parâmetros do corpo da solicitação (JSON)] {#agnt_clnt_cll-POST-update-check_param__table_fvh_g2z_2pb} ### Cabeçalhos {#agnt_clnt_cll-POST-update-check_param__section_gvh_g2z_2pb} Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte [Cabeçalhos de REST API compatíveis](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles."). {#agnt_clnt_cll-POST-update-check_param__table_hvh_g2z_2pb__entry__2}{#agnt_clnt_cll-POST-update-check_param__accept-JSON-only-entry-RESTAPI} | Cabeçalho | Descrição | |-|-| | Aceitar | Formato de dados do corpo da resposta. Oferece suporte somente a application/json. | [Tabela 155. Cabeçalhos da solicitação] {#agnt_clnt_cll-POST-update-check_param__table_hvh_g2z_2pb} {#agnt_clnt_cll-POST-update-check_param__table_ivh_g2z_2pb__entry__2} | Cabeçalho | Descrição | |-|-| | Nenhum(a) | | [Tabela 156. Cabeçalhos de resposta] {#agnt_clnt_cll-POST-update-check_param__table_ivh_g2z_2pb} ### Códigos de status {#agnt_clnt_cll-POST-update-check_param__section_jvh_g2z_2pb} Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte [Códigos de resposta HTTP de REST API](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles."). {#agnt_clnt_cll-POST-update-check_param__table_kvh_g2z_2pb__entry__2}{#agnt_clnt_cll-POST-update-check_param__entry-200-status-code}{#agnt_clnt_cll-POST-update-check_param__agntCC-desc-403-admin}{#agnt_clnt_cll-POST-update-check_param__entry-500-status-code} | Código de status | Descrição | |-|-| | 200 | Bem-sucedido. A solicitação foi processada com sucesso. | | 403 | O usuário não tem a função agent_client_collector_admin. | | 404 | Nenhum registro encontrado com o sys_id fornecido. | | 500 | Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro. | [Tabela 157. Códigos de status] {#agnt_clnt_cll-POST-update-check_param__table_kvh_g2z_2pb} ### Parâmetros do corpo da resposta (JSON) {#agnt_clnt_cll-POST-update-check_param__section_lvh_g2z_2pb} {#agnt_clnt_cll-POST-update-check_param__table_mvh_g2z_2pb__entry__2} | Nome | Descrição | |-|-| | mensagem | Mensagem que contém resultados de sucesso ou falha da operação. Tipo de dados: cadeia de caracteres | [ ] {#agnt_clnt_cll-POST-update-check_param__table_mvh_g2z_2pb} ### Solicitação de cURL {#agnt_clnt_cll-POST-update-check_param__example_nvh_g2z_2pb} O exemplo a seguir mostra como atualizar várias propriedades de um parâmetro de verificação de política. curl "https://instance.service-now.com/api/sn_agent/agents/update/check_param/" \ --request POST \ --header "Accept:application/json" \ --header "Content-Type:application/json" \ --data "{ \"flag\" : \"-d\", \"mandatory\" : \"true\", \"name\" : \"scheme2\", \"value\" : \"120\", \"value_required\" : \"false\" }" \ --user 'username':'password' Saída: { "message": "Operation was successful" } ## Agent Client Collector - POST /agents/update/check_secure_param/{param_id} {#ariaid-title28} Atualiza um parâmetro seguro de verificação de política selecionado. Para recuperar as propriedades de uma cópia da área restrita de política, use [GET /agents/policy/sandbox_from_published/{policy_id}](https://servicenow-prod.fluidtopics.net/0hS64SPtXLuUBX2LjwGOfg#agnt_clnt_cll-GET-policy-sbox-fr "Obtém a cópia da área restrita de uma política publicada e fornece detalhes da política."). ### Formato da URL /api/sn_agent/agents/update/check_secure_param/{param_id} ### Parâmetros de solicitação compatíveis {#agnt_clnt_cll-POST-update-check_secure__section_dzx_f2z_2pb} {#agnt_clnt_cll-POST-update-check_secure__table_n3g_1fs_2pb__entry__2} | Nome | Descrição | |-|-| | param_id | Sys_id da cópia da área restrita do parâmetro seguro de verificação de política na tabela Verificar parâmetro seguro \[sn_agent_check_secure_param\]. Tipo de dados: cadeia de caracteres | [Tabela 158. Parâmetros de caminho] {#agnt_clnt_cll-POST-update-check_secure__table_n3g_1fs_2pb} {#agnt_clnt_cll-POST-update-check_secure__table_ezx_f2z_2pb__entry__2} | Nome | Descrição | |-|-| | Nenhum(a) | | [Tabela 159. Parâmetros de consulta] {#agnt_clnt_cll-POST-update-check_secure__table_ezx_f2z_2pb} {#agnt_clnt_cll-POST-update-check_secure__table_fzx_f2z_2pb__entry__2} | Nome | Descrição | |-|-| | ativo | Sinalizador que indica se o parâmetro de verificação de segurança está ativo. Valores válidos: * verdadeiro: o parâmetro de verificação de segurança está ativo. * falso: o parâmetro de verificação de segurança está inativo. {#agnt_clnt_cll-POST-update-check_secure__ul_xwy_vfv_2pb} Tipo de dados: booliano | | nome | Nome do parâmetro seguro. Tipo de dados: cadeia de caracteres | | pedido | Ordem na qual o parâmetro é enviado para o comando/script de verificação. Tipo de dados: número | [Tabela 160. Parâmetros do corpo da solicitação (JSON)] {#agnt_clnt_cll-POST-update-check_secure__table_fzx_f2z_2pb} ### Cabeçalhos {#agnt_clnt_cll-POST-update-check_secure__section_gzx_f2z_2pb} Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte [Cabeçalhos de REST API compatíveis](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles."). {#agnt_clnt_cll-POST-update-check_secure__table_hzx_f2z_2pb__entry__2}{#agnt_clnt_cll-POST-update-check_secure__accept-JSON-only-entry-RESTAPI} | Cabeçalho | Descrição | |-|-| | Aceitar | Formato de dados do corpo da resposta. Oferece suporte somente a application/json. | [Tabela 161. Cabeçalhos da solicitação] {#agnt_clnt_cll-POST-update-check_secure__table_hzx_f2z_2pb} {#agnt_clnt_cll-POST-update-check_secure__table_izx_f2z_2pb__entry__2} | Cabeçalho | Descrição | |-|-| | Nenhum(a) | | [Tabela 162. Cabeçalhos de resposta] {#agnt_clnt_cll-POST-update-check_secure__table_izx_f2z_2pb} ### Códigos de status {#agnt_clnt_cll-POST-update-check_secure__section_jzx_f2z_2pb} Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte [Códigos de resposta HTTP de REST API](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles."). {#agnt_clnt_cll-POST-update-check_secure__table_kzx_f2z_2pb__entry__2}{#agnt_clnt_cll-POST-update-check_secure__entry-200-status-code}{#agnt_clnt_cll-POST-update-check_secure__agntCC-desc-403-admin}{#agnt_clnt_cll-POST-update-check_secure__entry-500-status-code} | Código de status | Descrição | |-|-| | 200 | Bem-sucedido. A solicitação foi processada com sucesso. | | 403 | O usuário não tem a função agent_client_collector_admin. | | 404 | Nenhum registro encontrado com o sys_id fornecido. | | 500 | Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro. | [Tabela 163. Códigos de status] {#agnt_clnt_cll-POST-update-check_secure__table_kzx_f2z_2pb} ### Parâmetros do corpo da resposta (JSON) {#agnt_clnt_cll-POST-update-check_secure__section_lzx_f2z_2pb} {#agnt_clnt_cll-POST-update-check_secure__table_mzx_f2z_2pb__entry__2} | Nome | Descrição | |-|-| | mensagem | Mensagem que contém resultados de sucesso ou falha da operação. Tipo de dados: cadeia de caracteres | [ ] {#agnt_clnt_cll-POST-update-check_secure__table_mzx_f2z_2pb} ### Solicitação de cURL {#agnt_clnt_cll-POST-update-check_secure__example_nzx_f2z_2pb} O exemplo a seguir mostra como atualizar as propriedades de um parâmetro seguro de verificação de política. curl "https://instance.service-now.com/api/sn_agent/agents/update/check_secure_param/" \ --request POST \ --header "Accept:application/json" \ --header "Content-Type:application/json" \ --data "{ \"name\" : \"new name\", \"order\" : \"2\" }" \ --user 'username':'password' Saída: { "message": "Operation was successful" } ## Agent Client Collector - POST /agents/update/policy/{policy_id} {#ariaid-title29} Atualiza uma cópia da área restrita de uma política. Para recuperar as propriedades de uma cópia da área restrita de política, use [GET /agents/policy/sandbox_from_published/{policy_id}](https://servicenow-prod.fluidtopics.net/0hS64SPtXLuUBX2LjwGOfg#agnt_clnt_cll-GET-policy-sbox-fr "Obtém a cópia da área restrita de uma política publicada e fornece detalhes da política."). ### Formato da URL /api/sn_agent/agents/update/policy/{policy_id} ### Parâmetros de solicitação compatíveis {#agnt_clnt_cll-POST-update-policy__table_n3g_1fs_2pb__entry__2} | Nome | Descrição | |-|-| | policy_id | Sys_id de uma cópia da área restrita de política na tabela Políticas \[sn_agent_policy\]. Tipo de dados: cadeia de caracteres | [Tabela 164. Parâmetros de caminho] {#agnt_clnt_cll-POST-update-policy__table_n3g_1fs_2pb} {#agnt_clnt_cll-POST-update-policy__entry__6} | Nome | Descrição | |-|-| | Nenhum(a) | | [Tabela 165. Parâmetros de consulta] {#agnt_clnt_cll-POST-update-policy__entry__10} | Nome | Descrição | |-|-| | alias_cred | Nome listado na tabela Credenciais \[discovery_credentials\]. Tipo de dados: cadeia de caracteres | | credential_alias | Sys_id do alias de credencial na tabela Aliases de conexão e credencial \[sys_alias\]. Tipo de dados: cadeia de caracteres | | filtros | Filtro que restringe as verificações da política para monitorar somente os critérios especificados. Tipo de dados: cadeia de caracteres | | intervalo | Quantidade de tempo em segundos de espera entre verificações de política. Por exemplo, um valor de 60 significa que a verificação é executada a cada 60 segundos. Nota: O valor da propriedade checks.interval substitui o valor configurado neste campo. Tipo de dados: número | | monitor_ci_group | Nome dos [grupos do CMDB](https://www.servicenow.com/docs/access?context=cmdb-groups&version=xanadu&pubname=xanadu-servicenow-platform&ft:locale=en-US) associados à política. Este CMDB está listado na tabela Grupos do CMDB \[cmdb_group\]. Este campo só será aplicado se o valor da propriedade monitored_ci_type_group for verdadeiro. Tipo de dados: cadeia de caracteres | | script_ci_monitorado | Script para monitoramento de ICs. Este campo só será aplicado se o valor da propriedade policies.monitored_ci_type_script for verdadeiro. Tipo de dados: cadeia de caracteres | | monitorado_ci_type_filter | Sinalizador que indica se a filtragem por tipo de IC está habilitada. O tipo de IC está listado na propriedade table. Valores válidos: * verdadeiro: a filtragem por grupo de verificações está habilitada. * falso: a filtragem por grupo de verificações está desabilitada. {#agnt_clnt_cll-POST-update-policy__ul_tvm_fvt_2pb} Tipo de dados: booliano | | monitorado_ci_type_group | Sinalizador que indica se o monitoramento por tipo de grupo do CMDB está habilitado. Valores válidos: * verdadeiro: o tipo de grupo do CMDB está habilitado. * falso: o tipo de grupo do CMDB está desabilitado. {#agnt_clnt_cll-POST-update-policy__ul_jrc_fvt_2pb} Tipo de dados: booliano | | monitorado_ci_type_script | Sinalizador que indica se o script para monitoramento de ICs está habilitado. Valores válidos: * verdadeiro: o script para monitoramento de ICs está habilitado. * falso: o script para monitoramento de ICs está desabilitado. {#agnt_clnt_cll-POST-update-policy__ul_bs4_3wt_2pb} Tipo de dados: booliano | | nome | Nome da política. Tipo de dados: cadeia de caracteres | | tabela | Campo de tipo de IC monitorado na política. Este campo só será aplicado se monitored_ci_type_filter for verdadeiro. Tipo de dados: cadeia de caracteres | [Tabela 166. Parâmetros do corpo da solicitação (JSON)] ### Cabeçalhos Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte [Cabeçalhos de REST API compatíveis](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles."). {#agnt_clnt_cll-POST-update-policy__entry__34}{#agnt_clnt_cll-POST-update-policy__accept-JSON-only-entry-RESTAPI} | Cabeçalho | Descrição | |-|-| | Aceitar | Formato de dados do corpo da resposta. Oferece suporte somente a application/json. | [Tabela 167. Cabeçalhos da solicitação] {#agnt_clnt_cll-POST-update-policy__entry__38} | Cabeçalho | Descrição | |-|-| | Nenhum(a) | | [Tabela 168. Cabeçalhos de resposta] ### Códigos de status Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte [Códigos de resposta HTTP de REST API](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles."). {#agnt_clnt_cll-POST-update-policy__entry__42}{#agnt_clnt_cll-POST-update-policy__entry-200-status-code}{#agnt_clnt_cll-POST-update-policy__agntCC-desc-403-admin}{#agnt_clnt_cll-POST-update-policy__entry-500-status-code} | Código de status | Descrição | |-|-| | 200 | Bem-sucedido. A solicitação foi processada com sucesso. | | 403 | O usuário não tem a função agent_client_collector_admin. | | 404 | Nenhum registro encontrado com o sys_id fornecido. | | 500 | Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro. | [Tabela 169. Códigos de status] ### Parâmetros do corpo da resposta (JSON) {#agnt_clnt_cll-POST-update-policy__entry__52} | Nome | Descrição | |-|-| | mensagem | Mensagem que contém resultados de sucesso ou falha da operação. Tipo de dados: cadeia de caracteres | [ ] ### Solicitação de cURL O exemplo a seguir mostra como atualizar o nome e as propriedades/campos de uma política. curl "https://instance.service-now.com/api/sn_agent/agents/update/policy/" \--request POST \ --header "Accept:application/json" \ --header "Content-Type:application/json" \ --data "{ \"name\" : \"new policy name\", \"filter\" : \"operational_status=1\" }" \ --user 'username':'password' Saída: { "message": "Operation was successful" }