--- sourceDocument: Référence de l’API Xanadu sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/fr-FR/xanadu/api-reference Release : - xanadu ft:locale : - fr-FR ft:publication_title : - Référence de l’API Xanadu ft:clusterId : - crapiref bundleId : - crapiref workflow : - Creator --- # Agent Client Collector API # Agent Client Collector API {#ariaid-title1} * Rversion finale: Xanadu * * Mis à jour 1 août 2024 * * ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 75 minutes de lecture L'API Agent Client Collector fournit des points de terminaison pour gérer les actions sur les agents disponibles et les politiques de gestion. Cette API nécessite l'application Agent Client Collector de stockage Framework (sn_agent) et est fournie dans l'espace de noms `sn_agent` . Les points de terminaison de cette API nécessitent le rôle agent_client_collector_admin. Pour plus d'informations, consultez [Agent Client Collector](https://www.servicenow.com/docs/access?context=acc-landing-page&version=xanadu&pubname=xanadu-it-operations-management&ft:locale=en-US). Points de terminaison de gestion des agents : * Obtenez des informations détaillées sur un ou plusieurs agents. Ces points de terminaison sont également accessibles aux utilisateurs disposant du rôle agent_client_collector_user. * [GET /agents/{agent_id}](https://servicenow-prod.fluidtopics.net/QEP8zRm1ZTNaxaPmVG9qAg#agnt_clnt_cll-GET-agent_id "Obtient les informations d’un agent spécifié.") * [GET /agents/list](https://servicenow-prod.fluidtopics.net/QEP8zRm1ZTNaxaPmVG9qAg#agnt_clnt_cll-GET-list "Obtient une liste d’agents contenant des informations connexes.") {#agnt_clnt_cll-api__ul_tsy_mkq_dpb} * Soumettez une demande pour récupérer un journal d'agent et récupérer des informations sur la progression de la demande. * [GET /agents/{agent_id}/journal](https://servicenow-prod.fluidtopics.net/QEP8zRm1ZTNaxaPmVG9qAg#agnt_clnt_cll-GET-log "Demande le journal d’un agent spécifié avec l’état actif/actif.") * [GET /agents/log/{request_id}/](https://servicenow-prod.fluidtopics.net/QEP8zRm1ZTNaxaPmVG9qAg#agnt_clnt_cll-GET-log-request_id "Vérifie l’état d’une demande de journal de capture.") {#agnt_clnt_cll-api__ul_rpm_4kq_dpb} * Désactivez ou activez la collecte de données de l'agent. * [GET /agents/{agent_id}/data/off](https://servicenow-prod.fluidtopics.net/QEP8zRm1ZTNaxaPmVG9qAg#agnt_clnt_cll-GET-data-off "Désactive la collecte de données pour un agent spécifié à l’état actif/actif.") * [GET /agents/{agent_id}/données/sur](https://servicenow-prod.fluidtopics.net/QEP8zRm1ZTNaxaPmVG9qAg#agnt_clnt_cll-GET-data-on "Active la collecte de données pour un agent spécifié à l’état actif/actif.") {#agnt_clnt_cll-api__ul_z43_gkq_dpb} * Redémarrez un agent avec [GET /agents/{agent_id}/restart](https://servicenow-prod.fluidtopics.net/QEP8zRm1ZTNaxaPmVG9qAg#agnt_clnt_cll-GET-restart "Redémarre un agent spécifié avec l’état actif/actif."). * Exécutez Discovery sur un agent avec [GET /agents/{agent_id}/discovery](https://servicenow-prod.fluidtopics.net/QEP8zRm1ZTNaxaPmVG9qAg#agnt_clnt_cll-GET-discovery "Exécute une vérification de découverte pour localiser les CI associés à un agent. L’agent spécifié doit être dans l’état actif/opérationnel."). {#agnt_clnt_cll-api__ul_mlz_ckq_dpb} Pour plus d'informations sur l'exécution de tâches similaires dans un include de script, consultez [AccAgentsAPI.](https://developer.servicenow.com/go_to_api.do?ID=AccAgentsAPIAPIScoped&v=utah) Gestion des politiques et workflow : Utilisez les API de gestion des politiques pour afficher les détails, activer/désactiver une politique, mettre à jour une politique et publier une politique. : Pour mettre à jour une politique : 1. Obtenir une liste de politiques et de détails avec [GET /agents/policies/list](https://servicenow-prod.fluidtopics.net/QEP8zRm1ZTNaxaPmVG9qAg#agnt_clnt_cll-GET-policies-list "Obtient une liste des politiques qui sont à l’état de brouillon publié ou non publié."). Ce point de terminaison nécessite le rôle agent_client_collector_user. * Pour mettre à jour une politique à l'état Brouillon, utilisez les sys_ids récupérées dans la liste des politiques dans les points de terminaison de mise à jour. * Pour mettre à jour une politique à l'état Publié ou Publié\*, obtenez une copie modifiable du bac à sable avec [GET /agents/policy/sandbox_from_published/{policy_id}](https://servicenow-prod.fluidtopics.net/QEP8zRm1ZTNaxaPmVG9qAg#agnt_clnt_cll-GET-policy-sbox-fr "Obtient la copie du bac à sable d’une politique publiée et fournit les détails de la politique."). Utilisez le sys_ids de cette réponse pour modifier les propriétés à l'aide d'un point de terminaison de mise à jour. {#agnt_clnt_cll-api__ul_mtj_whk_fpb} 2. Modifiez les détails de la politique à l'aide d'un point de terminaison de mise à jour. * [POST /agents/update/policy/{policy_id}](https://servicenow-prod.fluidtopics.net/QEP8zRm1ZTNaxaPmVG9qAg#agnt_clnt_cll-POST-update-policy "Met à jour une copie sandbox d’une politique.") * [POST /agents/update/check/{check_id}](https://servicenow-prod.fluidtopics.net/QEP8zRm1ZTNaxaPmVG9qAg#agnt_clnt_cll-POST-update-check-id "Met à jour une vérification de politique sélectionnée.") * [POST /agents/update/check_param/{param_id}](https://servicenow-prod.fluidtopics.net/QEP8zRm1ZTNaxaPmVG9qAg#agnt_clnt_cll-POST-update-check_param "Met à jour un paramètre de vérification de politique sélectionné.") * [POST /agents/update/check_secure_param/{param_id}](https://servicenow-prod.fluidtopics.net/QEP8zRm1ZTNaxaPmVG9qAg#agnt_clnt_cll-POST-update-check_secure "Met à jour un paramètre sécurisé de vérification de politique sélectionné.") {#agnt_clnt_cll-api__ul_mp4_xjk_fpb} 3. Publiez la politique à l'aide de [GET /agents/policy/publish/{policy_id}](https://servicenow-prod.fluidtopics.net/QEP8zRm1ZTNaxaPmVG9qAg#agnt_clnt_cll-GET-policy-publish "Publie un brouillon de politique."). {#agnt_clnt_cll-api__ol_rmk_chk_fpb} : Une fois publiée, la politique devient active. Cette API inclut également des points de terminaison pour activer ou désactiver une politique publiée : * [GET /agents/policy/activate/{policy_id}](https://servicenow-prod.fluidtopics.net/QEP8zRm1ZTNaxaPmVG9qAg#agnt_clnt_cll-GET-policy-act "Active une politique publiée.") * [GET /agents/policy/deactivate/{policy_id}](https://servicenow-prod.fluidtopics.net/QEP8zRm1ZTNaxaPmVG9qAg#agnt_clnt_cll-GET-policy-deact "Désactive une politique publiée.") {#agnt_clnt_cll-api__ul_glm_flk_fpb} ## Agent Client Collector : GET /agents/{agent_id} {#ariaid-title2} Obtient les informations d'un agent spécifié. ### Format d'URL /api/sn_agent/agents/{agent_id} ### Paramètres de demande pris en charge {#agnt_clnt_cll-GET-agent_id__entry__2} | Nom | Description | |-|-| | agent_id | ID unique d'un agent répertorié dans la colonne ID d'agent de la table Agent Client Collectors \[sn_agent_cmdb_ci_agent\]. Pour obtenir une liste des ID d'agents et d'autres détails, exécutez le point de terminaison GET /agents/list . Type de données : chaîne | [Tableau 1. Paramètres de chemin d'accès] {#agnt_clnt_cll-GET-agent_id__entry__6} | Nom | Description | |-|-| | Aucun | | [Tableau 2. Paramètres de requête] {#agnt_clnt_cll-GET-agent_id__entry__10} | Nom | Description | |-|-| | Aucun | | [Tableau 3. Paramètres du corps de la demande (JSON)] ### En-têtes Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l'API REST, consultez [En-têtes d'API REST pris en charge](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres."). {#agnt_clnt_cll-GET-agent_id__entry__14}{#agnt_clnt_cll-GET-agent_id__accept-JSON-only-entry-RESTAPI} | En-tête | Description | |-|-| | Accepter | Format de données du corps de la réponse. Prend uniquement en charge application/json. | [Tableau 4. En-têtes de demandes] {#agnt_clnt_cll-GET-agent_id__entry__18} | En-tête | Description | |-|-| | Aucun | | [Tableau 5. En-têtes de réponses] ### Codes d'état Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d'état possibles utilisés dans l'API REST, consultez [Codes de réponse HTTP de l'API REST](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres."). {#agnt_clnt_cll-GET-agent_id__entry__22}{#agnt_clnt_cll-GET-agent_id__entry-200-status-code}{#agnt_clnt_cll-GET-agent_id__agntCC-desc-403-user} | Code d'état | Description | |-|-| | 200 | Réussi. La demande a été correctement traitée. | | 403 | L'utilisateur n'a pas le rôle agent_client_collector_user. | | 404 | Agent avec l'ID fourni introuvable. | [Tableau 6. Codes d'état] ### Paramètres de corps de réponse (JSON) {#agnt_clnt_cll-GET-agent_id__entry__30}{#agnt_clnt_cll-GET-agent_id__accAgents-parm-agent-obj-id-entry}{#agnt_clnt_cll-GET-agent_id__accAgents-parm-agent-obj-dataCollect-entry}{#agnt_clnt_cll-GET-agent_id__accAgents-parm-agent-obj-ip-entry}{#agnt_clnt_cll-GET-agent_id__accAgents-parm-agent-obj-dup-entry}{#agnt_clnt_cll-GET-agent_id__accAgents-parm-agent-obj-restart-entry}{#agnt_clnt_cll-GET-agent_id__accAgents-parm-agent-obj-name-entry}{#agnt_clnt_cll-GET-agent_id__accAgents-parm-agent-obj-numChecks-entry}{#agnt_clnt_cll-GET-agent_id__accAgents-parm-agent-obj-status-entry}{#agnt_clnt_cll-GET-agent_id__accAgents-parm-agent-obj-up-entry}{#agnt_clnt_cll-GET-agent_id__accAgents-parm-agent-obj-version-entry} | Nom | Description | |-|-| | \ | Tableau d'objets JSON contenant des informations étendues sur l'agent. { "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 de l'agent tel que soumis. Type de données : chaîne | | data_collection | La collecte de données indique si des vérifications planifiées doivent être exécutées. Ces vérifications font partie des politiques planifiées pour l'exécution de cet agent. Valeurs possibles : * 0 : Activé : les vérifications s'exécutent comme prévu. * 1 : Désactivé (manuel) -- Les vérifications ont été désactivées manuellement. * 2 : Désactivé (auto) -- Les vérifications ont été désactivées automatiquement en raison de la consommation élevée du processeur par le {#agnt_clnt_cll-GET-agent_id__ul_w4n_53p_bpb} Type de données : nombre | | ip_address | Adresse IP de l'agent. Type de données : chaîne | | is_duplicate | Marqueur indiquant si cet agent est un doublon d'un autre. Il ne doit y avoir qu'un seul agent sur un hôte donné. Valeurs possibles : * true : l'agent a le même hôte qu'un agent Alive/Up avec un ID d'agent différent. Désactiver ou désinstaller le doublon * false : cet agent n'a aucun doublon à l'état Actif/En service. {#agnt_clnt_cll-GET-agent_id__ul_b34_ffl_bpb} Type de données : booléennes | | is_restart_enabled | Marqueur indiquant si le redémarrage est activé. Le redémarrage de l'agent n'est pas configurable. Cela dépend du système d'exploitation et de la version du système d'exploitation sur lequel l'agent s'exécute. Valeurs possibles : * Vrai : le redémarrage est activé pour cet agent. * faux : le redémarrage est désactivé pour cet agent. {#agnt_clnt_cll-GET-agent_id__ul_bvp_dfl_bpb} Type de données : booléennes | | nom | Nom de l'agent. Type de données : chaîne | | number_of_running_checks | Nombre de vérifications que l'agent doit exécuter. Ces vérifications font partie des politiques planifiées pour l'exécution de cet agent. Type de données : nombre | | statut | État de l'agent. Valeurs possibles : * 0 : actif/actif -- L'agent est actif. * 1 : Avertissement : l'agent n'a pas reçu de message de maintien de connexion au cours des dernières minutes. * 2 : En panne -- L'agent n'a pas reçu de message de maintien depuis longtemps. * 3 : Redémarrage -- L'agent est en cours de redémarrage. {#agnt_clnt_cll-GET-agent_id__ul_adg_ffp_bpb} Type de données : nombre | | up_since | Temps UTC depuis que l'état de l'agent est activé/opérationnel. La valeur est au format [GlideDateTime](https://servicenow-prod.fluidtopics.net/JgJ6~NAVmsxzolCUQ1ybvw#c_GlideDateTimeScoped "La classe GlideDateTime incluse dans le champ d’application fournit des méthodes permettant d’effectuer des opérations sur les objets GlideDateTime.") . Type de données : chaîne | | version | Version de l'agent en cours d'exécution Agent Client Collector . Type de données : chaîne | [ ] ### Demande cURL L'exemple suivant montre comment obtenir les détails de l'agent. curl "https://instance.service-now.com/api/sn_agent/agents/" \ --request GET \ --header "Accept:application/json" \ --user 'username':'password' Sortie : { "name": "WIN-V26KAP7PI2G", "status": 2, "agent_id": "074b14e2eb3ce9d4", "ip_address": "10.196.55.14", "number_of_running_checks": 11, "data_collection": 0, "is_restart_enabled": true, "is_duplicate": false, "up_since": "2021-03-31 12:02:17", "version": "2.3.0" } ## Agent Client Collector : GET /agents/{agent_id}/data/off {#ariaid-title3} Désactive la collecte de données pour un agent spécifié à l'état actif/actif. Pour déterminer si la collecte de données d'un agent est activée ou désactivée, exécutez le point de terminaison GET /agents/{agent_id} . ### Format d'URL {#agnt_clnt_cll-GET-data-off__section_bbq_zyc_z4b} /api/sn_agent/agents/{agent_id}/data/off ### Paramètres de demande pris en charge {#agnt_clnt_cll-GET-data-off__section_cbq_zyc_z4b} {#agnt_clnt_cll-GET-data-off__table_oyt_cd3_dpb__entry__2} | Nom | Description | |-|-| | agent_id | ID unique d'un agent répertorié dans la colonne ID d'agent de la table Agent Client Collectors \[sn_agent_cmdb_ci_agent\]. Pour obtenir une liste des ID d'agents et d'autres détails, exécutez le point de terminaison GET /agents/list . Type de données : chaîne | [Tableau 7. Paramètres de chemin d'accès] {#agnt_clnt_cll-GET-data-off__table_oyt_cd3_dpb} {#agnt_clnt_cll-GET-data-off__table_ebq_zyc_z4b__entry__2} | Nom | Description | |-|-| | Aucun | | [Tableau 8. Paramètres de requête] {#agnt_clnt_cll-GET-data-off__table_ebq_zyc_z4b} {#agnt_clnt_cll-GET-data-off__table_fbq_zyc_z4b__entry__2} | Nom | Description | |-|-| | Aucun | | [Tableau 9. Paramètres du corps de la demande (JSON)] {#agnt_clnt_cll-GET-data-off__table_fbq_zyc_z4b} ### En-têtes {#agnt_clnt_cll-GET-data-off__section_gbq_zyc_z4b} Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l'API REST, consultez [En-têtes d'API REST pris en charge](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres."). {#agnt_clnt_cll-GET-data-off__table_hbq_zyc_z4b__entry__2}{#agnt_clnt_cll-GET-data-off__accept-JSON-only-entry-RESTAPI} | En-tête | Description | |-|-| | Accepter | Format de données du corps de la réponse. Prend uniquement en charge application/json. | [Tableau 10. En-têtes de demandes] {#agnt_clnt_cll-GET-data-off__table_hbq_zyc_z4b} {#agnt_clnt_cll-GET-data-off__table_ibq_zyc_z4b__entry__2} | En-tête | Description | |-|-| | Aucun | | [Tableau 11. En-têtes de réponses] {#agnt_clnt_cll-GET-data-off__table_ibq_zyc_z4b} ### Codes d'état {#agnt_clnt_cll-GET-data-off__section_jbq_zyc_z4b} Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d'état possibles utilisés dans l'API REST, consultez [Codes de réponse HTTP de l'API REST](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres."). {#agnt_clnt_cll-GET-data-off__table_epg_2f3_dpb__entry__2}{#agnt_clnt_cll-GET-data-off__entry-200-status-code}{#agnt_clnt_cll-GET-data-off__agntCC-desc-403-admin} | Code d'état | Description | |-|-| | 200 | Réussi. La demande a été correctement traitée. | | 403 | L'utilisateur n'a pas le rôle agent_client_collector_admin. | | 404 | L'agent est introuvable ou n'est pas dans l'état actif/actif. | [Tableau 12. Codes d'état] {#agnt_clnt_cll-GET-data-off__table_epg_2f3_dpb} ### Paramètres de corps de réponse (JSON) {#agnt_clnt_cll-GET-data-off__section_nwl_zyc_z4b} {#agnt_clnt_cll-GET-data-off__table_owl_zyc_z4b__entry__2} | Nom | Description | |-|-| | message | Message contenant les résultats de réussite ou d'échec de l'opération. Type de données : chaîne | [ ] {#agnt_clnt_cll-GET-data-off__table_owl_zyc_z4b} ### Demande cURL {#agnt_clnt_cll-GET-data-off__example_nbq_zyc_z4b} L'exemple suivant montre comment désactiver la collecte de données de l'agent. curl "https://instance.service-now.com/api/sn_agent/agents//data/off" \ --request GET \ --header "Accept:application/json" \ --user 'username':'password' Sortie : { "message": "Data Collection Disabled For Agent With ID: " } ## Agent Client Collector : GET /agents/{agent_id}/data/on {#ariaid-title4} Active la collecte de données pour un agent spécifié à l'état actif/actif. Pour déterminer si la collecte de données d'un agent est activée ou désactivée, exécutez le point de terminaison GET /agents/{agent_id} . ### Format d'URL {#agnt_clnt_cll-GET-data-on__section_dwl_zyc_z4b} /api/sn_agent/agents/{agent_id}/data/on ### Paramètres de demande pris en charge {#agnt_clnt_cll-GET-data-on__section_ewl_zyc_z4b} {#agnt_clnt_cll-GET-data-on__table_oyt_cd3_dpb__entry__2} | Nom | Description | |-|-| | agent_id | ID unique d'un agent répertorié dans la colonne ID d'agent de la table Agent Client Collectors \[sn_agent_cmdb_ci_agent\]. Pour obtenir une liste des ID d'agents et d'autres détails, exécutez le point de terminaison GET /agents/list . Type de données : chaîne | [Tableau 13. Paramètres de chemin d'accès] {#agnt_clnt_cll-GET-data-on__table_oyt_cd3_dpb} {#agnt_clnt_cll-GET-data-on__table_gwl_zyc_z4b__entry__2} | Nom | Description | |-|-| | Aucun | | [Tableau 14. Paramètres de requête] {#agnt_clnt_cll-GET-data-on__table_gwl_zyc_z4b} {#agnt_clnt_cll-GET-data-on__table_hwl_zyc_z4b__entry__2} | Nom | Description | |-|-| | Aucun | | [Tableau 15. Paramètres du corps de la demande (JSON)] {#agnt_clnt_cll-GET-data-on__table_hwl_zyc_z4b} ### En-têtes {#agnt_clnt_cll-GET-data-on__section_iwl_zyc_z4b} Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l'API REST, consultez [En-têtes d'API REST pris en charge](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres."). {#agnt_clnt_cll-GET-data-on__table_jwl_zyc_z4b__entry__2}{#agnt_clnt_cll-GET-data-on__accept-JSON-only-entry-RESTAPI} | En-tête | Description | |-|-| | Accepter | Format de données du corps de la réponse. Prend uniquement en charge application/json. | [Tableau 16. En-têtes de demandes] {#agnt_clnt_cll-GET-data-on__table_jwl_zyc_z4b} {#agnt_clnt_cll-GET-data-on__table_kwl_zyc_z4b__entry__2} | En-tête | Description | |-|-| | Aucun | | [Tableau 17. En-têtes de réponses] {#agnt_clnt_cll-GET-data-on__table_kwl_zyc_z4b} ### Codes d'état {#agnt_clnt_cll-GET-data-on__section_lwl_zyc_z4b} Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d'état possibles utilisés dans l'API REST, consultez [Codes de réponse HTTP de l'API REST](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres."). {#agnt_clnt_cll-GET-data-on__table_y2n_2f3_dpb__entry__2}{#agnt_clnt_cll-GET-data-on__entry-200-status-code}{#agnt_clnt_cll-GET-data-on__agntCC-desc-403-admin} | Code d'état | Description | |-|-| | 200 | Réussi. La demande a été correctement traitée. | | 403 | L'utilisateur n'a pas le rôle agent_client_collector_admin. | | 404 | L'agent est introuvable ou n'est pas dans l'état actif/actif. | [Tableau 18. Codes d'état] {#agnt_clnt_cll-GET-data-on__table_y2n_2f3_dpb} ### Paramètres de corps de réponse (JSON) {#agnt_clnt_cll-GET-data-on__section_nwl_zyc_z4b} {#agnt_clnt_cll-GET-data-on__table_owl_zyc_z4b__entry__2} | Nom | Description | |-|-| | message | Message contenant les résultats de réussite ou d'échec de l'opération. Type de données : chaîne | [ ] {#agnt_clnt_cll-GET-data-on__table_owl_zyc_z4b} ### Demande cURL {#agnt_clnt_cll-GET-data-on__example_pwl_zyc_z4b} L'exemple suivant montre comment activer la collecte de données d'agent. curl "https://instance.service-now.com/api/sn_agent/agents//data/on" \ --request GET \ --header "Accept:application/json" \ --user 'username':'password' Sortie : { "message": "Data Collection Enabled For Agent With ID: " } ## Agent Client Collector : GET /agents/{agent_id}/discovery {#ariaid-title5} Exécute une vérification de découverte pour localiser les CI associés à un agent. L'agent spécifié doit être dans l'état actif/opérationnel. ### Format d'URL /api/sn_agent/agents/{agent_id}/discovery ### Paramètres de demande pris en charge {#agnt_clnt_cll-GET-discovery__section_ewl_zyc_z4b} {#agnt_clnt_cll-GET-discovery__table_oyt_cd3_dpb__entry__2} | Nom | Description | |-|-| | agent_id | ID unique d'un agent répertorié dans la colonne ID d'agent de la table Agent Client Collectors \[sn_agent_cmdb_ci_agent\]. Pour obtenir une liste des ID d'agents et d'autres détails, exécutez le point de terminaison GET /agents/list . Type de données : chaîne | [Tableau 19. Paramètres de chemin d'accès] {#agnt_clnt_cll-GET-discovery__table_oyt_cd3_dpb} {#agnt_clnt_cll-GET-discovery__table_gwl_zyc_z4b__entry__2} | Nom | Description | |-|-| | Aucun | | [Tableau 20. Paramètres de requête] {#agnt_clnt_cll-GET-discovery__table_gwl_zyc_z4b} {#agnt_clnt_cll-GET-discovery__table_hwl_zyc_z4b__entry__2} | Nom | Description | |-|-| | Aucun | | [Tableau 21. Paramètres du corps de la demande (JSON)] {#agnt_clnt_cll-GET-discovery__table_hwl_zyc_z4b} ### En-têtes {#agnt_clnt_cll-GET-discovery__section_iwl_zyc_z4b} Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l'API REST, consultez [En-têtes d'API REST pris en charge](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres."). {#agnt_clnt_cll-GET-discovery__table_jwl_zyc_z4b__entry__2}{#agnt_clnt_cll-GET-discovery__accept-JSON-only-entry-RESTAPI} | En-tête | Description | |-|-| | Accepter | Format de données du corps de la réponse. Prend uniquement en charge application/json. | [Tableau 22. En-têtes de demandes] {#agnt_clnt_cll-GET-discovery__table_jwl_zyc_z4b} {#agnt_clnt_cll-GET-discovery__table_kwl_zyc_z4b__entry__2} | En-tête | Description | |-|-| | Aucun | | [Tableau 23. En-têtes de réponses] {#agnt_clnt_cll-GET-discovery__table_kwl_zyc_z4b} ### Codes d'état {#agnt_clnt_cll-GET-discovery__section_lwl_zyc_z4b} Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d'état possibles utilisés dans l'API REST, consultez [Codes de réponse HTTP de l'API REST](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres."). {#agnt_clnt_cll-GET-discovery__table_y2n_2f3_dpb__entry__2}{#agnt_clnt_cll-GET-discovery__entry-200-status-code}{#agnt_clnt_cll-GET-discovery__agntCC-desc-403-admin} | Code d'état | Description | |-|-| | 200 | Réussi. La demande a été correctement traitée. | | 403 | L'utilisateur n'a pas le rôle agent_client_collector_admin. | | 404 | L'agent est introuvable ou n'est pas dans l'état actif/actif. | [Tableau 24. Codes d'état] {#agnt_clnt_cll-GET-discovery__table_y2n_2f3_dpb} ### Paramètres de corps de réponse (JSON) {#agnt_clnt_cll-GET-discovery__section_nwl_zyc_z4b} {#agnt_clnt_cll-GET-discovery__table_owl_zyc_z4b__entry__2} | Nom | Description | |-|-| | message | Message contenant les résultats de réussite ou d'échec de l'opération. Type de données : chaîne | [ ] {#agnt_clnt_cll-GET-discovery__table_owl_zyc_z4b} ### Demande cURL L'exemple suivant montre comment exécuter Discovery sur un agent dont l'état est actif/actif. curl "https://instance.service-now.com/api/sn_agent/agents//discovery" \ --request GET \ --header "Accept:application/json" \ --user 'username':'password' Sortie : { "message": "Running Discovery For Agent With ID: " } ## Agent Client Collector : GET /agents/check_defs/{check_def_id} {#ariaid-title6} Obtient une définition de vérification spécifiée avec des détails. ### Format d'URL /api/sn_agent/agents/check_defs/{check_def_id} ### Paramètres de demande pris en charge {#agnt_clnt_cll-GET-check_defs-id__entry__2} | Nom | Description | |-|-| | check_def_id | Sys_id de la définition de vérification répertoriée dans la table Définitions de vérification \[sn_agent_check_def\]. Type de données : chaîne | [Tableau 25. Paramètres de chemin d'accès] {#agnt_clnt_cll-GET-check_defs-id__entry__6} | Nom | Description | |-|-| | Aucun | | [Tableau 26. Paramètres de requête] {#agnt_clnt_cll-GET-check_defs-id__entry__10} | Nom | Description | |-|-| | X-Include-Check-Params | Marqueur indiquant si les détails des paramètres de vérification existants sont renvoyés. Les informations relatives à chaque paramètre de contrôle standard et sécurisé sont incluses dans un objet JSON. Valeurs valides : * true : renvoie les détails des paramètres de vérification. * faux : ne renvoie pas les détails des paramètres de vérification. {#agnt_clnt_cll-GET-check_defs-id__ul_pv3_gqc_wqb} Type de données : booléennes Valeur par défaut : false | [Tableau 27. Paramètres du corps de la demande (JSON)] ### En-têtes Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l'API REST, consultez [En-têtes d'API REST pris en charge](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres."). {#agnt_clnt_cll-GET-check_defs-id__entry__14}{#agnt_clnt_cll-GET-check_defs-id__accept-JSON-only-entry-RESTAPI} | En-tête | Description | |-|-| | Accepter | Format de données du corps de la réponse. Prend uniquement en charge application/json. | [Tableau 28. En-têtes de demandes] {#agnt_clnt_cll-GET-check_defs-id__entry__18} | En-tête | Description | |-|-| | Aucun | | [Tableau 29. En-têtes de réponses] ### Codes d'état Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d'état possibles utilisés dans l'API REST, consultez [Codes de réponse HTTP de l'API REST](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres."). {#agnt_clnt_cll-GET-check_defs-id__entry__22}{#agnt_clnt_cll-GET-check_defs-id__entry-200-status-code} | Code d'état | Description | |-|-| | 200 | Réussi. La demande a été correctement traitée. | | 404 | La définition de vérification est introuvable avec le sys_id fourni. | [Tableau 30. Codes d'état] ### Paramètres de corps de réponse (JSON) {#agnt_clnt_cll-GET-check_defs-id__entry__28}{#agnt_clnt_cll-GET-check_defs-id__accCkDf-background-desc-ph}{#agnt_clnt_cll-GET-check_defs-id__accCkDf-chkGrp-desc-ph}{#agnt_clnt_cll-GET-check_defs-id__accCkDf-chkTyp-desc-ph}{#agnt_clnt_cll-GET-check_defs-id__accCkDf-command-desc-ph}{#agnt_clnt_cll-GET-check_defs-id__accCkDf-name-desc-ph}{#agnt_clnt_cll-GET-check_defs-id__accCkDf-p-desc-ph}{#agnt_clnt_cll-GET-check_defs-id__accCkDf-p-active-desc-ph}{#agnt_clnt_cll-GET-check_defs-id__accCkDf-p-default-desc-ph}{#agnt_clnt_cll-GET-check_defs-id__accCkDf-p-mando-desc-ph}{#agnt_clnt_cll-GET-check_defs-id__accCkDf-p-name-desc-ph}{#agnt_clnt_cll-GET-check_defs-id__accCkDf-p-id-desc-ph}{#agnt_clnt_cll-GET-check_defs-id__accCkDf-plugins-desc-ph}{#agnt_clnt_cll-GET-check_defs-id__accCkDf-proxy-desc-ph}{#agnt_clnt_cll-GET-check_defs-id__accCkDf-sp-desc-ph}{#agnt_clnt_cll-GET-check_defs-id__accCkDf-sp-active-desc-ph}{#agnt_clnt_cll-GET-check_defs-id__accCkDf-sp-name-desc-ph}{#agnt_clnt_cll-GET-check_defs-id__accCkDf-sp-order-desc-ph}{#agnt_clnt_cll-GET-check_defs-id__accCkDf-sp-id-desc-ph}{#agnt_clnt_cll-GET-check_defs-id__accCkDf-id-desc-ph}{#agnt_clnt_cll-GET-check_defs-id__accCkDf-timeout-desc-ph} | Propriétés | Description | |-|-| | vérifier | Détails de la définition de contrôle spécifiée. { "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 } | | arrière-plan | Marqueur indiquant si cette définition de vérification est une vérification d'antécédents. Une vérification des antécédents est une vérification que l'agent commence à exécuter sans attendre qu'elle se termine. Valeurs valides : * true : cette définition de vérification est une vérification d'arrière-plan. * false : cette définition de vérification n'est pas une vérification des antécédents. {#agnt_clnt_cll-GET-check_defs-id__ul_ypb_5ps_5qb} Type de données : booléennes | | check_group | Groupe spécifié pour cette définition de vérification. Type de données : chaîne | | check_type | Type de vérification. Valeurs possibles : * Événements : vérifiez que les résultats sont transformés en événement de gestion des événements. * Mesures : les valeurs du résultat de vérification sont transformées en mesures. {#agnt_clnt_cll-GET-check_defs-id__ul_gtr_kfb_wqb} Type de données : chaîne | | commande | Commande exécutée Agent Client Collector . Type de données : chaîne | | erreur | Message en cas d'erreur. Null dans le cas contraire. Type de données : chaîne | | nom | Nom du chèque. Type de données : chaîne | | paramètres | Liste des définitions de paramètres associées à la définition de vérification. Ces résultats ne sont inclus que si le withParams paramètre est défini sur vrai. "params": [ { "active": Boolean, "default_value": "String", "mandatory": Boolean, "name": "String", "sys_id": "String" } ] {#agnt_clnt_cll-GET-check_defs-id__accCkDf-p-code} Type de données : tableau | | params.active | Marqueur indiquant si le paramètre de vérification est actif. Valeurs valides : * true : le paramètre de vérification est actif. * false : le paramètre check est inactif. {#agnt_clnt_cll-GET-check_defs-id__ul_pnb_jyc_wqb} Type de données : booléennes | | params.default_value | Spécifie la valeur par défaut de ce paramètre de vérification. Type de données : chaîne | | params.mandatory | Marqueur indiquant si le paramètre de vérification est requis. Valeurs valides : * true : le paramètre check est requis. * false : le paramètre check est facultatif. {#agnt_clnt_cll-GET-check_defs-id__ul_wtg_2zc_wqb} Type de données : booléennes | | params.name | Nom du paramètre de vérification. Type de données : chaîne | | params.sys_id | Sys_id du paramètre de vérification répertorié dans la table Vérifier les définitions de paramètres sécurisés \[sn_agent_check_param_def\]. Type de données : chaîne | | modules d'extension | Liste des [Agent Client Collector modules d'extension](https://www.servicenow.com/docs/access?context=acc-assets&version=xanadu&pubname=xanadu-it-operations-management&ft:locale=en-US) associés à cette vérification. Type de données : tableau | | proxy_valid | Marqueur indiquant si la politique de définition de vérification est définie pour fonctionner en tant que proxy. Valeurs valides : * true : cette politique de définition de vérification est définie pour fonctionner en tant que proxy. * false : cette politique de définition de vérification n'est pas définie pour fonctionner en tant que proxy. {#agnt_clnt_cll-GET-check_defs-id__ul_wbf_qps_5qb} Type de données : booléennes | | secure_params | Liste des éléments affectés à ce chèque. Ces résultats ne sont inclus que si le withParams paramètre est défini sur vrai. "secure_params": [ { "active": Boolean, "name": "String", "order": Number, "sys_id": "String" } ] {#agnt_clnt_cll-GET-check_defs-id__accCkDf-sp-code} Type de données : tableau | | secure_params.active | Marqueur indiquant si le paramètre sécurisé est actif. Valeurs valides : * true : le paramètre sécurisé est actif. * faux : le paramètre sécurisé est inactif. {#agnt_clnt_cll-GET-check_defs-id__ul_g1b_3vc_wqb} Type de données : booléennes | | secure_params.name | Nom du paramètre sécurisé. Type de données : chaîne | | secure_params.commande | Ordre dans lequel le paramètre est envoyé à la commande/au script de vérification. Type de données : nombre | | secure_params.sys_id | Sys_id du paramètre sécurisé répertorié dans la table Vérifier les définitions de paramètres sécurisés \[sn_agent_check_secure_param_def\]. Type de données : chaîne | | sys_id | Sys_id de la définition de vérification répertoriée dans la table Définitions de vérification \[sn_agent_check_def\]. Type de données : chaîne | | timeout | Délai en secondes. Type de données : nombre | [ ] ### Demande cURL L'exemple suivant montre comment obtenir des informations pour une définition de vérification spécifiée. curl "https://instance.service-now.com/api/sn_agent/agents/check_defs/94436b237f705300f128134f8dfa91a4" \ --request GET \ --header "Accept:application/json" \ --user 'username':'password' Sortie : { "name": "app.apache.metrics-apache", "command": "metrics-apache-graphite.rb -p {{.labels.params_port}} --path {{.labels.params_path}} -h {{.labels.params_host}}", "plugins": [ "monitoring-plugin-common" ], "timeout": 60, "proxy_valid": true, "background": false, "check_type": "Metrics", "check_group": "Apache", "sys_id": "94436b237f705300f128134f8dfa91a4", "params": [ { "name": "port", "active": true, "mandatory": true, "default_value": "80", "sys_id": "58436b237f705300f128134f8dfa91a8" }, { "name": "path", "active": true, "mandatory": true, "default_value": "/server-status?auto", "sys_id": "98436b237f705300f128134f8dfa91aa" }, { "name": "scheme", "active": false, "mandatory": false, "default_value": null, "sys_id": "a4e57a96db3bbb4035305c55dc9619f6" }, { "name": "host", "active": true, "mandatory": true, "default_value": "127.0.0.1", "sys_id": "d4436b237f705300f128134f8dfa91a6" }, { "name": "ssl_secure_connection", "active": false, "mandatory": false, "default_value": null, "sys_id": "e3b272c4530100106ffeddeeff7b1275" } ], "secure_params": [ { "name": "cred_user_name", "active": true, "order": 1, "sys_id": "2494cd6e53170010f42cddeeff7b1273" }, { "name": "cred_password", "active": true, "order": 2, "sys_id": "35948d6e53170010f42cddeeff7b127f" } ] } ## Agent Client Collector : GET /agents/check_defs/list {#ariaid-title7} Obtient une liste de définitions de vérification avec des détails. ### Format d'URL /api/sn_agent/agents/check_defs/list ### Paramètres de demande pris en charge {#agnt_clnt_cll-GET-check_defs-list__entry__2} | Nom | Description | |-|-| | Aucun | | [Tableau 31. Paramètres de chemin d'accès] {#agnt_clnt_cll-GET-check_defs-list__entry__6} | Nom | Description | |-|-| | Aucun | | [Tableau 32. Paramètres de requête] {#agnt_clnt_cll-GET-check_defs-list__entry__10} | Nom | Description | |-|-| | requête x-enc | [Chaîne de requête codée](https://www.servicenow.com/docs/access?context=c_EncodedQueryStrings&version=xanadu&pubname=xanadu-platform-user-interface&ft:locale=en-US) pour filtrer la liste des résultats de la définition de contrôle. Utilisez null pour obtenir une liste non filtrée des définitions de vérification dans le système. Type de données : chaîne | | X-Include-Check-Params | Marqueur indiquant si les détails des paramètres de vérification existants sont renvoyés. Les informations relatives à chaque paramètre de contrôle standard et sécurisé sont incluses dans un objet JSON. Valeurs valides : * true : renvoie les détails des paramètres de vérification. * faux : ne renvoie pas les détails des paramètres de vérification. {#agnt_clnt_cll-GET-check_defs-list__ul_pv3_gqc_wqb} Type de données : booléennes Valeur par défaut : false | | X-Limit (Limite X) | Limite le nombre d'enregistrements renvoyés. Définissez la valeur sur null pour utiliser la valeur par défaut. Type de données : nombre Par défaut : 20 000 | [Tableau 33. Paramètres du corps de la demande (JSON)] ### En-têtes Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l'API REST, consultez [En-têtes d'API REST pris en charge](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres."). {#agnt_clnt_cll-GET-check_defs-list__entry__18}{#agnt_clnt_cll-GET-check_defs-list__accept-JSON-only-entry-RESTAPI} | En-tête | Description | |-|-| | Accepter | Format de données du corps de la réponse. Prend uniquement en charge application/json. | [Tableau 34. En-têtes de demandes] {#agnt_clnt_cll-GET-check_defs-list__table_ufx_wwq_wqb__entry__2} | En-tête | Description | |-|-| | Aucun | | [Tableau 35. En-têtes de réponses] {#agnt_clnt_cll-GET-check_defs-list__table_ufx_wwq_wqb} ### Codes d'état Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d'état possibles utilisés dans l'API REST, consultez [Codes de réponse HTTP de l'API REST](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres."). {#agnt_clnt_cll-GET-check_defs-list__entry__26}{#agnt_clnt_cll-GET-check_defs-list__entry-200-status-code} | Code d'état | Description | |-|-| | 200 | Réussi. La demande a été correctement traitée. | [Tableau 36. Codes d'état] ### Paramètres de corps de réponse (JSON) {#agnt_clnt_cll-GET-check_defs-list__entry__30}{#agnt_clnt_cll-GET-check_defs-list__accCkDf-background-desc-ph}{#agnt_clnt_cll-GET-check_defs-list__accCkDf-chkGrp-desc-ph}{#agnt_clnt_cll-GET-check_defs-list__accCkDf-chkTyp-desc-ph}{#agnt_clnt_cll-GET-check_defs-list__accCkDf-command-desc-ph}{#agnt_clnt_cll-GET-check_defs-list__accCkDf-name-desc-ph}{#agnt_clnt_cll-GET-check_defs-list__accCkDf-p-desc-ph}{#agnt_clnt_cll-GET-check_defs-list__accCkDf-p-active-desc-ph}{#agnt_clnt_cll-GET-check_defs-list__accCkDf-p-default-desc-ph}{#agnt_clnt_cll-GET-check_defs-list__accCkDf-p-mando-desc-ph}{#agnt_clnt_cll-GET-check_defs-list__accCkDf-p-name-desc-ph}{#agnt_clnt_cll-GET-check_defs-list__accCkDf-p-id-desc-ph}{#agnt_clnt_cll-GET-check_defs-list__accCkDf-plugins-desc-ph}{#agnt_clnt_cll-GET-check_defs-list__accCkDf-proxy-desc-ph}{#agnt_clnt_cll-GET-check_defs-list__accCkDf-sp-desc-ph}{#agnt_clnt_cll-GET-check_defs-list__accCkDf-sp-active-desc-ph}{#agnt_clnt_cll-GET-check_defs-list__accCkDf-sp-name-desc-ph}{#agnt_clnt_cll-GET-check_defs-list__accCkDf-sp-order-desc-ph}{#agnt_clnt_cll-GET-check_defs-list__accCkDf-sp-id-desc-ph}{#agnt_clnt_cll-GET-check_defs-list__accCkDf-id-desc-ph}{#agnt_clnt_cll-GET-check_defs-list__accCkDf-timeout-desc-ph} | Nom | Description | |-|-| | Définitions des vérifications | Liste des définitions et détails de vérification fournis en tant qu'objets 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 } ] Type de données : tableau | | arrière-plan | Marqueur indiquant si cette définition de vérification est une vérification d'antécédents. Une vérification des antécédents est une vérification que l'agent commence à exécuter sans attendre qu'elle se termine. Valeurs valides : * true : cette définition de vérification est une vérification d'arrière-plan. * false : cette définition de vérification n'est pas une vérification des antécédents. {#agnt_clnt_cll-GET-check_defs-list__ul_ypb_5ps_5qb} Type de données : booléennes | | check_group | Groupe spécifié pour cette définition de vérification. Type de données : chaîne | | check_type | Type de vérification. Valeurs possibles : * Événements : vérifiez que les résultats sont transformés en événement de gestion des événements. * Mesures : les valeurs du résultat de vérification sont transformées en mesures. {#agnt_clnt_cll-GET-check_defs-list__ul_gtr_kfb_wqb} Type de données : chaîne | | commande | Commande exécutée Agent Client Collector . Type de données : chaîne | | nom | Nom du chèque. Type de données : chaîne | | paramètres | Liste des définitions de paramètres associées à la définition de vérification. Ces résultats ne sont inclus que si le withParams paramètre est défini sur vrai. "params": [ { "active": Boolean, "default_value": "String", "mandatory": Boolean, "name": "String", "sys_id": "String" } ] {#agnt_clnt_cll-GET-check_defs-list__accCkDf-p-code} Type de données : tableau | | params.active | Marqueur indiquant si le paramètre de vérification est actif. Valeurs valides : * true : le paramètre de vérification est actif. * false : le paramètre check est inactif. {#agnt_clnt_cll-GET-check_defs-list__ul_pnb_jyc_wqb} Type de données : booléennes | | params.default_value | Spécifie la valeur par défaut de ce paramètre de vérification. Type de données : chaîne | | params.mandatory | Marqueur indiquant si le paramètre de vérification est requis. Valeurs valides : * true : le paramètre check est requis. * false : le paramètre check est facultatif. {#agnt_clnt_cll-GET-check_defs-list__ul_wtg_2zc_wqb} Type de données : booléennes | | params.name | Nom du paramètre de vérification. Type de données : chaîne | | params.sys_id | Sys_id du paramètre de vérification répertorié dans la table Vérifier les définitions de paramètres sécurisés \[sn_agent_check_param_def\]. Type de données : chaîne | | modules d'extension | Liste des [Agent Client Collector modules d'extension](https://www.servicenow.com/docs/access?context=acc-assets&version=xanadu&pubname=xanadu-it-operations-management&ft:locale=en-US) associés à cette vérification. Type de données : tableau | | proxy_valid | Marqueur indiquant si la politique de définition de vérification est définie pour fonctionner en tant que proxy. Valeurs valides : * true : cette politique de définition de vérification est définie pour fonctionner en tant que proxy. * false : cette politique de définition de vérification n'est pas définie pour fonctionner en tant que proxy. {#agnt_clnt_cll-GET-check_defs-list__ul_wbf_qps_5qb} Type de données : booléennes | | secure_params | Liste des éléments affectés à ce chèque. Ces résultats ne sont inclus que si le withParams paramètre est défini sur vrai. "secure_params": [ { "active": Boolean, "name": "String", "order": Number, "sys_id": "String" } ] {#agnt_clnt_cll-GET-check_defs-list__accCkDf-sp-code} Type de données : tableau | | secure_params.active | Marqueur indiquant si le paramètre sécurisé est actif. Valeurs valides : * true : le paramètre sécurisé est actif. * faux : le paramètre sécurisé est inactif. {#agnt_clnt_cll-GET-check_defs-list__ul_g1b_3vc_wqb} Type de données : booléennes | | secure_params.name | Nom du paramètre sécurisé. Type de données : chaîne | | secure_params.commande | Ordre dans lequel le paramètre est envoyé à la commande/au script de vérification. Type de données : nombre | | secure_params.sys_id | Sys_id du paramètre sécurisé répertorié dans la table Vérifier les définitions de paramètres sécurisés \[sn_agent_check_secure_param_def\]. Type de données : chaîne | | sys_id | Sys_id de la définition de vérification répertoriée dans la table Définitions de vérification \[sn_agent_check_def\]. Type de données : chaîne | | timeout | Délai en secondes. Type de données : nombre | [ ] ### Demande cURL L'exemple suivant montre comment récupérer une liste de deux définitions de vérification avec des valeurs de paramètres. curl "https://instance.service-now.com/api/sn_agent/agents/check_defs/list" \ --request GET \ --header "Accept:application/json" \ --user 'username':'password' Sortie : { "check_definitions": [ { "name": "checks_api_test", "command": "echo hello", "plugins": [], "timeout": 9, "proxy_valid": true, "background": false, "check_type": "TestCheck", "check_group": "computer", "sys_id": "7f1f9026dba530106f4810284b96194f", "params": [], "secure_params": [ { "name": "check_api_test_check_secure_param2", "active": true, "order": 2, "sys_id": "2d30a066dba530106f4810284b9619c1" }, { "name": "check_api_test_check_secure_param1", "active": true, "order": 100, "sys_id": "4c20a066dba530106f4810284b9619a8" } ] }, { "name": "checks_api_test222", "command": "echo hello1212121", "plugins": [], "timeout": 60, "proxy_valid": true, "background": false, "check_type": "TestCheck", "check_group": "computer", "sys_id": "99e12466dba530106f4810284b961976", "params": [ { "name": "check_api_test_check_param_222", "active": true, "mandatory": false, "default_value": "test_test_test", "sys_id": "44026466dba530106f4810284b9619b2" } ], "secure_params": [] } ] } ## Agent Client Collector : GET /agents/exec/background/stop/{request_id} {#ariaid-title8} Arrête une vérification des antécédents. Pour lancer une vérification des antécédents, utilisez l'API POST /agents/check_defs/{check_def_id}/run . ### Format d'URL /api/sn_agent/agents/exec/background/stop/{request_id} ### Paramètres de demande pris en charge {#agnt_clnt_cll-GET-exec-bkgrd-stop__entry__2} | Nom | Description | |-|-| | request_id | ID d'une demande de vérification des antécédents générée par l'exécution de l'API POST /agents/check_defs/{check_def_id}/run . | [Tableau 37. Paramètres de chemin d'accès] {#agnt_clnt_cll-GET-exec-bkgrd-stop__entry__6} | Nom | Description | |-|-| | Aucun | | [Tableau 38. Paramètres de requête] {#agnt_clnt_cll-GET-exec-bkgrd-stop__entry__10} | Nom | Description | |-|-| | Aucun | | [Tableau 39. Paramètres du corps de la demande (JSON)] ### En-têtes Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l'API REST, consultez [En-têtes d'API REST pris en charge](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres."). {#agnt_clnt_cll-GET-exec-bkgrd-stop__entry__14}{#agnt_clnt_cll-GET-exec-bkgrd-stop__accept-JSON-only-entry-RESTAPI} | En-tête | Description | |-|-| | Accepter | Format de données du corps de la réponse. Prend uniquement en charge application/json. | [Tableau 40. En-têtes de demandes] {#agnt_clnt_cll-GET-exec-bkgrd-stop__entry__18} | En-tête | Description | |-|-| | Aucun | | [Tableau 41. En-têtes de réponses] ### Codes d'état Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d'état possibles utilisés dans l'API REST, consultez [Codes de réponse HTTP de l'API REST](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres."). {#agnt_clnt_cll-GET-exec-bkgrd-stop__entry__22}{#agnt_clnt_cll-GET-exec-bkgrd-stop__entry-200-status-code} | Code d'état | Description | |-|-| | 200 | Réussi. La demande a été correctement traitée. | | 404 | La demande avec l'ID fourni est introuvable. | [Tableau 42. Codes d'état] ### Paramètres de corps de réponse (JSON) {#agnt_clnt_cll-GET-exec-bkgrd-stop__entry__28} | Nom | Description | |-|-| | Aucun | | [ ] ### Demande cURL L'exemple suivant montre comment arrêter une vérification des antécédents. curl "https://instance.service-now.com/api/sn_agent/agents/exec/background/stop/02359174db2a30108a0751f4f3961997" \ --request GET \ --header "Accept:application/json" \ --user 'username':'password' ## Agent Client Collector : GET /agents/exec/run/{request_id} {#ariaid-title9} Obtient l'état de la demande avec l'ID donné. ### Format d'URL /api/sn_agent/agents/exec/run/{request_id} ### Paramètres de demande pris en charge {#agnt_clnt_cll-GET-exec-run__table_vmf_44q_wqb__entry__2} | Nom | Description | |-|-| | request_id | ID d'une demande de vérification des antécédents générée par l'exécution de l'API POST /agents/check_defs/{check_def_id}/run . | [Tableau 43. Paramètres de chemin d'accès] {#agnt_clnt_cll-GET-exec-run__table_vmf_44q_wqb} {#agnt_clnt_cll-GET-exec-run__entry__6} | Nom | Description | |-|-| | Aucun | | [Tableau 44. Paramètres de requête] {#agnt_clnt_cll-GET-exec-run__entry__10} | Nom | Description | |-|-| | Aucun | | [Tableau 45. Paramètres du corps de la demande (JSON)] ### En-têtes Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l'API REST, consultez [En-têtes d'API REST pris en charge](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres."). {#agnt_clnt_cll-GET-exec-run__entry__14}{#agnt_clnt_cll-GET-exec-run__accept-JSON-only-entry-RESTAPI} | En-tête | Description | |-|-| | Accepter | Format de données du corps de la réponse. Prend uniquement en charge application/json. | [Tableau 46. En-têtes de demandes] {#agnt_clnt_cll-GET-exec-run__entry__18} | En-tête | Description | |-|-| | Aucun | | [Tableau 47. En-têtes de réponses] ### Codes d'état Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d'état possibles utilisés dans l'API REST, consultez [Codes de réponse HTTP de l'API REST](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres."). {#agnt_clnt_cll-GET-exec-run__table_zdx_xmq_wqb__entry__2}{#agnt_clnt_cll-GET-exec-run__entry-200-status-code} | Code d'état | Description | |-|-| | 200 | Réussi. La demande a été correctement traitée. | | 202 | Message avec l'ID fourni indiquant que la demande est en cours. | | 400 | Erreur dans les arguments fournis dans le corps de la demande. | | 404 | La demande avec l'ID fourni est introuvable. | | 408 | Délai d'exécution de la demande avec l'ID fourni. | | 500 | Erreur lors de la vérification de l'état de la demande avec l'ID fourni. | [Tableau 48. Codes d'état] {#agnt_clnt_cll-GET-exec-run__table_zdx_xmq_wqb} ### Paramètres de corps de réponse (JSON) {#agnt_clnt_cll-GET-exec-run__entry__36} | Nom | Description | |-|-| | statut | État de la demande. Valeurs possibles : * Terminé : la vérification a réussi. * échec : la vérification a échoué. Voir le message d'erreur pour plus de détails. * mid_flow : la sortie de la demande est gérée par le MID Server. * Traitement : la vérification est en cours. * timeout : vérifiez que le traitement a dépassé la limite de temps définie dans la méthode runCheckForCis(). {#agnt_clnt_cll-GET-exec-run__ul_edm_1rr_5qb} Type de données : chaîne | | err_msg | Message d'erreur le cas échéant. Valeurs possibles : * Aucun agent trouvé pour les CI appropriés. * Aucune demande de vérification des antécédents avec l'ID fourni. * Aucune demande avec l'ID fourni. * Aucun résultat de test avec l'ID fourni. * Délai d'expiration de la demande. {#agnt_clnt_cll-GET-exec-run__ul_qcf_zcq_5qb} Type de données : chaîne | [ ] ### Demande cURL L'exemple suivant montre comment obtenir l'état d'une demande. curl "https://instance.service-now.com/api/sn_agent/agents/exec/run/12fed13cdb2a30108a0751f4f3961981" \ --request GET \ --header "Accept:application/json" \ --user 'username':'password' ## Agent Client Collector : GET /agents/exec/test/{test_result_id} {#ariaid-title10} Obtient l'état de vérification du test du résultat du test donné. ### Format d'URL /api/sn_agent/agents/exec/test/{test_result_id} ### Paramètres de demande pris en charge {#agnt_clnt_cll-GET-exec-test-result__entry__2} | Nom | Description | |-|-| | test_result_id | ID de résultat de test généré par la création d'une demande de contrôle de test. | [Tableau 49. Paramètres de chemin d'accès] {#agnt_clnt_cll-GET-exec-test-result__entry__6} | Nom | Description | |-|-| | Aucun | | [Tableau 50. Paramètres de requête] {#agnt_clnt_cll-GET-exec-test-result__entry__10} | Nom | Description | |-|-| | Aucun | | [Tableau 51. Paramètres du corps de la demande (JSON)] ### En-têtes Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l'API REST, consultez [En-têtes d'API REST pris en charge](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres."). {#agnt_clnt_cll-GET-exec-test-result__entry__14}{#agnt_clnt_cll-GET-exec-test-result__accept-JSON-only-entry-RESTAPI} | En-tête | Description | |-|-| | Accepter | Format de données du corps de la réponse. Prend uniquement en charge application/json. | [Tableau 52. En-têtes de demandes] {#agnt_clnt_cll-GET-exec-test-result__entry__18} | En-tête | Description | |-|-| | Aucun | | [Tableau 53. En-têtes de réponses] ### Codes d'état Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d'état possibles utilisés dans l'API REST, consultez [Codes de réponse HTTP de l'API REST](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres."). {#agnt_clnt_cll-GET-exec-test-result__entry__22}{#agnt_clnt_cll-GET-exec-test-result__entry-200-status-code} | Code d'état | Description | |-|-| | 200 | Réussi. La demande a été correctement traitée. | | 202 | Message avec l'ID fourni indiquant que la demande est en cours. | | 404 | La demande avec l'ID fourni est introuvable. | | 408 | Délai d'exécution de la demande avec l'ID fourni. | | 500 | Erreur lors de la vérification de l'état de la demande avec l'ID fourni. | [Tableau 54. Codes d'état] ### Paramètres de corps de réponse (JSON) {#agnt_clnt_cll-GET-exec-test-result__entry__34} | Propriétés | Description | |-|-| | statut | État des résultats des tests. Valeurs possibles : * 0 : en attente * 1 : En cours * 2 : Terminé * 3 : Aucun résultat de test avec l'ID fourni {#agnt_clnt_cll-GET-exec-test-result__ul_yyq_4bq_5qb} Type de données : chaîne | | sortie | Sortie décrivant l'état. Type de données : chaîne | [ ] ### Demande cURL L'exemple suivant montre comment obtenir l'état du résultat d'une demande de vérification de test terminée. curl "https://instance.service-now.com/api/sn_agent/agents/check_instances/99e12466dba530106f4810284b961976/test" \ --request POST \ --header "Accept:application/json" \ --user 'username':'password' ## Agent Client Collector : GET /agents/list {#ariaid-title11} Obtient une liste d'agents contenant des informations connexes. ### Format d'URL /api/sn_agent/agents/liste ### Paramètres de demande pris en charge {#agnt_clnt_cll-GET-list__entry__2} | Nom | Description | |-|-| | Aucun | | [Tableau 55. Paramètres de chemin d'accès] {#agnt_clnt_cll-GET-list__entry__6} | Nom | Description | |-|-| | Aucun | | [Tableau 56. Paramètres de requête] {#agnt_clnt_cll-GET-list__entry__10} | Nom | Description | |-|-| | Aucun | | [Tableau 57. Paramètres du corps de la demande (JSON)] ### En-têtes Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l'API REST, consultez [En-têtes d'API REST pris en charge](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres."). {#agnt_clnt_cll-GET-list__entry__14}{#agnt_clnt_cll-GET-list__accept-JSON-only-entry-RESTAPI} | En-tête | Description | |-|-| | Accepter | Format de données du corps de la réponse. Prend uniquement en charge application/json. | | requête x-enc | Requête codée sur la table Agent Client Collectors \[sn_agent_cmdb_ci_agent\] au format Glide standard. [Reportez-vous à la section Chaînes de requêtes codées](https://www.servicenow.com/docs/access?context=c_EncodedQueryStrings&version=xanadu&pubname=xanadu-platform-user-interface&ft:locale=en-US). | | X-Limit (Limite X) | Limite les résultats à un nombre maximal d'agents. Utilisez null ou undefined pour les deux s'ils ne sont pas obligatoires. Par défaut/max : 20 000 Type de données : nombre | [Tableau 58. En-têtes de demandes] {#agnt_clnt_cll-GET-list__entry__22} | En-tête | Description | |-|-| | Aucun | | [Tableau 59. En-têtes de réponses] ### Codes d'état Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d'état possibles utilisés dans l'API REST, consultez [Codes de réponse HTTP de l'API REST](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres."). {#agnt_clnt_cll-GET-list__table_vxl_353_dpb__entry__2}{#agnt_clnt_cll-GET-list__entry-200-status-code}{#agnt_clnt_cll-GET-list__agntCC-desc-403-user} | Code d'état | Description | |-|-| | 200 | Réussi. La demande a été correctement traitée. | | 403 | L'utilisateur n'a pas le rôle agent_client_collector_user. | [Tableau 60. Codes d'état] {#agnt_clnt_cll-GET-list__table_vxl_353_dpb} ### Paramètres de corps de réponse (JSON) {#agnt_clnt_cll-GET-list__entry__32}{#agnt_clnt_cll-GET-list__accAgents-parm-agent-obj-id-entry}{#agnt_clnt_cll-GET-list__accAgents-parm-agent-obj-dataCollect-entry}{#agnt_clnt_cll-GET-list__accAgents-parm-agent-obj-ip-entry}{#agnt_clnt_cll-GET-list__accAgents-parm-agent-obj-dup-entry}{#agnt_clnt_cll-GET-list__accAgents-parm-agent-obj-restart-entry}{#agnt_clnt_cll-GET-list__accAgents-parm-agent-obj-name-entry}{#agnt_clnt_cll-GET-list__accAgents-parm-agent-obj-numChecks-entry}{#agnt_clnt_cll-GET-list__accAgents-parm-agent-obj-status-entry}{#agnt_clnt_cll-GET-list__accAgents-parm-agent-obj-up-entry}{#agnt_clnt_cll-GET-list__accAgents-parm-agent-obj-version-entry} | Propriété | Description | |-|-| | \ | Tableau d'objets JSON contenant des informations étendues sur l'agent. [ { "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 de l'agent tel que soumis. Type de données : chaîne | | data_collection | La collecte de données indique si des vérifications planifiées doivent être exécutées. Ces vérifications font partie des politiques planifiées pour l'exécution de cet agent. Valeurs possibles : * 0 : Activé : les vérifications s'exécutent comme prévu. * 1 : Désactivé (manuel) -- Les vérifications ont été désactivées manuellement. * 2 : Désactivé (auto) -- Les vérifications ont été désactivées automatiquement en raison de la consommation élevée du processeur par le {#agnt_clnt_cll-GET-list__ul_w4n_53p_bpb} Type de données : nombre | | ip_address | Adresse IP de l'agent. Type de données : chaîne | | is_duplicate | Marqueur indiquant si cet agent est un doublon d'un autre. Il ne doit y avoir qu'un seul agent sur un hôte donné. Valeurs possibles : * true : l'agent a le même hôte qu'un agent Alive/Up avec un ID d'agent différent. Désactiver ou désinstaller le doublon * false : cet agent n'a aucun doublon à l'état Actif/En service. {#agnt_clnt_cll-GET-list__ul_b34_ffl_bpb} Type de données : booléennes | | is_restart_enabled | Marqueur indiquant si le redémarrage est activé. Le redémarrage de l'agent n'est pas configurable. Cela dépend du système d'exploitation et de la version du système d'exploitation sur lequel l'agent s'exécute. Valeurs possibles : * Vrai : le redémarrage est activé pour cet agent. * faux : le redémarrage est désactivé pour cet agent. {#agnt_clnt_cll-GET-list__ul_bvp_dfl_bpb} Type de données : booléennes | | nom | Nom de l'agent. Type de données : chaîne | | number_of_running_checks | Nombre de vérifications que l'agent doit exécuter. Ces vérifications font partie des politiques planifiées pour l'exécution de cet agent. Type de données : nombre | | statut | État de l'agent. Valeurs possibles : * 0 : actif/actif -- L'agent est actif. * 1 : Avertissement : l'agent n'a pas reçu de message de maintien de connexion au cours des dernières minutes. * 2 : En panne -- L'agent n'a pas reçu de message de maintien depuis longtemps. * 3 : Redémarrage -- L'agent est en cours de redémarrage. {#agnt_clnt_cll-GET-list__ul_adg_ffp_bpb} Type de données : nombre | | up_since | Temps UTC depuis que l'état de l'agent est activé/opérationnel. La valeur est au format [GlideDateTime](https://servicenow-prod.fluidtopics.net/JgJ6~NAVmsxzolCUQ1ybvw#c_GlideDateTimeScoped "La classe GlideDateTime incluse dans le champ d’application fournit des méthodes permettant d’effectuer des opérations sur les objets GlideDateTime.") . Type de données : chaîne | | version | Version de l'agent en cours d'exécution Agent Client Collector . Type de données : chaîne | [ ] ### Demande cURL L'exemple suivant montre comment restreindre les résultats par requête et par numéro. La requête renvoie tous les agents qui ne sont pas dans l'état Indisponibilité avec un maximum de deux résultats. 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' Sortie : { "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" } ] } ### Demande cURL {#agnt_clnt_cll-GET-list__example_es5_ycj_dpb} L'exemple suivant montre comment répertorier tous les agents du système. Cet exemple n'utilise aucune requête et aucun nombre maximum de résultats. curl "https://instance.service-now.com/api/sn_agent/agents/list" \ --request GET \ --header "Accept:application/json" \ --user 'username':'password' ## Agent Client Collector : GET /agents/{agent_id}/log {#ariaid-title12} Demande le journal d'un agent spécifié avec l'état actif/actif. Remarque : Pour récupérer le journal et vérifier sa progression, transmettez l'ID de demande renvoyé au point de terminaison GET /agents/log/{request_id}/ . ### Format d'URL {#agnt_clnt_cll-GET-log__section_kpf_zyc_z4b} /api/sn_agent/agents/{agent_id}/log ### Paramètres de demande pris en charge {#agnt_clnt_cll-GET-log__section_ewl_zyc_z4b} {#agnt_clnt_cll-GET-log__table_oyt_cd3_dpb__entry__2} | Nom | Description | |-|-| | agent_id | ID unique d'un agent répertorié dans la colonne ID d'agent de la table Agent Client Collectors \[sn_agent_cmdb_ci_agent\]. Pour obtenir une liste des ID d'agents et d'autres détails, exécutez le point de terminaison GET /agents/list . Type de données : chaîne | [Tableau 61. Paramètres de chemin d'accès] {#agnt_clnt_cll-GET-log__table_oyt_cd3_dpb} {#agnt_clnt_cll-GET-log__table_gwl_zyc_z4b__entry__2} | Nom | Description | |-|-| | Aucun | | [Tableau 62. Paramètres de requête] {#agnt_clnt_cll-GET-log__table_gwl_zyc_z4b} {#agnt_clnt_cll-GET-log__table_hwl_zyc_z4b__entry__2} | Nom | Description | |-|-| | Aucun | | [Tableau 63. Paramètres du corps de la demande (JSON)] {#agnt_clnt_cll-GET-log__table_hwl_zyc_z4b} ### En-têtes {#agnt_clnt_cll-GET-log__section_iwl_zyc_z4b} Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l'API REST, consultez [En-têtes d'API REST pris en charge](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres."). {#agnt_clnt_cll-GET-log__table_jwl_zyc_z4b__entry__2}{#agnt_clnt_cll-GET-log__accept-JSON-only-entry-RESTAPI} | En-tête | Description | |-|-| | Accepter | Format de données du corps de la réponse. Prend uniquement en charge application/json. | [Tableau 64. En-têtes de demandes] {#agnt_clnt_cll-GET-log__table_jwl_zyc_z4b} {#agnt_clnt_cll-GET-log__table_kwl_zyc_z4b__entry__2} | En-tête | Description | |-|-| | Aucun | | [Tableau 65. En-têtes de réponses] {#agnt_clnt_cll-GET-log__table_kwl_zyc_z4b} ### Codes d'état {#agnt_clnt_cll-GET-log__section_lwl_zyc_z4b} Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d'état possibles utilisés dans l'API REST, consultez [Codes de réponse HTTP de l'API REST](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres."). {#agnt_clnt_cll-GET-log__table_y2n_2f3_dpb__entry__2}{#agnt_clnt_cll-GET-log__entry-200-status-code}{#agnt_clnt_cll-GET-log__agntCC-desc-403-admin} | Code d'état | Description | |-|-| | 200 | Réussi. La demande a été correctement traitée. | | 403 | L'utilisateur n'a pas le rôle agent_client_collector_admin. | | 404 | L'agent est introuvable ou n'est pas dans l'état actif/actif. | [Tableau 66. Codes d'état] {#agnt_clnt_cll-GET-log__table_y2n_2f3_dpb} ### Paramètres de corps de réponse (JSON) {#agnt_clnt_cll-GET-log__section_upf_zyc_z4b} {#agnt_clnt_cll-GET-log__table_vpf_zyc_z4b__entry__2} | Nom | Description | |-|-| | request_id | Sys_id d'une demande dans la table Demandes d'Agent Client Collector \[sn_agent_request\]. Vous pouvez utiliser cet ID pour récupérer le journal et vérifier sa progression avec le point de terminaison GET /agents/log/{request_id}/ . Type de données : chaîne | [ ] {#agnt_clnt_cll-GET-log__table_vpf_zyc_z4b} ### Demande cURL L'exemple suivant montre comment obtenir un ID de demande de journal. curl "https://instance.service-now.com/api/sn_agent/agents//log" \ --request GET \ --header "Accept:application/json" \ --user 'username':'password' Sortie : "request_id": "" ## Agent Client Collector : GET /agents/log/{request_id}/ {#ariaid-title13} Vérifie l'état d'une demande de journal de capture. Détecte les changements dans le journal de la demande de récupération envoyée avec GET /api/sn_agent/agents/{agent_id}/log. ### Format d'URL /api/sn_agent/agents/log/{request_id}/ ### Paramètres de demande pris en charge {#agnt_clnt_cll-GET-log-request_id__entry__2} | Nom | Description | |-|-| | request_id | Sys_id d'une demande dans la table Demandes d'Agent Client Collector \[sn_agent_request\]. Pour l'ID de demande, exécutez GET /api/sn_agent/agents/{agent_id}/log. Type de données : chaîne | [Tableau 67. Paramètres de chemin d'accès] {#agnt_clnt_cll-GET-log-request_id__entry__6} | Nom | Description | |-|-| | Aucun | | [Tableau 68. Paramètres de requête] {#agnt_clnt_cll-GET-log-request_id__entry__10} | Nom | Description | |-|-| | Aucun | | [Tableau 69. Paramètres du corps de la demande (JSON)] ### En-têtes Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l'API REST, consultez [En-têtes d'API REST pris en charge](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres."). {#agnt_clnt_cll-GET-log-request_id__entry__14}{#agnt_clnt_cll-GET-log-request_id__accept-JSON-only-entry-RESTAPI} | En-tête | Description | |-|-| | Accepter | Format de données du corps de la réponse. Prend uniquement en charge application/json. | [Tableau 70. En-têtes de demandes] {#agnt_clnt_cll-GET-log-request_id__entry__18} | En-tête | Description | |-|-| | Aucun | | [Tableau 71. En-têtes de réponses] ### Codes d'état {#agnt_clnt_cll-GET-log-request_id__section_lwl_zyc_z4b} Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d'état possibles utilisés dans l'API REST, consultez [Codes de réponse HTTP de l'API REST](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres."). {#agnt_clnt_cll-GET-log-request_id__table_y2n_2f3_dpb__entry__2}{#agnt_clnt_cll-GET-log-request_id__agntCC-desc-403-admin} | Code d'état | Description | |-|-| | 200 | L'état de la demande est terminé et le journal récupéré est prêt. | | 202 | La demande de récupération du journal avec l'ID fourni est toujours en cours. | | 403 | L'utilisateur n'a pas le rôle agent_client_collector_admin. | | 404 | Demande de journal de saisie avec l'ID fourni introuvable. | | 408 | La demande de journal de saisie a expiré. | | 500 | La demande de journal de capture a rencontré une erreur. | [Tableau 72. Codes d'état] {#agnt_clnt_cll-GET-log-request_id__table_y2n_2f3_dpb} ### Paramètres de corps de réponse (JSON) {#agnt_clnt_cll-GET-log-request_id__entry__36} | Propriétés | Description | |-|-| | sortie | Informations décrivant l'état. | [ ] ### Demande cURL L'exemple suivant montre comment utiliser un ID de demande pour obtenir l'état d'une demande de journal de capture. curl "https://instance.service-now.com/api/sn_agent/agents/log/" \ --request GET \ --header "Accept:application/json" \ --user 'username':'password' Sortie : { "output": "SensuSnReadFile OK: {\"component\":\"agent\",\"level\":\"info\",\"msg\":\"Agent Protection: cpu of all checks: 0%\",\"time\":\"2021-04-05T00:21:41-07:00\"},... } ## Agent Client Collector : GET /agents/policies/list {#ariaid-title14} Obtient une liste des politiques qui sont à l'état de brouillon publié ou non publié. ### Format d'URL /api/sn_agent/agents/politiques/liste ### Paramètres de demande pris en charge {#agnt_clnt_cll-GET-policies-list__entry__2} | Nom | Description | |-|-| | Aucun | | [Tableau 73. Paramètres de chemin d'accès] {#agnt_clnt_cll-GET-policies-list__entry__6} | Nom | Description | |-|-| | Aucun | | [Tableau 74. Paramètres de requête] {#agnt_clnt_cll-GET-policies-list__entry__10} | Nom | Description | |-|-| | Aucun | | [Tableau 75. Paramètres du corps de la demande (JSON)] ### En-têtes Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l'API REST, consultez [En-têtes d'API REST pris en charge](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres."). {#agnt_clnt_cll-GET-policies-list__table_d1q_x5w_dpb__entry__2}{#agnt_clnt_cll-GET-policies-list__accept-JSON-only-entry-RESTAPI} | En-tête | Description | |-|-| | Accepter | Format de données du corps de la réponse. Prend uniquement en charge application/json. | | requête x-enc | Facultatif. Chaîne de requête codée au format Glide standard. [Reportez-vous à la section Chaînes de requêtes codées](https://www.servicenow.com/docs/access?context=c_EncodedQueryStrings&version=xanadu&pubname=xanadu-platform-user-interface&ft:locale=en-US). | | X-Include-Check-Params | Facultatif. Marqueur indiquant s'il faut renvoyer les instances de vérification et leurs paramètres dans les résultats. Valeurs valides : * true : inclut les instances de vérification et leurs paramètres dans les résultats. * false : n'incluez pas les instances de vérification et leurs paramètres dans les résultats. {#agnt_clnt_cll-GET-policies-list__ul_xmj_pyw_dpb} Valeur par défaut : false Type de données : booléennes | | X-Include-Vérifications-et-agents | Facultatif. Marqueur indiquant s'il faut inclure des instances et des agents de vérification dans les résultats. Valeurs valides : * true : inclut les instances de vérification et les agents dans les résultats. * faux : n'incluez pas les chèques et les agents dans les résultats. {#agnt_clnt_cll-GET-policies-list__ul_asz_gvw_dpb} Valeur par défaut : false Type de données : booléennes | [Tableau 76. En-têtes de demandes] {#agnt_clnt_cll-GET-policies-list__table_d1q_x5w_dpb} {#agnt_clnt_cll-GET-policies-list__table_abd_scx_dpb__entry__2} | En-tête | Description | |-|-| | Aucun | | [Tableau 77. En-têtes de réponses] {#agnt_clnt_cll-GET-policies-list__table_abd_scx_dpb} ### Codes d'état {#agnt_clnt_cll-GET-policies-list__section_bbd_scx_dpb} Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d'état possibles utilisés dans l'API REST, consultez [Codes de réponse HTTP de l'API REST](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres."). {#agnt_clnt_cll-GET-policies-list__table_tmf_2gr_z4b__entry__2}{#agnt_clnt_cll-GET-policies-list__entry-200-status-code}{#agnt_clnt_cll-GET-policies-list__agntCC-desc-403-user} | Code d'état | Description | |-|-| | 200 | Réussi. La demande a été correctement traitée. | | 403 | L'utilisateur n'a pas le rôle agent_client_collector_user. | [Tableau 78. Codes d'état] {#agnt_clnt_cll-GET-policies-list__table_tmf_2gr_z4b} ### Paramètres de corps de réponse (JSON) {#agnt_clnt_cll-GET-policies-list__entry__34}{#agnt_clnt_cll-GET-policies-list__agntCC-ph-rb-checks-sbox} | Propriété | Description | |-|-| | politiques | Liste des politiques récupérées. Inclut les vérifications et l'agent dans les résultats s'ils sont interrogés à l'aide d'en-têtes de demande spécifiques. Pour plus d'informations sur les stratégies, consultez [Vérifications et politiques par défaut](https://www.servicenow.com/docs/access?context=agent-policies-checks&version=xanadu&pubname=xanadu-it-operations-management&ft:locale=en-US). { "policies": [ { "active": Boolean, "agent_ids": "String", "checks": [Array], "cred_alias": "String", "credential_alias": "String", "filter": "String", "interval": "Number", "monitored_ci_group": "String", "monitored_ci_script": "String", "monitored_ci_type_filter": Boolean, "monitored_ci_type_group": Boolean, "monitored_ci_type_script": "String", "name": "String", "params": [Array], "publish_status": "String", "secure_params": [Array], "sys_id": "String", "sys_updated_on": "String", "table": "String" } ] } Type de données : tableau | | politiques.actives | Marqueur indiquant si la politique est active. Valeurs valides : * true : la politique est active. * faux : la politique n'est pas active. {#agnt_clnt_cll-GET-policies-list__ul_qr2_g3x_dpb} Type de données : booléennes | | policies.agent_ids | ID unique d'un agent répertorié dans la colonne ID d'agent de la table Agent Client Collectors \[sn_agent_cmdb_ci_agent\]. Ces résultats s'affichent uniquement si le paramètre d'en-tête X-Include-Checks-And-Agents est défini sur vrai. Pour obtenir des informations étendues sur un agent, exécutez l'ID dans le point de terminaison [GET /agents/{agent_id}](https://servicenow-prod.fluidtopics.net/QEP8zRm1ZTNaxaPmVG9qAg#agnt_clnt_cll-GET-agent_id "Obtient les informations d’un agent spécifié.") . | | politiques.vérifications | Liste des objets définissant les vérifications répertoriés dans la table Instances de vérification \[sn_agent_check\]. Ces résultats ne s'affichent que si le paramètre d'en-tête X-Include-Checks-And-Agents ou X-Include-Check-Params est défini sur true. Type de données : tableau d'objets "checks": [ { "active": Boolean, "auto_generate": Boolean, "check_type": "String" "command_prefix": "String", "command": "String", "event_status_change_threshold": Number, "event_status_repair_threshold": Number, "interval": Number, "name": "String", "sys_id": "String", "timeout": "String" } ] {#agnt_clnt_cll-GET-policies-list__agntCC-code-rb-checks-sbox} | | policies.checks.active | Marqueur indiquant si la vérification de la politique est active. Valeurs valides : * true : la vérification de la politique est active. * false : la vérification de la politique est inactive. {#agnt_clnt_cll-GET-policies-list__ul_j2p_sdt_2pb} Type de données : booléennes | | policies.checks.auto_generate | Marqueur indiquant s'il faut générer automatiquement la commande avec la command_prefix valeur. Valeurs valides : * vrai : renseigne automatiquement la propriété avec les valeurs de command paramètres actives. * false : la commande n'est pas générée automatiquement. {#agnt_clnt_cll-GET-policies-list__ul_myc_x2t_2pb} Type de données : booléennes | | policies.checks.check_type | Type de vérification spécifiant l'option de surveillance. Valeurs possibles : * Détection : vérifie qui localise les CI associés à l'agent. * Événements : le résultat de la vérification est transformé en événement de gestion des événements. * Mesures : les valeurs du résultat de vérification sont transformées en mesures. {#agnt_clnt_cll-GET-policies-list__ul_pgd_42t_2pb} Type de données : chaîne | | politiques.vérifications.commande | Commande exécutée Agent Client Collector . Paramètre extrait d'un modèle ou d'un CI surveillé. Remarque : Si auto_generate la valeur est vrai, cette propriété est automatiquement renseignée avec le préfixe et les marqueurs des paramètres actifs répertoriés dans l'objet parameters . Type de données : chaîne | | policies.checks.command_prefix | Si la propriété est true, cette commande est utilisée pour la auto_generate génération automatique. Le préfixe se compose d'une partie de la commande statique (qui ne change pas), telle que le nom du script. Type de données : chaîne | | policies.checks.event_status_change_threshold | Nombre de fois consécutives où l'état de la réponse d'un chèque doit se produire avant qu'un nouvel événement ne soit envoyé. Renvoie null s'il n'est pas défini. Par exemple, si cette valeur est égale à 3, une vérification dont l'état de la réponse passe de OK à Erreur génère un nouvel événement avec un état Erreur après la troisième occurrence consécutive du changement d'état. Type de données : nombre | | policies.checks.event_status_repair_threshold | Nombre de fois consécutives où l'état de la réponse d'une vérification doit s'améliorer pour fermer l'événement précédent. Renvoie null s'il n'est pas défini. Par exemple, si cette valeur est égale à 3, une vérification dont l'état de réponse passe d'Erreur à OK ferme l'événement précédent et génère un nouvel événement avec un état OK après la troisième occurrence consécutive du changement d'état. Type de données : nombre | | politiques.vérifications.intervalle | Durée, en secondes, d'attente entre les exécutions de vérification. Par exemple, une valeur de 60 signifie que la vérification s'exécute toutes les 60 secondes. Type de données : nombre | | policies.checks.name | Nom du chèque. Type de données : chaîne | | policies.checks.sys_id | Sys_id du chèque répertorié dans la table Instances de vérification \[sn_agent_check\]. Type de données : chaîne | | politiques.vérifications.délai d'expiration | Durée, en secondes, après laquelle l'exécution de la vérification s'arrête lorsqu'aucune sortie n'est renvoyée. Par exemple, une valeur de 60 signifie que, lorsque l'exécution de la vérification ne renvoie pas une valeur pendant 60 secondes, l'exécution s'arrête. Type de données : chaîne | | policies.cred_alias | Nom répertorié dans la table Informations d'identification \[discovery_credentials\]. Type de données : chaîne | | policies.credential_alias | Sys_id de l'alias d'informations d'identification dans la table Alias de connexion et d'informations d'identification \[sys_alias\]. Type de données : chaîne | | politiques.filtre | Filtre limitant les vérifications de la politique pour surveiller uniquement les critères spécifiés. Type de données : chaîne | | politiques.intervalle | Durée, en secondes, d'attente entre les vérifications de politique. Par exemple, une valeur de 60 signifie que la vérification s'exécute toutes les 60 secondes. Remarque : La valeur de la checks.interval propriété remplace la valeur configurée dans ce champ. Type de données : nombre | | policies.monitored_ci_group | Nom [des groupes CMDB](https://www.servicenow.com/docs/access?context=cmdb-groups&version=xanadu&pubname=xanadu-servicenow-platform&ft:locale=en-US) associés à la politique. Cette CMDB est répertoriée dans la table Groupes de CMDB \[cmdb_group\]. Ce champ n'est appliqué que si la valeur de la monitored_ci_type_group propriété est vraie. Type de données : chaîne | | policies.monitored_ci_script | Script de surveillance des CI. Ce champ n'est appliqué que si la valeur de la policies.monitored_ci_type_script propriété est vraie. Type de données : chaîne | | policies.monitored_ci_type_filter | Marqueur indiquant si le filtrage par type de CI est activé. Le type de CI est répertorié dans la table propriété. Valeurs valides : * vrai : le filtrage par groupe de vérifications est activé. * faux : le filtrage par groupe de vérifications est désactivé. {#agnt_clnt_cll-GET-policies-list__ul_tvm_fvt_2pb} Type de données : booléennes | | policies.monitored_ci_type_group | Marqueur indiquant si la surveillance par type de groupe CMDB est activée. Valeurs valides : * vrai : le type de groupe CMDB est activé. * faux : le type de groupe CMDB est désactivé. {#agnt_clnt_cll-GET-policies-list__ul_jrc_fvt_2pb} Type de données : booléennes | | policies.monitored_ci_type_script | Marqueur indiquant si le script de surveillance des CI est activé. Valeurs valides : * vrai : le script de surveillance des CI est activé. * faux : le script de surveillance des CI est désactivé. {#agnt_clnt_cll-GET-policies-list__ul_bs4_3wt_2pb} Type de données : booléennes | | policies.name | Nom de la politique. Type de données : chaîne | | policies.publish_status | Indique si la politique est publiée. Valeurs possibles : * Brouillon : la politique n'a pas été publiée et est modifiable à l'aide des points de terminaison de mise à jour. * Publié : la politique est publiée. Le brouillon (copie sandbox) et la copie publiée sont identiques. * Publié\* : la politique est publiée, mais la copie brouillon (vue sandbox) comporte des changements qui ne figurent pas dans la copie publiée. {#agnt_clnt_cll-GET-policies-list__ul_d3k_qzm_fpb} Type de données : chaîne | | policies.sys_id | Sys_id de la stratégie répertoriée dans la table Politiques \[sn_agent_policy\]. Type de données : chaîne | | policies.sys_updated_on | Date et heure de dernière mise à jour de la politique. Type de données : chaîne | | table.politique | Champ Type de CI surveillé dans la politique. Ce champ ne s'applique que si la monitored_ci_type_filter valeur est vrai. Type de données : chaîne | | politiques.params | Liste des objets contenant des informations sur les paramètres de vérification répertoriés dans la table Paramètres de vérification \[sn_agent_check_param\]. Ces résultats s'affichent uniquement si le paramètre d'en-tête X-Include-Check-Params est défini sur vrai. Type de données : tableau d'objets "params": [ { "active": Boolean, "flag": "String", "mandatory: Boolean, "name": "String", "sys_id": "String", "value": "String", "value_required": Boolean } ] | | policies.params.active | Marqueur indiquant si le paramètre de vérification est actif. Valeurs valides : * vrai : vérifier que le paramètre est actif. * false : vérifier que le paramètre est inactif. {#agnt_clnt_cll-GET-policies-list__ul_u2x_5fv_2pb} Type de données : booléennes | | politiques.params.marqueur | Marqueur de paramètre à utiliser lors de l'invocation de vérification. Type de données : chaîne | | politiques.params.obligatoires | Marqueur indiquant si cette vérification est obligatoire. Valeurs valides : * true : cette vérification est obligatoire. * false : cette vérification est facultative. {#agnt_clnt_cll-GET-policies-list__ul_flq_qkv_2pb} Type de données : booléennes | | policies.params.name | Nom du paramètre. Type de données : chaîne | | policies.params.sys_id | Sys_id du paramètre répertorié dans la table Vérifier les paramètres \[sn_agent_check_param\]. Type de données : chaîne | | politiques.params.valeur | Valeur du paramètre. Type de données : chaîne | | policies.params.value_required | Marqueur indiquant si les informations fournies par la propriété value sont requises. Valeurs valides : * true : la propriété value est requise. * faux : la propriété de valeur est nulle ou non obligatoire. {#agnt_clnt_cll-GET-policies-list__ul_ug3_3jv_2pb} Type de données : booléennes | | policies.secure_params | Liste des objets contenant des informations sur les paramètres de sécurité de vérification répertoriés dans la table Paramètres de sécurité de vérification \[sn_agent_check_secure_param\]. Pour plus d'informations, reportez-vous à [la section Créer un paramètre sécurisé pour une vérification](https://www.servicenow.com/docs/access?context=acc-create-secure-params&version=xanadu&pubname=xanadu-it-operations-management&ft:locale=en-US). Ces résultats s'affichent uniquement si le paramètre d'en-tête X-Include-Check-Params est défini sur vrai. Type de données : tableau d'objets "secure_params": [ { "active": Boolean, "name": "String", "order": Number, "sys_id": "String" } ] | | policies.secure_params.active | Marqueur indiquant si le paramètre de vérification de la sécurité est actif. Valeurs valides : * true : le paramètre vérifier la sécurité est actif. * false : le paramètre vérifier la sécurité est inactif. {#agnt_clnt_cll-GET-policies-list__ul_xwy_vfv_2pb} Type de données : booléennes | | policies.secure_params.name | Nom du paramètre sécurisé. Type de données : chaîne | | policies.secure_params.commande | Ordre dans lequel le paramètre est envoyé à la commande/au script de vérification. Type de données : nombre | | policies.secure_params.sys_id | Sys_id de l'enregistrement dans la table Vérifier le paramètre sécurisé \[sn_agent_check_secure_param\]. Type de données : chaîne | [Tableau 79. Objet] ### Demande cURL {#agnt_clnt_cll-GET-policies-list__example_dy2_wbx_dpb} L'exemple suivant montre comment restreindre les résultats par requête et par numéro. La requête renvoie toutes les politiques actives et l'ID de l'agent associé. 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' Sortie : { "policies": [ { "name": "Basic Discovery", "sys_id": "68bfd27c536113006dfeddeeff7b12be", "active": "true", "interval": "43200", "sys_updated_on": "2020-07-21 10:14:12", "monitored_ci_type_filter": "true", "filter": "discovery_source=AgentClientCollector^ORlast_discoveredRELATIVELT@dayofweek@ago@14", "table": "cmdb_ci_server", "monitored_ci_type_script": "false", "monitored_ci_script": "/*\n Provide a script to get monitored CI type. ...", "monitored_ci_type_group": "false", "monitored_ci_group": "null// group name as seen in cmdb_group table", "cred_alias": "null// credential name as seen in discovery_credentials table", "credential_alias": "null// credential alias sys id as seen in sys_alias table", "publish_status": "Published", "checks": [ { "name": "check-discovery-basic", "sys_id": "5b10c644c7e10010b9a4362c14c260aa", "active": "true", "command": "check_discover.rb", "command_prefix": "check_discover.rb", "auto_generate": "true", "timeout": "60", "interval": "43200", "event_status_change_threshold": null, "event_status_repair_threshold": null, "check_type": "Discovery" } ], "agent_ids": "b1faba21b066256f,a088b75b1b25b0a0" } ] } ## Agent Client Collector : GET /agents/policy/activate/{policy_id} {#ariaid-title15} Active une politique publiée. Pour obtenir une liste des politiques publiées, utilisez [GET /agents/policies/list](https://servicenow-prod.fluidtopics.net/QEP8zRm1ZTNaxaPmVG9qAg#agnt_clnt_cll-GET-policies-list "Obtient une liste des politiques qui sont à l’état de brouillon publié ou non publié."). Ce point de terminaison prend uniquement en charge les sys_ids dans lesquelles la valeur de la propriété de publish_status la politique est `Publié` ou `Publié*`. ### Format d'URL /api/sn_agent/agents/policy/activate/{policy_id} ### Paramètres de demande pris en charge {#agnt_clnt_cll-GET-policy-act__section_g4n_tcx_dpb} {#agnt_clnt_cll-GET-policy-act__table_n3g_1fs_2pb__entry__2}{#agnt_clnt_cll-GET-policy-act__agntCC-entry-parm-policyID-pub} | Nom | Description | |-|-| | policy_id | Sys_id de la stratégie publiée répertoriée dans la table Politiques \[sn_agent_policy\]. Type de données : chaîne | [Tableau 80. Paramètres de chemin d'accès] {#agnt_clnt_cll-GET-policy-act__table_n3g_1fs_2pb} {#agnt_clnt_cll-GET-policy-act__table_i4n_tcx_dpb__entry__2} | Nom | Description | |-|-| | Aucun | | [Tableau 81. Paramètres de requête] {#agnt_clnt_cll-GET-policy-act__table_i4n_tcx_dpb} {#agnt_clnt_cll-GET-policy-act__table_j4n_tcx_dpb__entry__2} | Nom | Description | |-|-| | Aucun | | [Tableau 82. Paramètres du corps de la demande (JSON)] {#agnt_clnt_cll-GET-policy-act__table_j4n_tcx_dpb} ### En-têtes Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l'API REST, consultez [En-têtes d'API REST pris en charge](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres."). {#agnt_clnt_cll-GET-policy-act__entry__14}{#agnt_clnt_cll-GET-policy-act__accept-JSON-only-entry-RESTAPI} | En-tête | Description | |-|-| | Accepter | Format de données du corps de la réponse. Prend uniquement en charge application/json. | [Tableau 83. En-têtes de demandes] {#agnt_clnt_cll-GET-policy-act__entry__18} | En-tête | Description | |-|-| | Aucun | | [Tableau 84. En-têtes de réponses] ### Codes d'état Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d'état possibles utilisés dans l'API REST, consultez [Codes de réponse HTTP de l'API REST](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres."). {#agnt_clnt_cll-GET-policy-act__table_ckp_2gr_z4b__entry__2}{#agnt_clnt_cll-GET-policy-act__entry-200-status-code}{#agnt_clnt_cll-GET-policy-act__agntCC-desc-403-admin}{#agnt_clnt_cll-GET-policy-act__entry-500-status-code} | Code d'état | Description | |-|-| | 200 | Réussi. La demande a été correctement traitée. | | 403 | L'utilisateur n'a pas le rôle agent_client_collector_admin. | | 404 | Aucun enregistrement trouvé avec le sys_id fourni. | | 500 | Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur. | [Tableau 85. Codes d'état] {#agnt_clnt_cll-GET-policy-act__table_ckp_2gr_z4b} ### Paramètres de corps de réponse (JSON) {#agnt_clnt_cll-GET-policy-act__table_h5l_bgs_2pb__entry__2} | En-tête | Description | |-|-| | message | Message contenant les résultats de réussite ou d'échec de l'opération. Type de données : chaîne | [ ] {#agnt_clnt_cll-GET-policy-act__table_h5l_bgs_2pb} ### Demande cURL L'exemple suivant montre comment activer une politique. curl "https://instance.service-now.com/api/sn_agent/agents/policy/activate/" \ --request GET \ --header "Accept:application/json" \ --user 'username' : 'password' Sortie : { "message": "Operation was successful" } ## Agent Client Collector : GET /agents/policy/deactivate/{policy_id} {#ariaid-title16} Désactive une politique publiée. Pour obtenir une liste des politiques publiées, utilisez [GET /agents/policies/list](https://servicenow-prod.fluidtopics.net/QEP8zRm1ZTNaxaPmVG9qAg#agnt_clnt_cll-GET-policies-list "Obtient une liste des politiques qui sont à l’état de brouillon publié ou non publié."). Ce point de terminaison prend uniquement en charge les sys_ids dans lesquelles la valeur de la propriété de publish_status la politique est `Publié` ou `Publié*`. ### Format d'URL {#agnt_clnt_cll-GET-policy-deact__section_f4n_tcx_dpb} /api/sn_agent/agents/policy/activate/{policy_id} ### Paramètres de demande pris en charge {#agnt_clnt_cll-GET-policy-deact__section_g4n_tcx_dpb} {#agnt_clnt_cll-GET-policy-deact__table_f4v_qfs_2pb__entry__2}{#agnt_clnt_cll-GET-policy-deact__agntCC-entry-parm-policyID-pub} | Nom | Description | |-|-| | policy_id | Sys_id de la stratégie publiée répertoriée dans la table Politiques \[sn_agent_policy\]. Type de données : chaîne | [Tableau 86. Paramètres de chemin d'accès] {#agnt_clnt_cll-GET-policy-deact__table_f4v_qfs_2pb} {#agnt_clnt_cll-GET-policy-deact__table_i4n_tcx_dpb__entry__2} | Nom | Description | |-|-| | Aucun | | [Tableau 87. Paramètres de requête] {#agnt_clnt_cll-GET-policy-deact__table_i4n_tcx_dpb} {#agnt_clnt_cll-GET-policy-deact__table_j4n_tcx_dpb__entry__2} | Nom | Description | |-|-| | Aucun | | [Tableau 88. Paramètres du corps de la demande (JSON)] {#agnt_clnt_cll-GET-policy-deact__table_j4n_tcx_dpb} ### En-têtes Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l'API REST, consultez [En-têtes d'API REST pris en charge](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres."). {#agnt_clnt_cll-GET-policy-deact__table_l4n_tcx_dpb__entry__2}{#agnt_clnt_cll-GET-policy-deact__accept-JSON-only-entry-RESTAPI} | En-tête | Description | |-|-| | Accepter | Format de données du corps de la réponse. Prend uniquement en charge application/json. | [Tableau 89. En-têtes de demandes] {#agnt_clnt_cll-GET-policy-deact__table_l4n_tcx_dpb} {#agnt_clnt_cll-GET-policy-deact__table_m4n_tcx_dpb__entry__2} | En-tête | Description | |-|-| | Aucun | | [Tableau 90. En-têtes de réponses] {#agnt_clnt_cll-GET-policy-deact__table_m4n_tcx_dpb} ### Codes d'état {#agnt_clnt_cll-GET-policy-deact__section_n4n_tcx_dpb} Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d'état possibles utilisés dans l'API REST, consultez [Codes de réponse HTTP de l'API REST](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres."). {#agnt_clnt_cll-GET-policy-deact__table_ckp_2gr_z4b__entry__2}{#agnt_clnt_cll-GET-policy-deact__entry-200-status-code}{#agnt_clnt_cll-GET-policy-deact__agntCC-desc-403-admin}{#agnt_clnt_cll-GET-policy-deact__entry-500-status-code} | Code d'état | Description | |-|-| | 200 | Réussi. La demande a été correctement traitée. | | 403 | L'utilisateur n'a pas le rôle agent_client_collector_admin. | | 404 | Aucun enregistrement trouvé avec le sys_id fourni. | | 500 | Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur. | [Tableau 91. Codes d'état] {#agnt_clnt_cll-GET-policy-deact__table_ckp_2gr_z4b} ### Paramètres de corps de réponse (JSON) {#agnt_clnt_cll-GET-policy-deact__section_znm_1mq_fpb} {#agnt_clnt_cll-GET-policy-deact__table_h5l_bgs_2pb__entry__2} | En-tête | Description | |-|-| | message | Message contenant les résultats de réussite ou d'échec de l'opération. Type de données : chaîne | [ ] {#agnt_clnt_cll-GET-policy-deact__table_h5l_bgs_2pb} ### Demande cURL {#agnt_clnt_cll-GET-policy-deact__example_bgj_chs_2pb} L'exemple suivant montre comment désactiver une stratégie. curl "https://instance.service-now.com/api/sn_agent/agents/policy/deactivate/" \ --request GET \ --header "Accept:application/json" \ --user 'username' : 'password' Sortie : { "message": "Operation was successful" } ## Agent Client Collector : GET /agents/policy/publish/{policy_id} {#ariaid-title17} Publie un brouillon de politique. Utilisez l'un des points de terminaison suivants pour modifier un brouillon ou une copie de bac à sable avant sa publication : * [POST /agents/update/policy/{policy_id}](https://servicenow-prod.fluidtopics.net/QEP8zRm1ZTNaxaPmVG9qAg#agnt_clnt_cll-POST-update-policy "Met à jour une copie sandbox d’une politique.") * [POST /agents/update/check/{check_id}](https://servicenow-prod.fluidtopics.net/QEP8zRm1ZTNaxaPmVG9qAg#agnt_clnt_cll-POST-update-check-id "Met à jour une vérification de politique sélectionnée.") * [POST /agents/update/check_param/{param_id}](https://servicenow-prod.fluidtopics.net/QEP8zRm1ZTNaxaPmVG9qAg#agnt_clnt_cll-POST-update-check_param "Met à jour un paramètre de vérification de politique sélectionné.") * [POST /agents/update/check_secure_param/{param_id}](https://servicenow-prod.fluidtopics.net/QEP8zRm1ZTNaxaPmVG9qAg#agnt_clnt_cll-POST-update-check_secure "Met à jour un paramètre sécurisé de vérification de politique sélectionné.") {#agnt_clnt_cll-GET-policy-publish__ul_p14_jbh_fpb} ### Format d'URL /api/sn_agent/agents/policy/publish/{policy_id} ### Paramètres de demande pris en charge {#agnt_clnt_cll-GET-policy-publish__section_g4n_tcx_dpb} {#agnt_clnt_cll-GET-policy-publish__table_n3g_1fs_2pb__entry__2} | Nom | Description | |-|-| | policy_id | Sys_id d'une politique dans la table Politiques \[sn_agent_policy\] qui est à l'état Brouillon ou une copie du bac à sable. * Pour obtenir une liste de politiques et de détails, y compris l'état de publication, utilisez [GET /agents/policies/list](https://servicenow-prod.fluidtopics.net/QEP8zRm1ZTNaxaPmVG9qAg#agnt_clnt_cll-GET-policies-list "Obtient une liste des politiques qui sont à l’état de brouillon publié ou non publié."). * Pour récupérer une copie de bac à sable d'une politique, utilisez [GET /agents/policy/sandbox_from_published/{policy_id}](https://servicenow-prod.fluidtopics.net/QEP8zRm1ZTNaxaPmVG9qAg#agnt_clnt_cll-GET-policy-sbox-fr "Obtient la copie du bac à sable d’une politique publiée et fournit les détails de la politique."). {#agnt_clnt_cll-GET-policy-publish__ul_icv_npn_fpb} Type de données : chaîne | [Tableau 92. Paramètres de chemin d'accès] {#agnt_clnt_cll-GET-policy-publish__table_n3g_1fs_2pb} {#agnt_clnt_cll-GET-policy-publish__table_i4n_tcx_dpb__entry__2} | Nom | Description | |-|-| | Aucun | | [Tableau 93. Paramètres de requête] {#agnt_clnt_cll-GET-policy-publish__table_i4n_tcx_dpb} {#agnt_clnt_cll-GET-policy-publish__table_j4n_tcx_dpb__entry__2} | Nom | Description | |-|-| | Aucun | | [Tableau 94. Paramètres du corps de la demande (JSON)] {#agnt_clnt_cll-GET-policy-publish__table_j4n_tcx_dpb} ### En-têtes Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l'API REST, consultez [En-têtes d'API REST pris en charge](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres."). {#agnt_clnt_cll-GET-policy-publish__entry__14}{#agnt_clnt_cll-GET-policy-publish__accept-JSON-only-entry-RESTAPI} | En-tête | Description | |-|-| | Accepter | Format de données du corps de la réponse. Prend uniquement en charge application/json. | [Tableau 95. En-têtes de demandes] {#agnt_clnt_cll-GET-policy-publish__entry__18} | En-tête | Description | |-|-| | Aucun | | [Tableau 96. En-têtes de réponses] ### Codes d'état Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d'état possibles utilisés dans l'API REST, consultez [Codes de réponse HTTP de l'API REST](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres."). {#agnt_clnt_cll-GET-policy-publish__table_ckp_2gr_z4b__entry__2}{#agnt_clnt_cll-GET-policy-publish__entry-200-status-code}{#agnt_clnt_cll-GET-policy-publish__agntCC-desc-403-admin}{#agnt_clnt_cll-GET-policy-publish__entry-500-status-code} | Code d'état | Description | |-|-| | 200 | Réussi. La demande a été correctement traitée. | | 403 | L'utilisateur n'a pas le rôle agent_client_collector_admin. | | 404 | Aucun enregistrement trouvé avec le sys_id fourni. | | 500 | Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur. | [Tableau 97. Codes d'état] {#agnt_clnt_cll-GET-policy-publish__table_ckp_2gr_z4b} ### Paramètres de corps de réponse (JSON) {#agnt_clnt_cll-GET-policy-publish__section_m1q_bmq_fpb} {#agnt_clnt_cll-GET-policy-publish__table_h5l_bgs_2pb__entry__2} | En-tête | Description | |-|-| | message | Message contenant les résultats de réussite ou d'échec de l'opération. Type de données : chaîne | [ ] {#agnt_clnt_cll-GET-policy-publish__table_h5l_bgs_2pb} ### Demande cURL L'exemple suivant montre comment publier une politique. curl "https://instance.service-now.com/api/sn_agent/agents/policy/publish/" \ --request GET \ --header "Accept:application/json" \ --user 'username' : 'password' Sortie : { "message": "Operation was successful" } ## Agent Client Collector : GET /agents/policy/sandbox_from_published/{policy_id} {#ariaid-title18} Obtient la copie du bac à sable d'une politique publiée et fournit les détails de la politique. Utilisez la copie sandbox pour mettre à jour une stratégie et la publier. Vous pouvez utiliser les sys_ids dans le corps de la réponse pour travailler avec les points de terminaison suivants : * [POST /agents/update/policy/{policy_id}](https://servicenow-prod.fluidtopics.net/QEP8zRm1ZTNaxaPmVG9qAg#agnt_clnt_cll-POST-update-policy "Met à jour une copie sandbox d’une politique.") * [POST /agents/update/check/{check_id}](https://servicenow-prod.fluidtopics.net/QEP8zRm1ZTNaxaPmVG9qAg#agnt_clnt_cll-POST-update-check-id "Met à jour une vérification de politique sélectionnée.") * [POST /agents/update/check_param/{param_id}](https://servicenow-prod.fluidtopics.net/QEP8zRm1ZTNaxaPmVG9qAg#agnt_clnt_cll-POST-update-check_param "Met à jour un paramètre de vérification de politique sélectionné.") * [POST /agents/update/check_secure_param/{param_id}](https://servicenow-prod.fluidtopics.net/QEP8zRm1ZTNaxaPmVG9qAg#agnt_clnt_cll-POST-update-check_secure "Met à jour un paramètre sécurisé de vérification de politique sélectionné.") {#agnt_clnt_cll-GET-policy-sbox-fr__ul_p14_jbh_fpb} Pour obtenir une liste des politiques publiées, utilisez [GET /agents/policies/list](https://servicenow-prod.fluidtopics.net/QEP8zRm1ZTNaxaPmVG9qAg#agnt_clnt_cll-GET-policies-list "Obtient une liste des politiques qui sont à l’état de brouillon publié ou non publié."). Ce point de terminaison prend uniquement en charge les sys_ids dans lesquelles la valeur de la propriété de publish_status la politique est `Publié` ou `Publié*`. ### Format d'URL /api/sn_agent/agents/politique/sandbox_from_published/{policy_id} ### Paramètres de demande pris en charge {#agnt_clnt_cll-GET-policy-sbox-fr__section_g4n_tcx_dpb} {#agnt_clnt_cll-GET-policy-sbox-fr__table_n3g_1fs_2pb__entry__2}{#agnt_clnt_cll-GET-policy-sbox-fr__agntCC-entry-parm-policyID-pub} | Nom | Description | |-|-| | policy_id | Sys_id de la stratégie publiée répertoriée dans la table Politiques \[sn_agent_policy\]. Type de données : chaîne | [Tableau 98. Paramètres de chemin d'accès] {#agnt_clnt_cll-GET-policy-sbox-fr__table_n3g_1fs_2pb} {#agnt_clnt_cll-GET-policy-sbox-fr__table_i4n_tcx_dpb__entry__2} | Nom | Description | |-|-| | Aucun | | [Tableau 99. Paramètres de requête] {#agnt_clnt_cll-GET-policy-sbox-fr__table_i4n_tcx_dpb} {#agnt_clnt_cll-GET-policy-sbox-fr__table_j4n_tcx_dpb__entry__2} | Nom | Description | |-|-| | Aucun | | [Tableau 100. Paramètres du corps de la demande (JSON)] {#agnt_clnt_cll-GET-policy-sbox-fr__table_j4n_tcx_dpb} ### En-têtes Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l'API REST, consultez [En-têtes d'API REST pris en charge](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres."). {#agnt_clnt_cll-GET-policy-sbox-fr__entry__14}{#agnt_clnt_cll-GET-policy-sbox-fr__accept-JSON-only-entry-RESTAPI} | En-tête | Description | |-|-| | Accepter | Format de données du corps de la réponse. Prend uniquement en charge application/json. | [Tableau 101. En-têtes de demandes] {#agnt_clnt_cll-GET-policy-sbox-fr__entry__18} | En-tête | Description | |-|-| | Aucun | | [Tableau 102. En-têtes de réponses] ### Codes d'état Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d'état possibles utilisés dans l'API REST, consultez [Codes de réponse HTTP de l'API REST](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres."). {#agnt_clnt_cll-GET-policy-sbox-fr__table_ckp_2gr_z4b__entry__2}{#agnt_clnt_cll-GET-policy-sbox-fr__entry-200-status-code}{#agnt_clnt_cll-GET-policy-sbox-fr__agntCC-desc-403-admin}{#agnt_clnt_cll-GET-policy-sbox-fr__entry-500-status-code} | Code d'état | Description | |-|-| | 200 | Réussi. La demande a été correctement traitée. | | 403 | L'utilisateur n'a pas le rôle agent_client_collector_admin. | | 404 | Aucun enregistrement trouvé avec le sys_id fourni. | | 500 | Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur. | [Tableau 103. Codes d'état] {#agnt_clnt_cll-GET-policy-sbox-fr__table_ckp_2gr_z4b} ### Paramètres de corps de réponse (JSON) {#agnt_clnt_cll-GET-policy-sbox-fr__entry__32} | Propriété | Description | |-|-| | \ | Détails détaillés de la copie de bac à sable (sandbox) associée à la politique. Pour plus d'informations sur les stratégies, consultez [Vérifications et politiques par défaut](https://www.servicenow.com/docs/access?context=agent-policies-checks&version=xanadu&pubname=xanadu-it-operations-management&ft:locale=en-US). { "active": Boolean" "agent_ids": "String", "checks": [Array], "cred_alias": "String", "credential_alias": "String", "filter": "String", "interval": "Number", "monitored_ci_group": "String", "monitored_ci_script": "String", "monitored_ci_type_filter": Boolean, "monitored_ci_type_group": Boolean, "monitored_ci_type_script": "String", "name": "String", "params": [Array], "publish_status": "String", "secure_params": [Array], "sys_id": "String", "sys_updated_on": "String", "table": "String" } | | Actif | Marqueur indiquant si la politique est active. Valeurs valides : * true : la politique est active. * faux : la politique n'est pas active. {#agnt_clnt_cll-GET-policy-sbox-fr__ul_qr2_g3x_dpb} Type de données : booléennes | | agent_ids | ID unique d'un agent répertorié dans la colonne ID d'agent de la table Agent Client Collectors \[sn_agent_cmdb_ci_agent\]. Ces résultats s'affichent uniquement si le paramètre d'en-tête X-Include-Checks-And-Agents est défini sur vrai. Pour obtenir des informations étendues sur un agent, exécutez l'ID dans le point de terminaison [GET /agents/{agent_id}](https://servicenow-prod.fluidtopics.net/QEP8zRm1ZTNaxaPmVG9qAg#agnt_clnt_cll-GET-agent_id "Obtient les informations d’un agent spécifié.") . | | Contrôles | Liste des objets définissant les vérifications répertoriés dans la table Instances de vérification \[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" } ] Type de données : tableau | | checks.active | Marqueur indiquant si la vérification de la politique est active. Valeurs valides : * true : la vérification de la politique est active. * false : la vérification de la politique est inactive. {#agnt_clnt_cll-GET-policy-sbox-fr__ul_j2p_sdt_2pb} Type de données : booléennes | | checks.auto_generate | Marqueur indiquant s'il faut générer automatiquement la commande avec la command_prefix valeur. Valeurs valides : * vrai : renseigne automatiquement la propriété avec les valeurs de command paramètres actives. * false : la commande n'est pas générée automatiquement. {#agnt_clnt_cll-GET-policy-sbox-fr__ul_myc_x2t_2pb} Type de données : booléennes | | checks.check_type | Type de vérification spécifiant l'option de surveillance. Valeurs possibles : * Détection : vérifie qui localise les CI associés à l'agent. * Événements : le résultat de la vérification est transformé en événement de gestion des événements. * Mesures : les valeurs du résultat de vérification sont transformées en mesures. {#agnt_clnt_cll-GET-policy-sbox-fr__ul_pgd_42t_2pb} Type de données : chaîne | | vérifie.commande | Commande exécutée Agent Client Collector . Paramètre extrait d'un modèle ou d'un CI surveillé. Remarque : Si auto_generate la valeur est vrai, cette propriété est automatiquement renseignée avec le préfixe et les marqueurs des paramètres actifs répertoriés dans l'objet parameters . Type de données : chaîne | | checks.command_prefix | Si la propriété est true, cette commande est utilisée pour la auto_generate génération automatique. Le préfixe se compose d'une partie de la commande statique (qui ne change pas), telle que le nom du script. Type de données : chaîne | | checks.event_status_change_threshold | Nombre de fois consécutives où l'état de la réponse d'un chèque doit se produire avant qu'un nouvel événement ne soit envoyé. Renvoie null s'il n'est pas défini. Par exemple, si cette valeur est égale à 3, une vérification dont l'état de la réponse passe de OK à Erreur génère un nouvel événement avec un état Erreur après la troisième occurrence consécutive du changement d'état. Type de données : nombre | | checks.event_status_repair_threshold | Nombre de fois consécutives où l'état de la réponse d'une vérification doit s'améliorer pour fermer l'événement précédent. Renvoie null s'il n'est pas défini. Par exemple, si cette valeur est égale à 3, une vérification dont l'état de réponse passe d'Erreur à OK ferme l'événement précédent et génère un nouvel événement avec un état OK après la troisième occurrence consécutive du changement d'état. Type de données : nombre | | checks.interval | Durée, en secondes, d'attente entre les exécutions de vérification. Par exemple, une valeur de 60 signifie que la vérification s'exécute toutes les 60 secondes. Type de données : nombre | | checks.name | Nom du chèque. Type de données : chaîne | | checks.sys_id | Sys_id du chèque répertorié dans la table Instances de vérification \[sn_agent_check\]. Le point de terminaison [POST /agents/update/check/{check_id}](https://servicenow-prod.fluidtopics.net/QEP8zRm1ZTNaxaPmVG9qAg#agnt_clnt_cll-POST-update-check-id "Met à jour une vérification de politique sélectionnée.") prend cette valeur pour mettre à jour la copie du bac à sable. Type de données : chaîne | | checks.timeout | Durée, en secondes, après laquelle l'exécution de la vérification s'arrête lorsqu'aucune sortie n'est renvoyée. Par exemple, une valeur de 60 signifie que, lorsque l'exécution de la vérification ne renvoie pas une valeur pendant 60 secondes, l'exécution s'arrête. Type de données : chaîne | | cred_alias | Nom répertorié dans la table Informations d'identification \[discovery_credentials\]. Type de données : chaîne | | credential_alias | Sys_id de l'alias d'informations d'identification dans la table Alias de connexion et d'informations d'identification \[sys_alias\]. Type de données : chaîne | | filtre | Filtre limitant les vérifications de la politique pour surveiller uniquement les critères spécifiés. Type de données : chaîne | | intervalle | Durée, en secondes, d'attente entre les vérifications de politique. Par exemple, une valeur de 60 signifie que la vérification s'exécute toutes les 60 secondes. Remarque : La valeur de la checks.interval propriété remplace la valeur configurée dans ce champ. Type de données : nombre | | monitored_ci_group | Nom [des groupes CMDB](https://www.servicenow.com/docs/access?context=cmdb-groups&version=xanadu&pubname=xanadu-servicenow-platform&ft:locale=en-US) associés à la politique. Cette CMDB est répertoriée dans la table Groupes de CMDB \[cmdb_group\]. Ce champ n'est appliqué que si la valeur de la monitored_ci_type_group propriété est vraie. Type de données : chaîne | | monitored_ci_script | Script de surveillance des CI. Ce champ n'est appliqué que si la valeur de la policies.monitored_ci_type_script propriété est vraie. Type de données : chaîne | | monitored_ci_type_filter | Marqueur indiquant si le filtrage par type de CI est activé. Le type de CI est répertorié dans la table propriété. Valeurs valides : * vrai : le filtrage par groupe de vérifications est activé. * faux : le filtrage par groupe de vérifications est désactivé. {#agnt_clnt_cll-GET-policy-sbox-fr__ul_tvm_fvt_2pb} Type de données : booléennes | | monitored_ci_type_group | Marqueur indiquant si la surveillance par type de groupe CMDB est activée. Valeurs valides : * vrai : le type de groupe CMDB est activé. * faux : le type de groupe CMDB est désactivé. {#agnt_clnt_cll-GET-policy-sbox-fr__ul_jrc_fvt_2pb} Type de données : booléennes | | monitored_ci_type_script | Marqueur indiquant si le script de surveillance des CI est activé. Valeurs valides : * vrai : le script de surveillance des CI est activé. * faux : le script de surveillance des CI est désactivé. {#agnt_clnt_cll-GET-policy-sbox-fr__ul_bs4_3wt_2pb} Type de données : booléennes | | nom | Nom de la politique. Type de données : chaîne | | publish_status | Indique si la politique est publiée. Valeurs possibles : * Brouillon : la politique n'a pas été publiée et est modifiable à l'aide des points de terminaison de mise à jour. * Publié : la politique est publiée. Le brouillon (copie sandbox) et la copie publiée sont identiques. * Publié\* : la politique est publiée, mais la copie brouillon (vue sandbox) comporte des changements qui ne figurent pas dans la copie publiée. {#agnt_clnt_cll-GET-policy-sbox-fr__ul_d3k_qzm_fpb} Type de données : chaîne | | paramètres | Liste des objets contenant des informations sur les paramètres de vérification répertoriés dans la table Paramètres de vérification \[sn_agent_check_param\]. Ces résultats s'affichent uniquement si le paramètre d'en-tête X-Include-Check-Params est défini sur vrai. Type de données : tableau d'objets "params": [ { "active": Boolean, "flag": "String", "mandatory: Boolean, "name": "String", "sys_id": "String", "value": "String", "value_required": Boolean } ] | | params.active | Marqueur indiquant si le paramètre de vérification est actif. Valeurs valides : * vrai : vérifier que le paramètre est actif. * false : vérifier que le paramètre est inactif. {#agnt_clnt_cll-GET-policy-sbox-fr__ul_u2x_5fv_2pb} Type de données : booléennes | | params.flag | Marqueur de paramètre à utiliser lors de l'invocation de vérification. Type de données : chaîne | | params.mandatory | Marqueur indiquant si cette vérification est obligatoire. Valeurs valides : * true : cette vérification est obligatoire. * false : cette vérification est facultative. {#agnt_clnt_cll-GET-policy-sbox-fr__ul_flq_qkv_2pb} Type de données : booléennes | | params.name | Nom du paramètre. Type de données : chaîne | | params.sys_id | Sys_id du paramètre répertorié dans la table Vérifier les paramètres \[sn_agent_check_param\]. Le point de terminaison [POST /agents/update/check_param/{param_id}](https://servicenow-prod.fluidtopics.net/QEP8zRm1ZTNaxaPmVG9qAg#agnt_clnt_cll-POST-update-check_param "Met à jour un paramètre de vérification de politique sélectionné.") prend cette valeur pour mettre à jour la copie du bac à sable. Type de données : chaîne | | params.value | Valeur du paramètre. Type de données : chaîne | | params.value_required | Marqueur indiquant si les informations fournies par la propriété value sont requises. Valeurs valides : * true : la propriété value est requise. * faux : la propriété de valeur est nulle ou non obligatoire. {#agnt_clnt_cll-GET-policy-sbox-fr__ul_ug3_3jv_2pb} Type de données : booléennes | | secure_params | Liste des objets contenant des informations sur les paramètres de sécurité de vérification répertoriés dans la table Paramètres de sécurité de vérification \[sn_agent_check_secure_param\]. Pour plus d'informations, reportez-vous à [la section Créer un paramètre sécurisé pour une vérification](https://www.servicenow.com/docs/access?context=acc-create-secure-params&version=xanadu&pubname=xanadu-it-operations-management&ft:locale=en-US). Ces résultats s'affichent uniquement si le paramètre d'en-tête X-Include-Check-Params est défini sur vrai. Type de données : tableau d'objets "secure_params": [ { "active": Boolean, "name": "String", "order": Number, "sys_id": "String" } ] | | secure_params.active | Marqueur indiquant si le paramètre de vérification de la sécurité est actif. Valeurs valides : * true : le paramètre vérifier la sécurité est actif. * false : le paramètre vérifier la sécurité est inactif. {#agnt_clnt_cll-GET-policy-sbox-fr__ul_xwy_vfv_2pb} Type de données : booléennes | | secure_params.name | Nom du paramètre sécurisé. Type de données : chaîne | | secure_params.commande | Ordre dans lequel le paramètre est envoyé à la commande/au script de vérification. Type de données : nombre | | secure_params.sys_id | Sys_id de l'enregistrement situé dans la table Vérifier le paramètre sécurisé \[sn_agent_check_secure_param\]. Le point de terminaison [POST /agents/update/check_secure_param/{param_id}](https://servicenow-prod.fluidtopics.net/QEP8zRm1ZTNaxaPmVG9qAg#agnt_clnt_cll-POST-update-check_secure "Met à jour un paramètre sécurisé de vérification de politique sélectionné.") prend cette valeur pour mettre à jour la copie du bac à sable. Type de données : chaîne | | sys_id | Sys_id de la stratégie répertoriée dans la table Politiques \[sn_agent_policy\]. Le point de terminaison [POST /agents/update/policy/{policy_id}](https://servicenow-prod.fluidtopics.net/QEP8zRm1ZTNaxaPmVG9qAg#agnt_clnt_cll-POST-update-policy "Met à jour une copie sandbox d’une politique.") prend cette valeur pour mettre à jour la copie du bac à sable. Type de données : chaîne | | sys_updated_on | Date et heure de dernière mise à jour de la politique. Type de données : chaîne | | table | Champ Type de CI surveillé dans la politique. Ce champ ne s'applique que si la monitored_ci_type_filter valeur est vrai. Type de données : chaîne | [ ] ### Demande cURL Ce qui suit montre comment obtenir des informations sur la politique Mesures de conteneur Docker. curl "https://instance.service-now.com/api/sn_agent/agents/policy/sandbox_from_published/" \ --request GET \ --header "Accept:application/json" \ --user 'username':'password' Sortie : { "name": "Docker Container Metrics", "sys_id": "b01e609a1b9fe4943e7f0b05464bcb91", "active": "false", "interval": "60", "sys_updated_on": "2021-04-05 19:52:28", "monitored_ci_type_filter": "true", "filter": "operational_status=1", "table": "cmdb_ci_docker_container", "monitored_ci_type_script": "false", "monitored_ci_script": "/*\n Provide a script to get monitored CI type.", "monitored_ci_type_group": "false", "monitored_ci_group": "null// group name as seen in cmdb_group table", "cred_alias": "null// credential name as seen in discovery_credentials table", "credential_alias": "null// credential alias sys id as seen in sys_alias table", "publish_status": "Published", "checks": [ { "name": "container.docker.metrics-docker", "sys_id": "701e609a1b9fe4943e7f0b05464bcb94", "active": "true", "command": "metrics-docker-stats.rb -N {{.labels.params_ci_container_id}} -P -n -i", "command_prefix": "metrics-docker-stats.rb -N {{.labels.params_ci_container_id}}", "auto_generate": "true", "timeout": "60", "interval": "60", "event_status_change_threshold": null, "event_status_repair_threshold": null, "check_type": "Metrics", "params": [ { "name": "scheme", "sys_id": "c11e609a1b9fe4943e7f0b05464bcb97", "value": null, "active": "false", "mandatory": "false", "value_required": "true", "flag": "-s" }, ... { "name": "docker_host", "sys_id": "cd1e609a1b9fe4943e7f0b05464bcb97", "value": null, "active": "false", "mandatory": "false", "value_required": "true", "flag": "-H" } ], "secure_params": [] } ] } ## Agent Client Collector : GET /agents/{agent_id}/restart {#ariaid-title19} Redémarre un agent spécifié avec l'état actif/actif. Si Agent Client Collector des problèmes de performances se produisent, vous pouvez redémarrer l'agent. Le redémarrage manuel est pris en charge dans les environnements suivants : * Agents basés sur Linux utilisant `systemd` * Agents Windows {#agnt_clnt_cll-GET-restart__ul_zzv_z4q_dpb} ### Format d'URL {#agnt_clnt_cll-GET-restart__section_nf5_zyc_z4b} /api/sn_agent/agents/{agent_id}/restart ### Paramètres de demande pris en charge {#agnt_clnt_cll-GET-restart__section_ewl_zyc_z4b} {#agnt_clnt_cll-GET-restart__table_oyt_cd3_dpb__entry__2} | Nom | Description | |-|-| | agent_id | ID unique d'un agent répertorié dans la colonne ID d'agent de la table Agent Client Collectors \[sn_agent_cmdb_ci_agent\]. Pour obtenir une liste des ID d'agents et d'autres détails, exécutez le point de terminaison GET /agents/list . Type de données : chaîne | [Tableau 104. Paramètres de chemin d'accès] {#agnt_clnt_cll-GET-restart__table_oyt_cd3_dpb} {#agnt_clnt_cll-GET-restart__table_gwl_zyc_z4b__entry__2} | Nom | Description | |-|-| | Aucun | | [Tableau 105. Paramètres de requête] {#agnt_clnt_cll-GET-restart__table_gwl_zyc_z4b} {#agnt_clnt_cll-GET-restart__table_hwl_zyc_z4b__entry__2} | Nom | Description | |-|-| | Aucun | | [Tableau 106. Paramètres du corps de la demande (JSON)] {#agnt_clnt_cll-GET-restart__table_hwl_zyc_z4b} ### En-têtes {#agnt_clnt_cll-GET-restart__section_iwl_zyc_z4b} Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l'API REST, consultez [En-têtes d'API REST pris en charge](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres."). {#agnt_clnt_cll-GET-restart__table_jwl_zyc_z4b__entry__2}{#agnt_clnt_cll-GET-restart__accept-JSON-only-entry-RESTAPI} | En-tête | Description | |-|-| | Accepter | Format de données du corps de la réponse. Prend uniquement en charge application/json. | [Tableau 107. En-têtes de demandes] {#agnt_clnt_cll-GET-restart__table_jwl_zyc_z4b} {#agnt_clnt_cll-GET-restart__table_kwl_zyc_z4b__entry__2} | En-tête | Description | |-|-| | Aucun | | [Tableau 108. En-têtes de réponses] {#agnt_clnt_cll-GET-restart__table_kwl_zyc_z4b} ### Codes d'état {#agnt_clnt_cll-GET-restart__section_lwl_zyc_z4b} Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d'état possibles utilisés dans l'API REST, consultez [Codes de réponse HTTP de l'API REST](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres."). {#agnt_clnt_cll-GET-restart__table_y2n_2f3_dpb__entry__2}{#agnt_clnt_cll-GET-restart__entry-200-status-code}{#agnt_clnt_cll-GET-restart__agntCC-desc-403-admin} | Code d'état | Description | |-|-| | 200 | Réussi. La demande a été correctement traitée. | | 403 | L'utilisateur n'a pas le rôle agent_client_collector_admin. | | 404 | Aucun enregistrement trouvé avec le sys_id fourni ou cet agent ne prend pas en charge le redémarrage. | [Tableau 109. Codes d'état] {#agnt_clnt_cll-GET-restart__table_y2n_2f3_dpb} ### Paramètres de corps de réponse (JSON) {#agnt_clnt_cll-GET-restart__section_nwl_zyc_z4b} {#agnt_clnt_cll-GET-restart__table_owl_zyc_z4b__entry__2} | Nom | Description | |-|-| | message | Message contenant les résultats de réussite ou d'échec de l'opération. Type de données : chaîne | [ ] {#agnt_clnt_cll-GET-restart__table_owl_zyc_z4b} ### Demande cURL {#agnt_clnt_cll-GET-restart__example_zf5_zyc_z4b} L'exemple suivant montre comment redémarrer un agent. curl "https://instance.service-now.com/api/sn_agent/agents//restart" \ --request GET \ --header "Accept:application/json" \ --user 'username':'password' Sortie : { "message": "Restarting Agent With ID: " } ## Agent Client Collector : POST /agents/check_defs/{check_def_id}/run {#ariaid-title20} Exécute une vérification par rapport à l'élément de configuration donné. Pour arrêter une vérification des antécédents, utilisez l'ID de demande fourni dans l'API GET /agents/exec/background/stop/{request_id} . ### Format d'URL /api/sn_agent/agents/check_defs/{check_def_id}/run ### Paramètres de demande pris en charge {#agnt_clnt_cll-POST-check-def-run__entry__2} | Nom | Description | |-|-| | check_def_id | Sys_id d'une définition de vérification dans la table Définitions de vérification \[sn_agent_check_def\]. | [Tableau 110. Paramètres de chemin d'accès] {#agnt_clnt_cll-POST-check-def-run__entry__6} | Nom | Description | |-|-| | Aucun | | [Tableau 111. Paramètres de requête] {#agnt_clnt_cll-POST-check-def-run__table_cvh_5gq_wqb__entry__2} | Nom | Description | |-|-| | paramètres | Carte des noms et des valeurs des paramètres. Ces paramètres peuvent être utilisés pour remplacer les enregistrements de paramètres de la définition de contrôle et ses valeurs spécifiées. "params": { "": "String" } Type de données : objet | | Priorité | Priorité de la demande à définir sur la file d'attente ECC. Valeurs possibles : * 0 : interactif * 1 : Accéléré * 2 : standard {#agnt_clnt_cll-POST-check-def-run__ul_bkf_hnq_wqb} Type de données : nombre | | requête | Requête codée pour récupérer le GlideRecord à partir de la table spécifiée dans la table propriété. Type de données : chaîne | | table | Nom de la table cmdb_ci pour cette vérification des antécédents. Type de données : chaîne | | timeout | Valeur du délai d'expiration de la demande, en secondes. Type de données : nombre | [Tableau 112. Paramètres du corps de la demande (JSON)] {#agnt_clnt_cll-POST-check-def-run__table_cvh_5gq_wqb} ### En-têtes {#agnt_clnt_cll-POST-check-def-run__section_dvh_5gq_wqb} Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l'API REST, consultez [En-têtes d'API REST pris en charge](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres."). {#agnt_clnt_cll-POST-check-def-run__table_evh_5gq_wqb__entry__2}{#agnt_clnt_cll-POST-check-def-run__accept-JSON-only-entry-RESTAPI} | En-tête | Description | |-|-| | Accepter | Format de données du corps de la réponse. Prend uniquement en charge application/json. | [Tableau 113. En-têtes de demandes] {#agnt_clnt_cll-POST-check-def-run__table_evh_5gq_wqb} {#agnt_clnt_cll-POST-check-def-run__table_fvh_5gq_wqb__entry__2} | En-tête | Description | |-|-| | Aucun | | [Tableau 114. En-têtes de réponses] {#agnt_clnt_cll-POST-check-def-run__table_fvh_5gq_wqb} ### Codes d'état {#agnt_clnt_cll-POST-check-def-run__section_gvh_5gq_wqb} Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d'état possibles utilisés dans l'API REST, consultez [Codes de réponse HTTP de l'API REST](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres."). {#agnt_clnt_cll-POST-check-def-run__table_hvh_5gq_wqb__entry__2}{#agnt_clnt_cll-POST-check-def-run__entry-200-status-code} | Code d'état | Description | |-|-| | 200 | Réussi. La demande a été correctement traitée. | | 400 | Il s'agit d'une erreur dans les arguments fournis dans le corps de la demande. | | 404 | La définition de vérification avec l'ID fourni est introuvable. | | 500 | Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur. | [Tableau 115. Codes d'état] {#agnt_clnt_cll-POST-check-def-run__table_hvh_5gq_wqb} ### Paramètres de corps de réponse (JSON) {#agnt_clnt_cll-POST-check-def-run__section_ivh_5gq_wqb} {#agnt_clnt_cll-POST-check-def-run__table_jvh_5gq_wqb__entry__2} | Nom | Description | |-|-| | requestId | Sys_id de la demande de vérification des antécédents générée. | [ ] {#agnt_clnt_cll-POST-check-def-run__table_jvh_5gq_wqb} ### Demande cURL {#agnt_clnt_cll-POST-check-def-run__example_kvh_5gq_wqb} L'exemple suivant montre comment exécuter une vérification des antécédents et obtenir son ID de demande. 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' Sortie : { "request_id": "278c0170db2a30108a0751f4f3961926" } ## Agent Client Collector : POST /agents/check_defs/{check_def_id}/test {#ariaid-title21} Permet de générer des demandes de vérification de test sur des définitions de vérification. Utilisez cette API pour les tâches suivantes : * Définir la définition de contrôle à tester * Définir l'élément de configuration sur lequel exécuter le test {#agnt_clnt_cll-POST-check-def-test__ul_tdb_gpk_5qb}Vous pouvez également spécifier l'un des identificateurs suivants à utiliser pendant le test : * Informations d'identification sys_id * ID de l'alias d'informations d'identification * Nom des informations d'identification {#agnt_clnt_cll-POST-check-def-test__ul_tft_qwk_5qb} ### Format d'URL /api/sn_agent/agents/check_defs/{check_def_id}/test ### Paramètres de demande pris en charge {#agnt_clnt_cll-POST-check-def-test__entry__2} | Nom | Description | |-|-| | check_def_id | Sys_id de la définition de vérification répertoriée dans la table Définitions de vérification \[sn_agent_check_def\]. | [Tableau 116. Paramètres de chemin d'accès] {#agnt_clnt_cll-POST-check-def-test__entry__6} | Nom | Description | |-|-| | Aucun | | [Tableau 117. Paramètres de requête] {#agnt_clnt_cll-POST-check-def-test__entry__10} | Nom | Description | |-|-| | ci_id | Sys_id d'un élément de configuration CMDB. | | credentials_id | Sys_id d'un enregistrement d'informations d'identification. | | credentials_name | Nom de l'enregistrement des informations d'identification. | | credentials_alias_id | Sys_id d'un enregistrement d'alias d'informations d'identification. | | credentials_alias_name | Nom d'un alias d'informations d'identification. | [Tableau 118. Paramètres du corps de la demande (JSON)] ### En-têtes Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l'API REST, consultez [En-têtes d'API REST pris en charge](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres."). {#agnt_clnt_cll-POST-check-def-test__entry__22}{#agnt_clnt_cll-POST-check-def-test__accept-JSON-only-entry-RESTAPI} | En-tête | Description | |-|-| | Accepter | Format de données du corps de la réponse. Prend uniquement en charge application/json. | [Tableau 119. En-têtes de demandes] {#agnt_clnt_cll-POST-check-def-test__entry__26} | En-tête | Description | |-|-| | Aucun | | [Tableau 120. En-têtes de réponses] ### Codes d'état Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d'état possibles utilisés dans l'API REST, consultez [Codes de réponse HTTP de l'API REST](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres."). {#agnt_clnt_cll-POST-check-def-test__entry__30}{#agnt_clnt_cll-POST-check-def-test__entry-200-status-code} | Code d'état | Description | |-|-| | 200 | Réussi. La demande a été correctement traitée. | | 500 | Erreur lors de la création de la demande de test. | [Tableau 121. Codes d'état] ### Paramètres de corps de réponse (JSON) {#agnt_clnt_cll-POST-check-def-test__section_d5l_yrv_wqb} {#agnt_clnt_cll-POST-check-def-test__table_e5l_yrv_wqb__entry__2} | Nom | Description | |-|-| | result_id | Sys_id de l'enregistrement des résultats du test. | [ ] {#agnt_clnt_cll-POST-check-def-test__table_e5l_yrv_wqb} ## Agent Client Collector : POST /agents/check_instances/{check_instance_id}/test {#ariaid-title22} Permet de générer des demandes de vérification de test sur des instances de vérification. Utilisez cette API pour les tâches suivantes : * Définir l'instance de vérification à tester * Définir l'élément de configuration sur lequel exécuter le test {#agnt_clnt_cll-POST-check-inst-test__ul_tdb_gpk_5qb}Vous pouvez également spécifier l'un des identificateurs suivants à utiliser pendant le test : * Informations d'identification sys_id * ID de l'alias d'informations d'identification * Nom des informations d'identification {#agnt_clnt_cll-POST-check-inst-test__ul_tft_qwk_5qb} ### Format d'URL /api/sn_agent/agents/check_instances/{check_instance_id}/test ### Paramètres de demande pris en charge {#agnt_clnt_cll-POST-check-inst-test__entry__2} | Nom | Description | |-|-| | check_instance_id | Sys_id de la définition de vérification répertoriée dans la table Définitions de vérification \[sn_agent_check_def\]. | [Tableau 122. Paramètres de chemin d'accès] {#agnt_clnt_cll-POST-check-inst-test__entry__6} | Nom | Description | |-|-| | Aucun | | [Tableau 123. Paramètres de requête] {#agnt_clnt_cll-POST-check-inst-test__table_obs_krv_wqb__entry__2} | Nom | Description | |-|-| | ci_id | Sys_id d'un élément de configuration CMDB. | | credentials_id | Sys_id d'un enregistrement d'informations d'identification. | | credentials_name | Nom de l'enregistrement des informations d'identification. | | credentials_alias_id | Sys_id d'un enregistrement d'alias d'informations d'identification. | | credentials_alias_name | Nom d'un alias d'informations d'identification. | | proxy_agent_id | ID unique d'un proxy d'agent pour exécuter cette vérification. Cette valeur est répertoriée dans la colonne ID d'agent de la table Agent Client Collectors \[sn_agent_cmdb_ci_agent\]. | [Tableau 124. Paramètres du corps de la demande (JSON)] {#agnt_clnt_cll-POST-check-inst-test__table_obs_krv_wqb} ### En-têtes Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l'API REST, consultez [En-têtes d'API REST pris en charge](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres."). {#agnt_clnt_cll-POST-check-inst-test__entry__24}{#agnt_clnt_cll-POST-check-inst-test__accept-JSON-only-entry-RESTAPI} | En-tête | Description | |-|-| | Accepter | Format de données du corps de la réponse. Prend uniquement en charge application/json. | [Tableau 125. En-têtes de demandes] {#agnt_clnt_cll-POST-check-inst-test__entry__28} | En-tête | Description | |-|-| | Aucun | | [Tableau 126. En-têtes de réponses] ### Codes d'état Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d'état possibles utilisés dans l'API REST, consultez [Codes de réponse HTTP de l'API REST](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres."). {#agnt_clnt_cll-POST-check-inst-test__table_b2r_5gr_wqb__entry__2}{#agnt_clnt_cll-POST-check-inst-test__entry-200-status-code} | Code d'état | Description | |-|-| | 200 | Réussi. La demande a été correctement traitée. | | 500 | Erreur lors de la création de la demande de test. | [Tableau 127. Codes d'état] {#agnt_clnt_cll-POST-check-inst-test__table_b2r_5gr_wqb} ### Paramètres de corps de réponse (JSON) {#agnt_clnt_cll-POST-check-inst-test__entry__38} | Nom | Description | |-|-| | result_id | Sys_id de l'enregistrement des résultats du test. | [ ] ## Agent Client Collector : POST /agents/update/check/{check_id} {#ariaid-title23} Met à jour une vérification de politique sélectionnée. Pour récupérer les propriétés d'une copie de bac à sable de politique, utilisez [GET /agents/policy/sandbox_from_published/{policy_id}](https://servicenow-prod.fluidtopics.net/QEP8zRm1ZTNaxaPmVG9qAg#agnt_clnt_cll-GET-policy-sbox-fr "Obtient la copie du bac à sable d’une politique publiée et fournit les détails de la politique."). ### Format d'URL /api/sn_agent/agents/update/check/{check_id} ### Paramètres de demande pris en charge {#agnt_clnt_cll-POST-update-check-id__section_vvx_g2z_2pb} {#agnt_clnt_cll-POST-update-check-id__table_n3g_1fs_2pb__entry__2} | Nom | Description | |-|-| | check_id | Sys_id d'une copie de bac à sable de vérification de politique dans la table Vérifier les instances \[sn_agent_check\]. Type de données : chaîne | [Tableau 128. Paramètres de chemin d'accès] {#agnt_clnt_cll-POST-update-check-id__table_n3g_1fs_2pb} {#agnt_clnt_cll-POST-update-check-id__table_wvx_g2z_2pb__entry__2} | Nom | Description | |-|-| | Aucun | | [Tableau 129. Paramètres de requête] {#agnt_clnt_cll-POST-update-check-id__table_wvx_g2z_2pb} {#agnt_clnt_cll-POST-update-check-id__table_xvx_g2z_2pb__entry__2} | Nom | Description | |-|-| | Actif | Marqueur indiquant si la vérification de la politique est active. Valeurs valides : * true : la vérification de la politique est active. * false : la vérification de la politique est inactive. {#agnt_clnt_cll-POST-update-check-id__ul_j2p_sdt_2pb} Type de données : booléennes | | auto_generate | Marqueur indiquant s'il faut générer automatiquement la commande avec la command_prefix valeur. Valeurs valides : * vrai : renseigne automatiquement la propriété avec les valeurs de command paramètres actives. * false : la commande n'est pas générée automatiquement. {#agnt_clnt_cll-POST-update-check-id__ul_myc_x2t_2pb} Type de données : booléennes | | check_type | Type de vérification spécifiant l'option de surveillance. Valeurs possibles : * Détection : vérifie qui localise les CI associés à l'agent. * Événements : le résultat de la vérification est transformé en événement de gestion des événements. * Mesures : les valeurs du résultat de vérification sont transformées en mesures. {#agnt_clnt_cll-POST-update-check-id__ul_pgd_42t_2pb} Type de données : chaîne | | commande | Commande exécutée Agent Client Collector . Paramètre extrait d'un modèle ou d'un CI surveillé. Remarque : Si auto_generate la valeur est vrai, cette propriété est automatiquement renseignée avec le préfixe et les marqueurs des paramètres actifs répertoriés dans l'objet parameters . Type de données : chaîne | | command_prefix | Si la propriété est true, cette commande est utilisée pour la auto_generate génération automatique. Le préfixe se compose d'une partie de la commande statique (qui ne change pas), telle que le nom du script. Type de données : chaîne | | event_status_change_threshold | Nombre de fois consécutives où l'état de la réponse d'un chèque doit se produire avant qu'un nouvel événement ne soit envoyé. Renvoie null s'il n'est pas défini. Par exemple, si cette valeur est égale à 3, une vérification dont l'état de la réponse passe de OK à Erreur génère un nouvel événement avec un état Erreur après la troisième occurrence consécutive du changement d'état. Type de données : nombre | | event_status_repair_threshold | Nombre de fois consécutives où l'état de la réponse d'une vérification doit s'améliorer pour fermer l'événement précédent. Renvoie null s'il n'est pas défini. Par exemple, si cette valeur est égale à 3, une vérification dont l'état de réponse passe d'Erreur à OK ferme l'événement précédent et génère un nouvel événement avec un état OK après la troisième occurrence consécutive du changement d'état. Type de données : nombre | | intervalle | Durée, en secondes, d'attente entre les exécutions de vérification. Par exemple, une valeur de 60 signifie que la vérification s'exécute toutes les 60 secondes. Type de données : nombre | | nom | Nom du chèque. Type de données : chaîne | | timeout | Durée, en secondes, après laquelle l'exécution de la vérification s'arrête lorsqu'aucune sortie n'est renvoyée. Par exemple, une valeur de 60 signifie que, lorsque l'exécution de la vérification ne renvoie pas une valeur pendant 60 secondes, l'exécution s'arrête. Type de données : chaîne | [Tableau 130. Paramètres du corps de la demande (JSON)] {#agnt_clnt_cll-POST-update-check-id__table_xvx_g2z_2pb} ### En-têtes {#agnt_clnt_cll-POST-update-check-id__section_yvx_g2z_2pb} Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l'API REST, consultez [En-têtes d'API REST pris en charge](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres."). {#agnt_clnt_cll-POST-update-check-id__table_zvx_g2z_2pb__entry__2}{#agnt_clnt_cll-POST-update-check-id__accept-JSON-only-entry-RESTAPI} | En-tête | Description | |-|-| | Accepter | Format de données du corps de la réponse. Prend uniquement en charge application/json. | [Tableau 131. En-têtes de demandes] {#agnt_clnt_cll-POST-update-check-id__table_zvx_g2z_2pb} {#agnt_clnt_cll-POST-update-check-id__table_awx_g2z_2pb__entry__2} | En-tête | Description | |-|-| | Aucun | | [Tableau 132. En-têtes de réponses] {#agnt_clnt_cll-POST-update-check-id__table_awx_g2z_2pb} ### Codes d'état {#agnt_clnt_cll-POST-update-check-id__section_bwx_g2z_2pb} Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d'état possibles utilisés dans l'API REST, consultez [Codes de réponse HTTP de l'API REST](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres."). {#agnt_clnt_cll-POST-update-check-id__table_cwx_g2z_2pb__entry__2}{#agnt_clnt_cll-POST-update-check-id__entry-200-status-code}{#agnt_clnt_cll-POST-update-check-id__agntCC-desc-403-admin}{#agnt_clnt_cll-POST-update-check-id__entry-500-status-code} | Code d'état | Description | |-|-| | 200 | Réussi. La demande a été correctement traitée. | | 403 | L'utilisateur n'a pas le rôle agent_client_collector_admin. | | 404 | Aucun enregistrement trouvé avec le sys_id fourni. | | 500 | Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur. | [Tableau 133. Codes d'état] {#agnt_clnt_cll-POST-update-check-id__table_cwx_g2z_2pb} ### Paramètres de corps de réponse (JSON) {#agnt_clnt_cll-POST-update-check-id__section_dwx_g2z_2pb} {#agnt_clnt_cll-POST-update-check-id__table_ewx_g2z_2pb__entry__2} | Nom | Description | |-|-| | message | Message contenant les résultats de réussite ou d'échec de l'opération. Type de données : chaîne | [ ] {#agnt_clnt_cll-POST-update-check-id__table_ewx_g2z_2pb} ### Demande cURL {#agnt_clnt_cll-POST-update-check-id__example_fwx_g2z_2pb} L'exemple suivant montre comment mettre à jour les propriétés de changement et de réparation d'événement d'une vérification de police. curl "https://instance.service-now.com/api/sn_agent/agents/update/check/" \ --request POST \ --header "Accept:application/json" \ --header "Content-Type:application/json" \ --data "{ \"event_status_change_threshold\" : \"2\", \"event_status_repair_threshold\" : \"1\" }" \ --user 'username':'password' Sortie : { "message": "Operation was successful" } ## Agent Client Collector : POST /agents/update/check_def_params/{check_def_param_id} {#ariaid-title24} Permet de modifier une ou plusieurs valeurs de champ d'un paramètre de vérification spécifié. ### Format d'URL /api/sn_agent/agents/update/check_def_params/{check_def_param_id} ### Paramètres de demande pris en charge {#agnt_clnt_cll-POST-up-check-def-p__entry__2} | Nom | Description | |-|-| | check_def_param_id | Sys_id du paramètre de vérification répertorié dans la table Définitions des paramètres de vérification \[sn_agent_check_param_def\]. Type de données : chaîne | [Tableau 134. Paramètres de chemin d'accès] {#agnt_clnt_cll-POST-up-check-def-p__entry__6} | Nom | Description | |-|-| | Aucun | | [Tableau 135. Paramètres de requête] {#agnt_clnt_cll-POST-up-check-def-p__table_fhm_klr_wqb__entry__2} | Nom | Description | |-|-| | Actif | Marqueur indiquant si le paramètre de vérification est actif. Valeurs valides : * true : le paramètre de vérification est actif. * false : le paramètre check est inactif. {#agnt_clnt_cll-POST-up-check-def-p__ul_pnb_jyc_wqb} Type de données : booléennes | | default_value | Spécifie la valeur par défaut de ce paramètre de vérification. Type de données : chaîne | | obligatoire | Marqueur indiquant si le paramètre de vérification est requis. Valeurs valides : * true : le paramètre check est requis. * false : le paramètre check est facultatif. {#agnt_clnt_cll-POST-up-check-def-p__ul_wtg_2zc_wqb} Type de données : booléennes | | nom | Nom du paramètre de vérification. Type de données : chaîne | [Tableau 136. Paramètres du corps de la demande (JSON)] {#agnt_clnt_cll-POST-up-check-def-p__table_fhm_klr_wqb} Remarque : Consultez le dictionnaire de données pour obtenir une liste complète des champs et des types de vérification de définition. ### En-têtes Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l'API REST, consultez [En-têtes d'API REST pris en charge](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres."). {#agnt_clnt_cll-POST-up-check-def-p__entry__20}{#agnt_clnt_cll-POST-up-check-def-p__accept-JSON-only-entry-RESTAPI} | En-tête | Description | |-|-| | Accepter | Format de données du corps de la réponse. Prend uniquement en charge application/json. | [Tableau 137. En-têtes de demandes] {#agnt_clnt_cll-POST-up-check-def-p__entry__24} | En-tête | Description | |-|-| | Aucun | | [Tableau 138. En-têtes de réponses] ### Codes d'état Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d'état possibles utilisés dans l'API REST, consultez [Codes de réponse HTTP de l'API REST](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres."). {#agnt_clnt_cll-POST-up-check-def-p__table_tfm_ykr_wqb__entry__2}{#agnt_clnt_cll-POST-up-check-def-p__entry-200-status-code} | Code d'état | Description | |-|-| | 200 | Réussi. La demande a été correctement traitée. | | 404 | Le paramètre de vérification est introuvable avec sys_id fournie. | | 500 | Erreur lors de la mise à jour du paramètre de vérification. | [Tableau 139. Codes d'état] {#agnt_clnt_cll-POST-up-check-def-p__table_tfm_ykr_wqb} ### Paramètres de corps de réponse (JSON) {#agnt_clnt_cll-POST-up-check-def-p__table_t3p_kmr_wqb__entry__2} | Nom | Description | |-|-| | Aucun | Message de réussite ou d'erreur. | [ ] {#agnt_clnt_cll-POST-up-check-def-p__table_t3p_kmr_wqb} ### Demande cURL L'exemple suivant montre comment activer un paramètre de vérification. 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' Sortie : "message": "Check Definition Parameter Updated Successfully" ## Agent Client Collector : POST /agents/update/check_def_secure_params/{check_def_secure_param_id} {#ariaid-title25} Permet de changer une ou plusieurs valeurs de champ d'un paramètre de sécurité de vérification spécifié. ### Format d'URL /api/sn_agent/agents/update/check_def_secure_params/{check_def_secure_param_id} ### Paramètres de demande pris en charge {#agnt_clnt_cll-POST-up-check-def-sp__entry__2} | Nom | Description | |-|-| | check_def_secure_param_id | Sys_id du paramètre sécurisé répertorié dans la table Vérifier les définitions de paramètres sécurisés \[sn_agent_check_secure_param_def\]. Type de données : chaîne | [Tableau 140. Paramètres de chemin d'accès] {#agnt_clnt_cll-POST-up-check-def-sp__entry__6} | Nom | Description | |-|-| | Aucun | | [Tableau 141. Paramètres de requête] {#agnt_clnt_cll-POST-up-check-def-sp__entry__10} | Nom | Description | |-|-| | Actif | Marqueur indiquant si le paramètre sécurisé est actif. Valeurs valides : * true : le paramètre sécurisé est actif. * faux : le paramètre sécurisé est inactif. {#agnt_clnt_cll-POST-up-check-def-sp__ul_g1b_3vc_wqb} Type de données : booléennes | | nom | Nom du paramètre sécurisé. Type de données : chaîne | | order | Ordre dans lequel le paramètre est envoyé à la commande/au script de vérification. Type de données : chaîne | [Tableau 142. Paramètres du corps de la demande (JSON)] ### En-têtes Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l'API REST, consultez [En-têtes d'API REST pris en charge](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres."). {#agnt_clnt_cll-POST-up-check-def-sp__entry__18}{#agnt_clnt_cll-POST-up-check-def-sp__accept-JSON-only-entry-RESTAPI} | En-tête | Description | |-|-| | Accepter | Format de données du corps de la réponse. Prend uniquement en charge application/json. | [Tableau 143. En-têtes de demandes] {#agnt_clnt_cll-POST-up-check-def-sp__entry__22} | En-tête | Description | |-|-| | Aucun | | [Tableau 144. En-têtes de réponses] ### Codes d'état Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d'état possibles utilisés dans l'API REST, consultez [Codes de réponse HTTP de l'API REST](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres."). {#agnt_clnt_cll-POST-up-check-def-sp__table_rst_ykr_wqb__entry__2}{#agnt_clnt_cll-POST-up-check-def-sp__entry-200-status-code} | Code d'état | Description | |-|-| | 200 | Réussi. La demande a été correctement traitée. | | 404 | Le paramètre de sécurité de vérification est introuvable avec sys_id fourni. | | 500 | Erreur lors de la mise à jour du paramètre de sécurité de la vérification. | [Tableau 145. Codes d'état] {#agnt_clnt_cll-POST-up-check-def-sp__table_rst_ykr_wqb} ### Paramètres de corps de réponse (JSON) {#agnt_clnt_cll-POST-up-check-def-sp__table_lfq_5kr_wqb__entry__2} | Nom | Description | |-|-| | Aucun | Message de réussite ou d'erreur. | [ ] {#agnt_clnt_cll-POST-up-check-def-sp__table_lfq_5kr_wqb} ### Demande cURL L'exemple suivant montre comment activer un paramètre de sécurité de contrôle. 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' Sortie : "message": "Check Definition Secure Parameter Updated Successfully" ## Agent Client Collector : POST /agents/update/check_defs/{check_def_id} {#ariaid-title26} Permet de changer une ou plusieurs valeurs de champ d'une définition de contrôle spécifiée. ### Format d'URL /api/sn_agent/agents/update/check_defs/{check_def_id} ### Paramètres de demande pris en charge {#agnt_clnt_cll-POST-up-check-def-cd__entry__2} | Nom | Description | |-|-| | check_def_id | Sys_id de la définition de vérification répertoriée dans la table Définitions de vérification \[sn_agent_check_def\]. Type de données : chaîne | [Tableau 146. Paramètres de chemin d'accès] {#agnt_clnt_cll-POST-up-check-def-cd__entry__6} | Nom | Description | |-|-| | Aucun | | [Tableau 147. Paramètres de requête] {#agnt_clnt_cll-POST-up-check-def-cd__entry__10} | Nom | Description | |-|-| | Actif | Indique si cette définition de vérification est active. Valeurs valides : * 0 : cette définition de vérification est inactive. * 1 : cette définition de vérification est active. {#agnt_clnt_cll-POST-up-check-def-cd__ul_gdc_4wj_wqb} Type de données : nombre | | arrière-plan | Marqueur indiquant si cette définition de vérification est une vérification d'antécédents. Une vérification des antécédents est une vérification que l'agent commence à exécuter sans attendre qu'elle se termine. Valeurs valides : * true : cette définition de vérification est une vérification d'arrière-plan. * false : cette définition de vérification n'est pas une vérification des antécédents. {#agnt_clnt_cll-POST-up-check-def-cd__ul_ypb_5ps_5qb} Type de données : booléennes | | check_group | Groupe spécifié pour cette définition de vérification. | | check_type | Type de vérification. Valeurs possibles : * Événements : vérifiez que les résultats sont transformés en événement de gestion des événements. * Mesures : les valeurs du résultat de vérification sont transformées en mesures. {#agnt_clnt_cll-POST-up-check-def-cd__ul_gtr_kfb_wqb} Type de données : chaîne | | commande | Commande exécutée Agent Client Collector . Type de données : chaîne | | nom | Nom du chèque. Type de données : chaîne | | paramètres | Carte des noms et des valeurs des paramètres. Ces paramètres peuvent être utilisés pour remplacer les enregistrements de paramètres de la définition de contrôle et ses valeurs spécifiées. "params": { "": "String" } Type de données : objet | | modules d'extension | Liste des [Agent Client Collector modules d'extension](https://www.servicenow.com/docs/access?context=acc-assets&version=xanadu&pubname=xanadu-it-operations-management&ft:locale=en-US) associé à cette vérification. Type de données : tableau | | proxy_valid | Marqueur indiquant si la politique de définition de vérification est définie pour fonctionner en tant que proxy. Valeurs valides : * true : cette politique de définition de vérification est définie pour fonctionner en tant que proxy. * false : cette politique de définition de vérification n'est pas définie pour fonctionner en tant que proxy. {#agnt_clnt_cll-POST-up-check-def-cd__ul_wbf_qps_5qb} Type de données : booléennes | | requête | Requête codée pour récupérer le GlideRecord à partir de la table spécifiée dans la table propriété. Type de données : chaîne | | table | Nom de la table cmdb_ci pour cette vérification. Type de données : chaîne | | timeout | Délai en secondes. Type de données : nombre | [Tableau 148. Paramètres du corps de la demande (JSON)] Remarque : Consultez le dictionnaire de données pour obtenir une liste complète des champs et des types de vérification de définition. ### En-têtes Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l'API REST, consultez [En-têtes d'API REST pris en charge](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres."). {#agnt_clnt_cll-POST-up-check-def-cd__entry__36}{#agnt_clnt_cll-POST-up-check-def-cd__accept-JSON-only-entry-RESTAPI} | En-tête | Description | |-|-| | Accepter | Format de données du corps de la réponse. Prend uniquement en charge application/json. | [Tableau 149. En-têtes de demandes] {#agnt_clnt_cll-POST-up-check-def-cd__entry__40} | En-tête | Description | |-|-| | Aucun | | [Tableau 150. En-têtes de réponses] ### Codes d'état Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d'état possibles utilisés dans l'API REST, consultez [Codes de réponse HTTP de l'API REST](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres."). {#agnt_clnt_cll-POST-up-check-def-cd__entry__44}{#agnt_clnt_cll-POST-up-check-def-cd__entry-200-status-code} | Code d'état | Description | |-|-| | 200 | Réussi. La demande a été correctement traitée. | | 404 | La définition de vérification est introuvable avec sys_id fournie. | | 500 | Erreur lors de la mise à jour de la définition de vérification. | [Tableau 151. Codes d'état] ### Paramètres de corps de réponse (JSON) {#agnt_clnt_cll-POST-up-check-def-cd__entry__52} | Nom | Description | |-|-| | Aucun | Message de réussite ou d'erreur. | [ ] ### Demande cURL L'exemple suivant montre comment désactiver une définition de vérification. 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' Sortie : "message": "Check Definition Updated Successfully" ## Agent Client Collector : POST /agents/update/check_param/{param_id} {#ariaid-title27} Met à jour un paramètre de vérification de politique sélectionné. Pour récupérer les propriétés d'une copie de bac à sable de politique, utilisez [GET /agents/policy/sandbox_from_published/{policy_id}](https://servicenow-prod.fluidtopics.net/QEP8zRm1ZTNaxaPmVG9qAg#agnt_clnt_cll-GET-policy-sbox-fr "Obtient la copie du bac à sable d’une politique publiée et fournit les détails de la politique."). ### Format d'URL /api/sn_agent/agents/update/check_param/{param_id} ### Paramètres de demande pris en charge {#agnt_clnt_cll-POST-update-check_param__section_dvh_g2z_2pb} {#agnt_clnt_cll-POST-update-check_param__table_n3g_1fs_2pb__entry__2} | Nom | Description | |-|-| | param_id | Sys_id de la copie du bac à sable des paramètres de vérification de la politique dans la table Paramètres de vérification \[sn_agent_check_param\]. Type de données : chaîne | [Tableau 152. Paramètres de chemin d'accès] {#agnt_clnt_cll-POST-update-check_param__table_n3g_1fs_2pb} {#agnt_clnt_cll-POST-update-check_param__table_evh_g2z_2pb__entry__2} | Nom | Description | |-|-| | Aucun | | [Tableau 153. Paramètres de requête] {#agnt_clnt_cll-POST-update-check_param__table_evh_g2z_2pb} {#agnt_clnt_cll-POST-update-check_param__table_fvh_g2z_2pb__entry__2} | Nom | Description | |-|-| | Actif | Marqueur indiquant si le paramètre de vérification est actif. Valeurs valides : * vrai : vérifier que le paramètre est actif. * false : vérifier que le paramètre est inactif. {#agnt_clnt_cll-POST-update-check_param__ul_u2x_5fv_2pb} Type de données : booléennes | | marqueur | | | obligatoire | Marqueur indiquant si cette vérification est obligatoire. Valeurs valides : * true : cette vérification est obligatoire. * false : cette vérification est facultative. {#agnt_clnt_cll-POST-update-check_param__ul_flq_qkv_2pb} Type de données : booléennes | | nom | Nom du paramètre. Type de données : chaîne | | valide | Valeur du paramètre. Type de données : chaîne | | value_required | Marqueur indiquant si les informations fournies par la propriété value sont requises. Valeurs valides : * true : la propriété value est requise. * faux : la propriété de valeur est nulle ou non obligatoire. {#agnt_clnt_cll-POST-update-check_param__ul_ug3_3jv_2pb} Type de données : booléennes | [Tableau 154. Paramètres du corps de la demande (JSON)] {#agnt_clnt_cll-POST-update-check_param__table_fvh_g2z_2pb} ### En-têtes {#agnt_clnt_cll-POST-update-check_param__section_gvh_g2z_2pb} Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l'API REST, consultez [En-têtes d'API REST pris en charge](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres."). {#agnt_clnt_cll-POST-update-check_param__table_hvh_g2z_2pb__entry__2}{#agnt_clnt_cll-POST-update-check_param__accept-JSON-only-entry-RESTAPI} | En-tête | Description | |-|-| | Accepter | Format de données du corps de la réponse. Prend uniquement en charge application/json. | [Tableau 155. En-têtes de demandes] {#agnt_clnt_cll-POST-update-check_param__table_hvh_g2z_2pb} {#agnt_clnt_cll-POST-update-check_param__table_ivh_g2z_2pb__entry__2} | En-tête | Description | |-|-| | Aucun | | [Tableau 156. En-têtes de réponses] {#agnt_clnt_cll-POST-update-check_param__table_ivh_g2z_2pb} ### Codes d'état {#agnt_clnt_cll-POST-update-check_param__section_jvh_g2z_2pb} Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d'état possibles utilisés dans l'API REST, consultez [Codes de réponse HTTP de l'API REST](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres."). {#agnt_clnt_cll-POST-update-check_param__table_kvh_g2z_2pb__entry__2}{#agnt_clnt_cll-POST-update-check_param__entry-200-status-code}{#agnt_clnt_cll-POST-update-check_param__agntCC-desc-403-admin}{#agnt_clnt_cll-POST-update-check_param__entry-500-status-code} | Code d'état | Description | |-|-| | 200 | Réussi. La demande a été correctement traitée. | | 403 | L'utilisateur n'a pas le rôle agent_client_collector_admin. | | 404 | Aucun enregistrement trouvé avec le sys_id fourni. | | 500 | Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur. | [Tableau 157. Codes d'état] {#agnt_clnt_cll-POST-update-check_param__table_kvh_g2z_2pb} ### Paramètres de corps de réponse (JSON) {#agnt_clnt_cll-POST-update-check_param__section_lvh_g2z_2pb} {#agnt_clnt_cll-POST-update-check_param__table_mvh_g2z_2pb__entry__2} | Nom | Description | |-|-| | message | Message contenant les résultats de réussite ou d'échec de l'opération. Type de données : chaîne | [ ] {#agnt_clnt_cll-POST-update-check_param__table_mvh_g2z_2pb} ### Demande cURL {#agnt_clnt_cll-POST-update-check_param__example_nvh_g2z_2pb} L'exemple suivant montre comment mettre à jour plusieurs propriétés d'un paramètre de vérification de politique. curl "https://instance.service-now.com/api/sn_agent/agents/update/check_param/" \ --request POST \ --header "Accept:application/json" \ --header "Content-Type:application/json" \ --data "{ \"flag\" : \"-d\", \"mandatory\" : \"true\", \"name\" : \"scheme2\", \"value\" : \"120\", \"value_required\" : \"false\" }" \ --user 'username':'password' Sortie : { "message": "Operation was successful" } ## Agent Client Collector : POST /agents/update/check_secure_param/{param_id} {#ariaid-title28} Met à jour un paramètre sécurisé de vérification de politique sélectionné. Pour récupérer les propriétés d'une copie de bac à sable de politique, utilisez [GET /agents/policy/sandbox_from_published/{policy_id}](https://servicenow-prod.fluidtopics.net/QEP8zRm1ZTNaxaPmVG9qAg#agnt_clnt_cll-GET-policy-sbox-fr "Obtient la copie du bac à sable d’une politique publiée et fournit les détails de la politique."). ### Format d'URL /api/sn_agent/agents/update/check_secure_param/{param_id} ### Paramètres de demande pris en charge {#agnt_clnt_cll-POST-update-check_secure__section_dzx_f2z_2pb} {#agnt_clnt_cll-POST-update-check_secure__table_n3g_1fs_2pb__entry__2} | Nom | Description | |-|-| | param_id | Sys_id de la copie du bac à sable pour les paramètres sécurisés de vérification de la politique dans la table Vérifier les paramètres sécurisés \[sn_agent_check_secure_param\]. Type de données : chaîne | [Tableau 158. Paramètres de chemin d'accès] {#agnt_clnt_cll-POST-update-check_secure__table_n3g_1fs_2pb} {#agnt_clnt_cll-POST-update-check_secure__table_ezx_f2z_2pb__entry__2} | Nom | Description | |-|-| | Aucun | | [Tableau 159. Paramètres de requête] {#agnt_clnt_cll-POST-update-check_secure__table_ezx_f2z_2pb} {#agnt_clnt_cll-POST-update-check_secure__table_fzx_f2z_2pb__entry__2} | Nom | Description | |-|-| | Actif | Marqueur indiquant si le paramètre de vérification de la sécurité est actif. Valeurs valides : * true : le paramètre vérifier la sécurité est actif. * false : le paramètre vérifier la sécurité est inactif. {#agnt_clnt_cll-POST-update-check_secure__ul_xwy_vfv_2pb} Type de données : booléennes | | nom | Nom du paramètre sécurisé. Type de données : chaîne | | order | Ordre dans lequel le paramètre est envoyé à la commande/au script de vérification. Type de données : nombre | [Tableau 160. Paramètres du corps de la demande (JSON)] {#agnt_clnt_cll-POST-update-check_secure__table_fzx_f2z_2pb} ### En-têtes {#agnt_clnt_cll-POST-update-check_secure__section_gzx_f2z_2pb} Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l'API REST, consultez [En-têtes d'API REST pris en charge](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres."). {#agnt_clnt_cll-POST-update-check_secure__table_hzx_f2z_2pb__entry__2}{#agnt_clnt_cll-POST-update-check_secure__accept-JSON-only-entry-RESTAPI} | En-tête | Description | |-|-| | Accepter | Format de données du corps de la réponse. Prend uniquement en charge application/json. | [Tableau 161. En-têtes de demandes] {#agnt_clnt_cll-POST-update-check_secure__table_hzx_f2z_2pb} {#agnt_clnt_cll-POST-update-check_secure__table_izx_f2z_2pb__entry__2} | En-tête | Description | |-|-| | Aucun | | [Tableau 162. En-têtes de réponses] {#agnt_clnt_cll-POST-update-check_secure__table_izx_f2z_2pb} ### Codes d'état {#agnt_clnt_cll-POST-update-check_secure__section_jzx_f2z_2pb} Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d'état possibles utilisés dans l'API REST, consultez [Codes de réponse HTTP de l'API REST](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres."). {#agnt_clnt_cll-POST-update-check_secure__table_kzx_f2z_2pb__entry__2}{#agnt_clnt_cll-POST-update-check_secure__entry-200-status-code}{#agnt_clnt_cll-POST-update-check_secure__agntCC-desc-403-admin}{#agnt_clnt_cll-POST-update-check_secure__entry-500-status-code} | Code d'état | Description | |-|-| | 200 | Réussi. La demande a été correctement traitée. | | 403 | L'utilisateur n'a pas le rôle agent_client_collector_admin. | | 404 | Aucun enregistrement trouvé avec le sys_id fourni. | | 500 | Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur. | [Tableau 163. Codes d'état] {#agnt_clnt_cll-POST-update-check_secure__table_kzx_f2z_2pb} ### Paramètres de corps de réponse (JSON) {#agnt_clnt_cll-POST-update-check_secure__section_lzx_f2z_2pb} {#agnt_clnt_cll-POST-update-check_secure__table_mzx_f2z_2pb__entry__2} | Nom | Description | |-|-| | message | Message contenant les résultats de réussite ou d'échec de l'opération. Type de données : chaîne | [ ] {#agnt_clnt_cll-POST-update-check_secure__table_mzx_f2z_2pb} ### Demande cURL {#agnt_clnt_cll-POST-update-check_secure__example_nzx_f2z_2pb} L'exemple suivant montre comment mettre à jour les propriétés d'un paramètre sécurisé de vérification de politique. curl "https://instance.service-now.com/api/sn_agent/agents/update/check_secure_param/" \ --request POST \ --header "Accept:application/json" \ --header "Content-Type:application/json" \ --data "{ \"name\" : \"new name\", \"order\" : \"2\" }" \ --user 'username':'password' Sortie : { "message": "Operation was successful" } ## Agent Client Collector : POST /agents/update/policy/{policy_id} {#ariaid-title29} Met à jour une copie sandbox d'une politique. Pour récupérer les propriétés d'une copie de bac à sable de politique, utilisez [GET /agents/policy/sandbox_from_published/{policy_id}](https://servicenow-prod.fluidtopics.net/QEP8zRm1ZTNaxaPmVG9qAg#agnt_clnt_cll-GET-policy-sbox-fr "Obtient la copie du bac à sable d’une politique publiée et fournit les détails de la politique."). ### Format d'URL /api/sn_agent/agents/update/policy/{policy_id} ### Paramètres de demande pris en charge {#agnt_clnt_cll-POST-update-policy__table_n3g_1fs_2pb__entry__2} | Nom | Description | |-|-| | policy_id | Sys_id d'une copie de bac à sable de politique dans la table Politiques \[sn_agent_policy\]. Type de données : chaîne | [Tableau 164. Paramètres de chemin d'accès] {#agnt_clnt_cll-POST-update-policy__table_n3g_1fs_2pb} {#agnt_clnt_cll-POST-update-policy__entry__6} | Nom | Description | |-|-| | Aucun | | [Tableau 165. Paramètres de requête] {#agnt_clnt_cll-POST-update-policy__entry__10} | Nom | Description | |-|-| | cred_alias | Nom répertorié dans la table Informations d'identification \[discovery_credentials\]. Type de données : chaîne | | credential_alias | Sys_id de l'alias d'informations d'identification dans la table Alias de connexion et d'informations d'identification \[sys_alias\]. Type de données : chaîne | | filtre | Filtre limitant les vérifications de la politique pour surveiller uniquement les critères spécifiés. Type de données : chaîne | | intervalle | Durée, en secondes, d'attente entre les vérifications de politique. Par exemple, une valeur de 60 signifie que la vérification s'exécute toutes les 60 secondes. Remarque : La valeur de la checks.interval propriété remplace la valeur configurée dans ce champ. Type de données : nombre | | monitored_ci_group | Nom [des groupes CMDB](https://www.servicenow.com/docs/access?context=cmdb-groups&version=xanadu&pubname=xanadu-servicenow-platform&ft:locale=en-US) associés à la politique. Cette CMDB est répertoriée dans la table Groupes de CMDB \[cmdb_group\]. Ce champ n'est appliqué que si la valeur de la monitored_ci_type_group propriété est vraie. Type de données : chaîne | | monitored_ci_script | Script de surveillance des CI. Ce champ n'est appliqué que si la valeur de la policies.monitored_ci_type_script propriété est vraie. Type de données : chaîne | | monitored_ci_type_filter | Marqueur indiquant si le filtrage par type de CI est activé. Le type de CI est répertorié dans la table propriété. Valeurs valides : * vrai : le filtrage par groupe de vérifications est activé. * faux : le filtrage par groupe de vérifications est désactivé. {#agnt_clnt_cll-POST-update-policy__ul_tvm_fvt_2pb} Type de données : booléennes | | monitored_ci_type_group | Marqueur indiquant si la surveillance par type de groupe CMDB est activée. Valeurs valides : * vrai : le type de groupe CMDB est activé. * faux : le type de groupe CMDB est désactivé. {#agnt_clnt_cll-POST-update-policy__ul_jrc_fvt_2pb} Type de données : booléennes | | monitored_ci_type_script | Marqueur indiquant si le script de surveillance des CI est activé. Valeurs valides : * vrai : le script de surveillance des CI est activé. * faux : le script de surveillance des CI est désactivé. {#agnt_clnt_cll-POST-update-policy__ul_bs4_3wt_2pb} Type de données : booléennes | | nom | Nom de la politique. Type de données : chaîne | | table | Champ Type de CI surveillé dans la politique. Ce champ ne s'applique que si la monitored_ci_type_filter valeur est vrai. Type de données : chaîne | [Tableau 166. Paramètres du corps de la demande (JSON)] ### En-têtes Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l'API REST, consultez [En-têtes d'API REST pris en charge](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres."). {#agnt_clnt_cll-POST-update-policy__entry__34}{#agnt_clnt_cll-POST-update-policy__accept-JSON-only-entry-RESTAPI} | En-tête | Description | |-|-| | Accepter | Format de données du corps de la réponse. Prend uniquement en charge application/json. | [Tableau 167. En-têtes de demandes] {#agnt_clnt_cll-POST-update-policy__entry__38} | En-tête | Description | |-|-| | Aucun | | [Tableau 168. En-têtes de réponses] ### Codes d'état Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d'état possibles utilisés dans l'API REST, consultez [Codes de réponse HTTP de l'API REST](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres."). {#agnt_clnt_cll-POST-update-policy__entry__42}{#agnt_clnt_cll-POST-update-policy__entry-200-status-code}{#agnt_clnt_cll-POST-update-policy__agntCC-desc-403-admin}{#agnt_clnt_cll-POST-update-policy__entry-500-status-code} | Code d'état | Description | |-|-| | 200 | Réussi. La demande a été correctement traitée. | | 403 | L'utilisateur n'a pas le rôle agent_client_collector_admin. | | 404 | Aucun enregistrement trouvé avec le sys_id fourni. | | 500 | Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur. | [Tableau 169. Codes d'état] ### Paramètres de corps de réponse (JSON) {#agnt_clnt_cll-POST-update-policy__entry__52} | Nom | Description | |-|-| | message | Message contenant les résultats de réussite ou d'échec de l'opération. Type de données : chaîne | [ ] ### Demande cURL L'exemple suivant montre comment mettre à jour le nom et les propriétés/champs de filtre d'une politique. curl "https://instance.service-now.com/api/sn_agent/agents/update/policy/" \--request POST \ --header "Accept:application/json" \ --header "Content-Type:application/json" \ --data "{ \"name\" : \"new policy name\", \"filter\" : \"operational_status=1\" }" \ --user 'username':'password' Sortie : { "message": "Operation was successful" }