API Agent Client Collector

  • Versão de lançamento: Yokohama
  • Atualizado 30 de jan. de 2025
  • 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.
    Endpoints de gestão de agentes

    Para obter informações sobre como executar tarefas semelhantes em uma inclusão de script, consulte AccAgentsAPI.

    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. 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}. Use os sys_ids desta resposta para modificar propriedades usando um endpoint de atualização.
    2. Modifique os detalhes da política usando um endpoint de atualização.
    3. Publique a política usando GET /agents/policy/publish/{policy_id}.
    Depois de publicada, a política se torna Ativa. Esta API também inclui endpoints para ativar ou desativar uma política publicada:

    Agent Client Collector - GET /agents/{agent_id}

    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

    Tabela 1. Parâmetros de caminho
    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 2. Parâmetros de consulta
    Nome Descrição
    Nenhum(a)
    Tabela 3. Parâmetros do corpo da solicitação (JSON)
    Nome Descrição
    Nenhum(a)

    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.

    Tabela 4. Cabeçalhos da solicitação
    Cabeçalho Descrição
    Aceitar Formato de dados do corpo da resposta. Oferece suporte somente a application/json.
    Tabela 5. Cabeçalhos de resposta
    Cabeçalho Descrição
    Nenhum(a)

    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.

    Tabela 6. Códigos de status
    Código do 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.

    Parâmetros do corpo da resposta (JSON)

    Nome Descrição
    <Array> 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

    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.

    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.

    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.

    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.

    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/<agent_id>" \
--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

    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

    /api/sn_agent/agents/{agent_id}/data/off

    Parâmetros de solicitação compatíveis

    Tabela 7. Parâmetros de caminho
    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 8. Parâmetros de consulta
    Nome Descrição
    Nenhum(a)
    Tabela 9. Parâmetros do corpo da solicitação (JSON)
    Nome Descrição
    Nenhum(a)

    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.

    Tabela 10. Cabeçalhos da solicitação
    Cabeçalho Descrição
    Aceitar Formato de dados do corpo da resposta. Oferece suporte somente a application/json.
    Tabela 11. Cabeçalhos de resposta
    Cabeçalho Descrição
    Nenhum(a)

    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.

    Tabela 12. Códigos de status
    Código do 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.

    Parâmetros do corpo da resposta (JSON)

    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 desativar a coleta de dados do agente.

    curl "https://instance.service-now.com/api/sn_agent/agents/<agent_id>/data/off" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

    Saída:

    {
"message": "Data Collection Disabled For Agent With ID: <agent_id>"
}

    Agent Client Collector - GET /agents/{agent_id}/data/on

    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

    /api/sn_agent/agents/{agent_id}/data/on

    Parâmetros de solicitação compatíveis

    Tabela 13. Parâmetros de caminho
    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 14. Parâmetros de consulta
    Nome Descrição
    Nenhum(a)
    Tabela 15. Parâmetros do corpo da solicitação (JSON)
    Nome Descrição
    Nenhum(a)

    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.

    Tabela 16. Cabeçalhos da solicitação
    Cabeçalho Descrição
    Aceitar Formato de dados do corpo da resposta. Oferece suporte somente a application/json.
    Tabela 17. Cabeçalhos de resposta
    Cabeçalho Descrição
    Nenhum(a)

    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.

    Tabela 18. Códigos de status
    Código do 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.

    Parâmetros do corpo da resposta (JSON)

    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 ativar a coleta de dados do agente.

    curl "https://instance.service-now.com/api/sn_agent/agents/<agent_id>/data/on" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

    Saída:

    {
  "message": "Data Collection Enabled For Agent With ID: <agent_id>"
}

    Agent Client Collector - GET /agents/{agent_id}/discovery

    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

    Tabela 19. Parâmetros de caminho
    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 20. Parâmetros de consulta
    Nome Descrição
    Nenhum(a)
    Tabela 21. Parâmetros do corpo da solicitação (JSON)
    Nome Descrição
    Nenhum(a)

    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.

    Tabela 22. Cabeçalhos da solicitação
    Cabeçalho Descrição
    Aceitar Formato de dados do corpo da resposta. Oferece suporte somente a application/json.
    Tabela 23. Cabeçalhos de resposta
    Cabeçalho Descrição
    Nenhum(a)

    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.

    Tabela 24. Códigos de status
    Código do 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.

    Parâmetros do corpo da resposta (JSON)

    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 executar a descoberta em um agente com status ativo/ativo.

    curl "https://instance.service-now.com/api/sn_agent/agents/<agent_id>/discovery" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

    Saída:

    {
  "message": "Running Discovery For Agent With ID: <agent_id>"
}

    Agent Client Collector - GET /agents/check_defs/{check_def_id}

    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

    Tabela 25. Parâmetros de caminho
    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 26. Parâmetros de consulta
    Nome Descrição
    Nenhum(a)
    Tabela 27. Parâmetros do corpo da solicitação (JSON)
    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.

    Tipo de dados: booliano

    Padrão: falso

    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.

    Tabela 28. Cabeçalhos da solicitação
    Cabeçalho Descrição
    Aceitar Formato de dados do corpo da resposta. Oferece suporte somente a application/json.
    Tabela 29. Cabeçalhos de resposta
    Cabeçalho Descrição
    Nenhum(a)

    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.

    Tabela 30. Códigos de status
    Código do 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.

    Parâmetros do corpo da resposta (JSON)

    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.

    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.

    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"
   }
]

    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.

    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 é obrigatório.
    • falso: o parâmetro de verificação é opcional.

    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 Agent Client Collector plug-ins 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.

    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"
   }
]

    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.

    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
    timeout 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

    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

    Tabela 31. Parâmetros de caminho
    Nome Descrição
    Nenhum(a)
    Tabela 32. Parâmetros de consulta
    Nome Descrição
    Nenhum(a)
    Tabela 33. Parâmetros do corpo da solicitação (JSON)
    Nome Descrição
    X-Enc-Query Uma cadeia de caracteres de consulta codificada 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.

    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

    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.

    Tabela 34. Cabeçalhos da solicitação
    Cabeçalho Descrição
    Aceitar Formato de dados do corpo da resposta. Oferece suporte somente a application/json.
    Tabela 35. Cabeçalhos de resposta
    Cabeçalho Descrição
    Nenhum(a)

    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.

    Tabela 36. Códigos de status
    Código do status Descrição
    200 Bem-sucedido. A solicitação foi processada com sucesso.

    Parâmetros do corpo da resposta (JSON)

    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.

    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.

    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"
   }
]

    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.

    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 é obrigatório.
    • falso: o parâmetro de verificação é opcional.

    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 Agent Client Collector plug-ins 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.

    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"
   }
]

    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.

    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
    timeout 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}

    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

    Tabela 37. Parâmetros de caminho
    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 38. Parâmetros de consulta
    Nome Descrição
    Nenhum(a)
    Tabela 39. Parâmetros do corpo da solicitação (JSON)
    Nome Descrição
    Nenhum(a)

    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.

    Tabela 40. Cabeçalhos da solicitação
    Cabeçalho Descrição
    Aceitar Formato de dados do corpo da resposta. Oferece suporte somente a application/json.
    Tabela 41. Cabeçalhos de resposta
    Cabeçalho Descrição
    Nenhum(a)

    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.

    Tabela 42. Códigos de status
    Código do 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.

    Parâmetros do corpo da resposta (JSON)

    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}

    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

    Tabela 43. Parâmetros de caminho
    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 44. Parâmetros de consulta
    Nome Descrição
    Nenhum(a)
    Tabela 45. Parâmetros do corpo da solicitação (JSON)
    Nome Descrição
    Nenhum(a)

    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.

    Tabela 46. Cabeçalhos da solicitação
    Cabeçalho Descrição
    Aceitar Formato de dados do corpo da resposta. Oferece suporte somente a application/json.
    Tabela 47. Cabeçalhos de resposta
    Cabeçalho Descrição
    Nenhum(a)

    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.

    Tabela 48. Códigos de status
    Código do 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.

    Parâmetros do corpo da resposta (JSON)

    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().

    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.

    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}

    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

    Tabela 49. Parâmetros de caminho
    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 50. Parâmetros de consulta
    Nome Descrição
    Nenhum(a)
    Tabela 51. Parâmetros do corpo da solicitação (JSON)
    Nome Descrição
    Nenhum(a)

    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.

    Tabela 52. Cabeçalhos da solicitação
    Cabeçalho Descrição
    Aceitar Formato de dados do corpo da resposta. Oferece suporte somente a application/json.
    Tabela 53. Cabeçalhos de resposta
    Cabeçalho Descrição
    Nenhum(a)

    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.

    Tabela 54. Códigos de status
    Código do 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.

    Parâmetros do corpo da resposta (JSON)

    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

    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

    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

    Tabela 55. Parâmetros de caminho
    Nome Descrição
    Nenhum(a)
    Tabela 56. Parâmetros de consulta
    Nome Descrição
    Nenhum(a)
    Tabela 57. Parâmetros do corpo da solicitação (JSON)
    Nome Descrição
    Nenhum(a)

    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.

    Tabela 58. Cabeçalhos da solicitação
    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.
    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 59. Cabeçalhos de resposta
    Cabeçalho Descrição
    Nenhum(a)

    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.

    Tabela 60. Códigos de status
    Código do 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.

    Parâmetros do corpo da resposta (JSON)

    Propriedade Descrição
    <Array> 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

    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.

    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.

    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.

    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.

    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

    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

    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

    /api/sn_agent/agents/{agent_id}/log

    Parâmetros de solicitação compatíveis

    Tabela 61. Parâmetros de caminho
    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 62. Parâmetros de consulta
    Nome Descrição
    Nenhum(a)
    Tabela 63. Parâmetros do corpo da solicitação (JSON)
    Nome Descrição
    Nenhum(a)

    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.

    Tabela 64. Cabeçalhos da solicitação
    Cabeçalho Descrição
    Aceitar Formato de dados do corpo da resposta. Oferece suporte somente a application/json.
    Tabela 65. Cabeçalhos de resposta
    Cabeçalho Descrição
    Nenhum(a)

    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.

    Tabela 66. Códigos de status
    Código do 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.

    Parâmetros do corpo da resposta (JSON)

    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

    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/<sys_id>/log" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

    Saída:

    "request_id": "<sys_id>"

    Agent Client Collector - GET /agents/log/{request_id}/

    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

    Tabela 67. Parâmetros de caminho
    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 68. Parâmetros de consulta
    Nome Descrição
    Nenhum(a)
    Tabela 69. Parâmetros do corpo da solicitação (JSON)
    Nome Descrição
    Nenhum(a)

    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.

    Tabela 70. Cabeçalhos da solicitação
    Cabeçalho Descrição
    Aceitar Formato de dados do corpo da resposta. Oferece suporte somente a application/json.
    Tabela 71. Cabeçalhos de resposta
    Cabeçalho Descrição
    Nenhum(a)

    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.

    Tabela 72. Códigos de status
    Código do 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.

    Parâmetros do corpo da resposta (JSON)

    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_ID>" \
--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

    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

    Tabela 73. Parâmetros de caminho
    Nome Descrição
    Nenhum(a)
    Tabela 74. Parâmetros de consulta
    Nome Descrição
    Nenhum(a)
    Tabela 75. Parâmetros do corpo da solicitação (JSON)
    Nome Descrição
    Nenhum(a)

    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.

    Tabela 76. Cabeçalhos da solicitação
    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.
    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.

    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.

    Padrão: falso

    Tipo de dados: booliano
    Tabela 77. Cabeçalhos de resposta
    Cabeçalho Descrição
    Nenhum(a)

    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.

    Tabela 78. Códigos de status
    Código do 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.

    Parâmetros do corpo da resposta (JSON)

    Tabela 79. Objeto
    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.
    {
  "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.

    Tipo de dados: booliano
    políticas.agente_ids ID exclusivo de um agente. 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}.

    Tipo de dados: cadeia de caracteres

    Tabela: na coluna ID do agente da tabela Agent Client Collectors [sn_agent_cmdb_ci_agent].
    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"
   }
]

    "Table" (Tabela):
    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.

    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.

    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.

    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.

    Tipo de dados: cadeia de caracteres

    Tabela: verificar instâncias [sn_agent_check]
    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 da credencial.

    Tipo de dados: cadeia de caracteres

    Tabela: credenciais [discovery_credentials]
    políticas.credential_alias Sys_id do alias de credencial.

    Tipo de dados: cadeia de caracteres

    Tabela: aliases de conexão e credencial [sys_alias]
    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 associados à política.

    Este campo só será aplicado se o valor da propriedade monitored_ci_type_group for verdadeiro.

    Tipo de dados: cadeia de caracteres

    Tabela: Grupos do CMDB [cmdb_group]
    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.

    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.

    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.

    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.

    Tipo de dados: cadeia de caracteres
    políticas.sys_id Sys_id da política.

    Tipo de dados: cadeia de caracteres

    Tabela: Políticas [sn_agent_policy]
    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. 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
  }
]

    Tabela: verificar parâmetros [sn_agent_check_param]
    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.

    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.

    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.

    Tipo de dados: cadeia de caracteres

    Tabela: verificar parâmetros [sn_agent_check_param]
    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.

    Tipo de dados: booliano
    políticas.parâmetros_seguros Lista de objetos que contém informações de parâmetros seguros de verificação. Para obter mais informações, consulte Criação de um parâmetro seguro para uma verificação. 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"
   }
]

    Tabela: verificar parâmetros seguros [sn_agent_check_secure_param]
    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.

    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.

    Tipo de dados: cadeia de caracteres

    Tabela: Parâmetro de verificação de segurança [sn_agent_check_secure_param]

    Solicitação de cURL

    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}

    Ativa uma política publicada.

    Para obter uma lista de políticas publicadas, use GET /agents/policies/list. 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

    Tabela 80. Parâmetros de caminho
    Nome Descrição
    policy_id Sys_id da política publicada.

    Tipo de dados: cadeia de caracteres

    Tabela: Políticas [sn_agent_policy]
    Tabela 81. Parâmetros de consulta
    Nome Descrição
    Nenhum(a)
    Tabela 82. Parâmetros do corpo da solicitação (JSON)
    Nome Descrição
    Nenhum(a)

    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.

    Tabela 83. Cabeçalhos da solicitação
    Cabeçalho Descrição
    Aceitar Formato de dados do corpo da resposta. Oferece suporte somente a application/json.
    Tabela 84. Cabeçalhos de resposta
    Cabeçalho Descrição
    Nenhum(a)

    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.

    Tabela 85. Códigos de status
    Código do 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.

    Parâmetros do corpo da resposta (JSON)

    Cabeçalho 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 ativar uma política.

    curl "https://instance.service-now.com/api/sn_agent/agents/policy/activate/<sys_id>" \
--request GET \
--header "Accept:application/json" \
--user 'username' : 'password'

    Saída:

    {
  "message": "Operation was successful"
}

    Agent Client Collector - GET /agents/policy/deactivate/{policy_id}

    Desativa uma política publicada.

    Para obter uma lista de políticas publicadas, use GET /agents/policies/list. 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

    Tabela 86. Parâmetros de caminho
    Nome Descrição
    policy_id Sys_id da política publicada.

    Tipo de dados: cadeia de caracteres

    Tabela: Políticas [sn_agent_policy]
    Tabela 87. Parâmetros de consulta
    Nome Descrição
    Nenhum(a)
    Tabela 88. Parâmetros do corpo da solicitação (JSON)
    Nome Descrição
    Nenhum(a)

    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.

    Tabela 89. Cabeçalhos da solicitação
    Cabeçalho Descrição
    Aceitar Formato de dados do corpo da resposta. Oferece suporte somente a application/json.
    Tabela 90. Cabeçalhos de resposta
    Cabeçalho Descrição
    Nenhum(a)

    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.

    Tabela 91. Códigos de status
    Código do 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.

    Parâmetros do corpo da resposta (JSON)

    Cabeçalho 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 desativar uma política.

    curl "https://instance.service-now.com/api/sn_agent/agents/policy/deactivate/<sys_id>" \
--request GET \
--header "Accept:application/json" \
--user 'username' : 'password'

    Saída:

    {
  "message": "Operation was successful"
}

    Agent Client Collector - GET /agents/policy/publish/{policy_id}

    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:

    Formato da URL

    /api/sn_agent/agents/policy/publish/{policy_id}

    Parâmetros de solicitação compatíveis

    Tabela 92. Parâmetros de caminho
    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.

    Tipo de dados: cadeia de caracteres
    Tabela 93. Parâmetros de consulta
    Nome Descrição
    Nenhum(a)
    Tabela 94. Parâmetros do corpo da solicitação (JSON)
    Nome Descrição
    Nenhum(a)

    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.

    Tabela 95. Cabeçalhos da solicitação
    Cabeçalho Descrição
    Aceitar Formato de dados do corpo da resposta. Oferece suporte somente a application/json.
    Tabela 96. Cabeçalhos de resposta
    Cabeçalho Descrição
    Nenhum(a)

    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.

    Tabela 97. Códigos de status
    Código do 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.

    Parâmetros do corpo da resposta (JSON)

    Cabeçalho 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 publicar uma política.

    curl "https://instance.service-now.com/api/sn_agent/agents/policy/publish/<sys_id>" \
--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}

    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:

    Para obter uma lista de políticas publicadas, use GET /agents/policies/list. 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

    Tabela 98. Parâmetros de caminho
    Nome Descrição
    policy_id Sys_id da política publicada.

    Tipo de dados: cadeia de caracteres

    Tabela: Políticas [sn_agent_policy]
    Tabela 99. Parâmetros de consulta
    Nome Descrição
    Nenhum(a)
    Tabela 100. Parâmetros do corpo da solicitação (JSON)
    Nome Descrição
    Nenhum(a)

    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.

    Tabela 101. Cabeçalhos da solicitação
    Cabeçalho Descrição
    Aceitar Formato de dados do corpo da resposta. Oferece suporte somente a application/json.
    Tabela 102. Cabeçalhos de resposta
    Cabeçalho Descrição
    Nenhum(a)

    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.

    Tabela 103. Códigos de status
    Código do 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.

    Parâmetros do corpo da resposta (JSON)

    Propriedade Descrição
    <Object> 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.
    {
  "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.

    Tipo de dados: booliano
    agent_ids ID exclusivo de um agente. 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}.

    Tipo de dados: cadeia de caracteres

    Tabela: na coluna ID do agente da tabela Agent Client Collectors [sn_agent_cmdb_ci_agent].
    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.

    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.

    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.

    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. O endpoint POST /agents/update/check/{check_id} usa este valor para atualizar a cópia da área restrita.

    Tipo de dados: cadeia de caracteres

    Tabela: verificar instâncias [sn_agent_check]
    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 da credencial.

    Tipo de dados: cadeia de caracteres

    Tabela: credenciais [discovery_credentials]
    credential_alias Sys_id do alias de credencial.

    Tipo de dados: cadeia de caracteres

    Tabela: aliases de conexão e credencial [sys_alias]
    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 associados à política.

    Este campo só será aplicado se o valor da propriedade monitored_ci_type_group for verdadeiro.

    Tipo de dados: cadeia de caracteres

    Tabela: Grupos do CMDB [cmdb_group]
    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.

    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.

    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.

    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.

    Tipo de dados: cadeia de caracteres
    parâms Lista de objetos que contém informações de parâmetros de verificação. 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
  }
]

    Tabela: verificar parâmetros [sn_agent_check_param]
    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.

    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órios Sinalizador que indica se esta verificação é obrigatória.
    Valores válidos:
    • verdadeiro: esta verificação é obrigatória.
    • falso: esta verificação é opcional.

    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} 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.

    Tipo de dados: booliano
    parâmetros_seguros Lista de objetos que contém informações de parâmetros seguros de verificação. Para obter mais informações, consulte Criação de um parâmetro seguro para uma verificação. 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"
   }
]

    Tabela: verificar parâmetros seguros [sn_agent_check_secure_param]
    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.

    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. O endpoint POST /agents/update/check_secure_param/{param_id} usa este valor para atualizar a cópia da área restrita.

    Tipo de dados: cadeia de caracteres

    Tabela: Parâmetro de verificação de segurança [sn_agent_check_secure_param]
    sys_id Sys_id da política. O endpoint POST /agents/update/policy/{policy_id} usa este valor para atualizar a cópia da área restrita.

    Tipo de dados: cadeia de caracteres

    Tabela: Políticas [sn_agent_policy]
    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/<sys_id>" \
--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

    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

    Formato da URL

    /api/sn_agent/agents/{agent_id}/restart

    Parâmetros de solicitação compatíveis

    Tabela 104. Parâmetros de caminho
    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 105. Parâmetros de consulta
    Nome Descrição
    Nenhum(a)
    Tabela 106. Parâmetros do corpo da solicitação (JSON)
    Nome Descrição
    Nenhum(a)

    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.

    Tabela 107. Cabeçalhos da solicitação
    Cabeçalho Descrição
    Aceitar Formato de dados do corpo da resposta. Oferece suporte somente a application/json.
    Tabela 108. Cabeçalhos de resposta
    Cabeçalho Descrição
    Nenhum(a)

    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.

    Tabela 109. Códigos de status
    Código do 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.

    Parâmetros do corpo da resposta (JSON)

    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 reiniciar um agente.

    curl "https://instance.service-now.com/api/sn_agent/agents/<agent_id>/restart" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

    Saída:

    {
  "message": "Restarting Agent With ID: <agent_id>"
}

    Agent Client Collector - POST /agents/check_defs/{check_def_id}/run

    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

    Tabela 110. Parâmetros de caminho
    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 111. Parâmetros de consulta
    Nome Descrição
    Nenhum(a)
    Tabela 112. Parâmetros do corpo da solicitação (JSON)
    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": {
  "<parameter name>": "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

    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
    timeout Valor do tempo limite da solicitação em segundos.

    Tipo de dados: número

    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.

    Tabela 113. Cabeçalhos da solicitação
    Cabeçalho Descrição
    Aceitar Formato de dados do corpo da resposta. Oferece suporte somente a application/json.
    Tabela 114. Cabeçalhos de resposta
    Cabeçalho Descrição
    Nenhum(a)

    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.

    Tabela 115. Códigos de status
    Código do 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.

    Parâmetros do corpo da resposta (JSON)

    Nome Descrição
    requestId Sys_id da solicitação de verificação em segundo plano gerada.

    Solicitação de cURL

    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

    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
    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

    Formato da URL

    /api/sn_agent/agents/check_defs/{check_def_id}/test

    Parâmetros de solicitação compatíveis

    Tabela 116. Parâmetros de caminho
    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 117. Parâmetros de consulta
    Nome Descrição
    Nenhum(a)
    Tabela 118. Parâmetros do corpo da solicitação (JSON)
    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.

    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.

    Tabela 119. Cabeçalhos da solicitação
    Cabeçalho Descrição
    Aceitar Formato de dados do corpo da resposta. Oferece suporte somente a application/json.
    Tabela 120. Cabeçalhos de resposta
    Cabeçalho Descrição
    Nenhum(a)

    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.

    Tabela 121. Códigos de status
    Código do status Descrição
    200 Bem-sucedido. A solicitação foi processada com sucesso.
    500 Erro ao criar a solicitação de teste.

    Parâmetros do corpo da resposta (JSON)

    Nome Descrição
    result_id Sys_id do registro do resultado de testes.

    Agent Client Collector - POST /agents/check_instances/{check_instance_id}/test

    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
    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

    Formato da URL

    /api/sn_agent/agents/check_instances/{check_instance_id}/test

    Parâmetros de solicitação compatíveis

    Tabela 122. Parâmetros de caminho
    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 123. Parâmetros de consulta
    Nome Descrição
    Nenhum(a)
    Tabela 124. Parâmetros do corpo da solicitação (JSON)
    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].

    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.

    Tabela 125. Cabeçalhos da solicitação
    Cabeçalho Descrição
    Aceitar Formato de dados do corpo da resposta. Oferece suporte somente a application/json.
    Tabela 126. Cabeçalhos de resposta
    Cabeçalho Descrição
    Nenhum(a)

    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.

    Tabela 127. Códigos de status
    Código do status Descrição
    200 Bem-sucedido. A solicitação foi processada com sucesso.
    500 Erro ao criar a solicitação de teste.

    Parâmetros do corpo da resposta (JSON)

    Nome Descrição
    result_id Sys_id do registro do resultado de testes.

    Agent Client Collector - POST /agents/update/check/{check_id}

    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}.

    Formato da URL

    /api/sn_agent/agents/update/check/{check_id}

    Parâmetros de solicitação compatíveis

    Tabela 128. Parâmetros de caminho
    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 129. Parâmetros de consulta
    Nome Descrição
    Nenhum(a)
    Tabela 130. Parâmetros do corpo da solicitação (JSON)
    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.

    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.

    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.

    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
    timeout 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

    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.

    Tabela 131. Cabeçalhos da solicitação
    Cabeçalho Descrição
    Aceitar Formato de dados do corpo da resposta. Oferece suporte somente a application/json.
    Tabela 132. Cabeçalhos de resposta
    Cabeçalho Descrição
    Nenhum(a)

    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.

    Tabela 133. Códigos de status
    Código do 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.

    Parâmetros do corpo da resposta (JSON)

    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 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/<check_sys_id>" \
--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}

    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

    Tabela 134. Parâmetros de caminho
    Nome Descrição
    check_def_param_id Sys_id do parâmetro de verificação.

    Tipo de dados: cadeia de caracteres

    Tabela: definições de parâmetro de verificação [sn_agent_check_param_def]
    Tabela 135. Parâmetros de consulta
    Nome Descrição
    Nenhum(a)
    Tabela 136. Parâmetros do corpo da solicitação (JSON)
    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.

    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.

    Tipo de dados: booliano
    nome Nome do parâmetro de verificação.

    Tipo de dados: cadeia de caracteres
    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.

    Tabela 137. Cabeçalhos da solicitação
    Cabeçalho Descrição
    Aceitar Formato de dados do corpo da resposta. Oferece suporte somente a application/json.
    Tabela 138. Cabeçalhos de resposta
    Cabeçalho Descrição
    Nenhum(a)

    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.

    Tabela 139. Códigos de status
    Código do 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.

    Parâmetros do corpo da resposta (JSON)

    Nome Descrição
    Nenhum(a) Mensagem de sucesso ou erro

    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}

    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

    Tabela 140. Parâmetros de caminho
    Nome Descrição
    check_def_secure_param_id Sys_id do parâmetro seguro.

    Tipo de dados: cadeia de caracteres

    Tabela: definições de parâmetro seguro de verificação [sn_agent_check_secure_param_def]
    Tabela 141. Parâmetros de consulta
    Nome Descrição
    Nenhum(a)
    Tabela 142. Parâmetros do corpo da solicitação (JSON)
    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.

    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

    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.

    Tabela 143. Cabeçalhos da solicitação
    Cabeçalho Descrição
    Aceitar Formato de dados do corpo da resposta. Oferece suporte somente a application/json.
    Tabela 144. Cabeçalhos de resposta
    Cabeçalho Descrição
    Nenhum(a)

    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.

    Tabela 145. Códigos de status
    Código do 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.

    Parâmetros do corpo da resposta (JSON)

    Nome Descrição
    Nenhum(a) Mensagem de sucesso ou erro

    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}

    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

    Tabela 146. Parâmetros de caminho
    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 147. Parâmetros de consulta
    Nome Descrição
    Nenhum(a)
    Tabela 148. Parâmetros do corpo da solicitação (JSON)
    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.

    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.

    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.

    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": {
  "<parameter name>": "String"
}

    Tipo de dados: objeto
    plug-ins Lista de Agent Client Collector plug-ins 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.

    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
    timeout Tempo limite em segundos.

    Tipo de dados: número
    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.

    Tabela 149. Cabeçalhos da solicitação
    Cabeçalho Descrição
    Aceitar Formato de dados do corpo da resposta. Oferece suporte somente a application/json.
    Tabela 150. Cabeçalhos de resposta
    Cabeçalho Descrição
    Nenhum(a)

    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.

    Tabela 151. Códigos de status
    Código do 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.

    Parâmetros do corpo da resposta (JSON)

    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}

    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}.

    Formato da URL

    /api/sn_agent/agents/update/check_param/{param_id}

    Parâmetros de solicitação compatíveis

    Tabela 152. Parâmetros de caminho
    Nome Descrição
    param_id Sys_id da cópia da área restrita do parâmetro de verificação de política.

    Tipo de dados: cadeia de caracteres

    Tabela: verificar parâmetros [sn_agent_check_param]
    Tabela 153. Parâmetros de consulta
    Nome Descrição
    Nenhum(a)
    Tabela 154. Parâmetros do corpo da solicitação (JSON)
    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.

    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.

    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.

    Tipo de dados: booliano

    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.

    Tabela 155. Cabeçalhos da solicitação
    Cabeçalho Descrição
    Aceitar Formato de dados do corpo da resposta. Oferece suporte somente a application/json.
    Tabela 156. Cabeçalhos de resposta
    Cabeçalho Descrição
    Nenhum(a)

    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.

    Tabela 157. Códigos de status
    Código do 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.

    Parâmetros do corpo da resposta (JSON)

    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 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/<param_sys_id>" \
--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}

    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}.

    Formato da URL

    /api/sn_agent/agents/update/check_secure_param/{param_id}

    Parâmetros de solicitação compatíveis

    Tabela 158. Parâmetros de caminho
    Nome Descrição
    param_id Sys_id da cópia da área restrita do parâmetro seguro de verificação de política.

    Tipo de dados: cadeia de caracteres

    Tabela: Parâmetro de verificação de segurança [sn_agent_check_secure_param]
    Tabela 159. Parâmetros de consulta
    Nome Descrição
    Nenhum(a)
    Tabela 160. Parâmetros do corpo da solicitação (JSON)
    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.

    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

    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.

    Tabela 161. Cabeçalhos da solicitação
    Cabeçalho Descrição
    Aceitar Formato de dados do corpo da resposta. Oferece suporte somente a application/json.
    Tabela 162. Cabeçalhos de resposta
    Cabeçalho Descrição
    Nenhum(a)

    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.

    Tabela 163. Códigos de status
    Código do 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.

    Parâmetros do corpo da resposta (JSON)

    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 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/<param_sys_id>" \
--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}

    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}.

    Formato da URL

    /api/sn_agent/agents/update/policy/{policy_id}

    Parâmetros de solicitação compatíveis

    Tabela 164. Parâmetros de caminho
    Nome Descrição
    policy_id Sys_id de uma cópia da área restrita de política.

    Tipo de dados: cadeia de caracteres

    Tabela: Políticas [sn_agent_policy]
    Tabela 165. Parâmetros de consulta
    Nome Descrição
    Nenhum(a)
    Tabela 166. Parâmetros do corpo da solicitação (JSON)
    Nome Descrição
    alias_cred Nome da credencial.

    Tipo de dados: cadeia de caracteres

    Tabela: credenciais [discovery_credentials]
    credential_alias Sys_id do alias de credencial.

    Tipo de dados: cadeia de caracteres

    Tabela: aliases de conexão e credencial [sys_alias]
    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 associados à política.

    Este campo só será aplicado se o valor da propriedade monitored_ci_type_group for verdadeiro.

    Tipo de dados: cadeia de caracteres

    Tabela: Grupos do CMDB [cmdb_group]
    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.

    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.

    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.

    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

    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.

    Tabela 167. Cabeçalhos da solicitação
    Cabeçalho Descrição
    Aceitar Formato de dados do corpo da resposta. Oferece suporte somente a application/json.
    Tabela 168. Cabeçalhos de resposta
    Cabeçalho Descrição
    Nenhum(a)

    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.

    Tabela 169. Códigos de status
    Código do 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.

    Parâmetros do corpo da resposta (JSON)

    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/<policy_sys_id>" \--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"
}