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


---

# DiscoveryAPI : inclus dans le champ d'application

# DiscoveryAPI : inclus dans le champ d'application {#ariaid-title1}

* Rversion finale: Xanadu
* 
* Mis à jour 1 août 2024
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 3 minutes de lecture

La classe DiscoveryAPI fournit des méthodes qui lancent une détection rapide d'une seule adresse IPv4 et renvoient des résumés des statuts de détection précédemment lancés pour un seul élément de configuration (CI) ou pour tous les CI analysés.

Cette classe s'exécute dans l'espace `de noms sn_discovery` .

## DiscoveryAPI : discoverIpAddress(String ipAddress, String application, String source) {#ariaid-title2}

Détecte une adresse IPv4 spécifiée.
Un MID Server est sélectionné automatiquement, en fonction de l'adresse IP fournie ou de l'application spécifiée.
{#r_DiscoAPIdiscoverIpAddress__table_c4m_wcd_qcb__entry__3}

| Nom | Type | Description |
|-|-|-|
| l'application | Chaîne | Facultatif. Application configurée pour Serveur MID. Pour définir un source paramètre, mais pas un application paramètre, utilisez \<\< NULL \>\> comme espace réservé. Par défaut : Discovery |
| ipAddress | Chaîne | Adresse IP à détecter. |
| source | Chaîne | Facultatif. Source de la découverte. Cette même valeur apparaît dans le champ Source facultatif de l'enregistrement Statut de découverte, qui indique comment la découverte a été déclenchée. Par défaut : Discovery_API |
[Tableau 1. Paramètres]

{#r_DiscoAPIdiscoverIpAddress__table_c4m_wcd_qcb} {#r_DiscoAPIdiscoverIpAddress__table_d4m_wcd_qcb__entry__2}

| Type | Description |
|-|-|
| Chaîne | L'enregistrement du statut de découverte sys_id. Les exceptions suivantes peuvent être levées lors de la sélection du Serveur MID : * NoSuitableMidServerFoundException: `aucun Serveur MID approprié disponible pour cette découverte` * BadArgumentException: `argument non valide détecté lors de la sélection du Serveur MID` {#r_DiscoAPIdiscoverIpAddress__ul_ms4_lqj_qcb} |
[Tableau 2. Renvoie]

{#r_DiscoAPIdiscoverIpAddress__table_d4m_wcd_qcb}  

    var sysid = sn_discovery.DiscoveryAPI.discoverIpAddress("11.23.125.39");

## DiscoveryAPI : reportCiIpAddressStatus(Object ipAddress, Object discoveryStatusSysId) {#ariaid-title3}

Utilisé pour renvoyer un résumé de l'état de détection d'un élément de configuration compte tenu de l'état spécifique sys_id et de l'adresse IPv4.
Les exceptions suivantes peuvent être levées :

* DiscoveryStatusNotFoundException: `affiche ce message : Le statut de découverte avec l'ID système << < `valeur non valide`> >> n'existe pas.`
* DiscoveryDeviceHistoryNotFoundException: `l'historique des appareils avec l'ID système du statut de détection << < `valeur invalide` > >> et ipAddress << < `valeur invalide` > >> n'existe pas`
* IllegalArgumentException (arguments d'entrée non valides) : cette exception d'argument empêche les valeurs d'entrée d'être nulles.
  * `L'ID système du statut de découverte ne peut pas être nul `
  * `ipAddress ne peut pas être nul`
  {#r_DiscoAPIreportCiIpAddressStatus__ul_ul2_c4t_rcb}
* IllegalArgumentException (valeurs stockées dans la base de données) : cette exception d'argument empêche les données erronées d'être renvoyées à l'appelant en cas de mauvaises valeurs d'attribut.
  * `Statut de découverte La propriété << state >> ne peut pas être nulle.`
  * `La propriété << source >> de l'historique de l'appareil ne peut pas être nulle `
  * `La propriété << problèmes >> de l'historique de l'appareil n'est pas un nombre entier : <`valeur non valide`>`
  * `La propriété << problèmes >> de l'historique des appareils ne peut pas être inférieure à 0 : <`valeur non valide`>`
  {#r_DiscoAPIreportCiIpAddressStatus__ul_pjt_j4t_rcb}
{#r_DiscoAPIreportCiIpAddressStatus__ul_ztk_gft_rcb}
{#r_DiscoAPIreportCiIpAddressStatus__table_jlm_mts_rcb__entry__3}

| Nom | Type | Description |
|-|-|-|
| ipAddress | chaîne | L'adresse IPv4 qui a été analysée. |
| discoveryStatusSysId | chaîne | La sys_id de l'enregistrement de l'état de découverte pour l'adresse IP qui a été analysée. |
[Tableau 3. Paramètres]

{#r_DiscoAPIreportCiIpAddressStatus__table_jlm_mts_rcb} {#r_DiscoAPIreportCiIpAddressStatus__table_klm_mts_rcb__entry__2}

| Type | Description |
|-|-|
| tableau | Tableau JavaScript d'objets [ReportCiStatusOutputJS](https://servicenow-prod.fluidtopics.net/8wUTEuSrUYX1EDfF9YJmkw#c_ReportCiStatusOutputJSScopedAPI "L’API ReportCiStatusOutputJS fournit des méthodes qui renvoient des propriétés d’objet spécifiques pour la méthode DiscoveryAPI reportCiIpAddressStatus, puis convertissent les informations en une chaîne JSON.") immuables. |
[Tableau 4. Renvoie]

{#r_DiscoAPIreportCiIpAddressStatus__table_klm_mts_rcb}  

    var ipResultObj = sn_discovery.DiscoveryAPI.reportCiIpAddressStatus(ipAddress, discoveryStatus);

## DiscoveryAPI : reportCiStatus(Object discoveryStatusSysId) {#ariaid-title4}

Utilisé pour renvoyer un résumé de l'état Découverte d'un CI compte tenu d'une sys_id d'état Découverte spécifique.
Les exceptions suivantes peuvent être levées :

* DiscoveryStatusNotFoundException: le `statut de découverte avec l'ID système << < `valeur non valide`> >> n'existe pas. `
* DiscoveryDeviceHistoryNotFoundException: `l'historique des appareils avec l'ID système du statut de détection << < `valeur invalide` > >> et ipAddress << < `valeur invalide` > >> n'existe pas`
* IllegalArgumentException (arguments d'entrée non valides) : cette exception d'argument empêche les valeurs d'entrée d'être nulles.
  * `L'ID système du statut de découverte ne peut pas être nul`
  * `ipAddress ne peut pas être nul`
  {#r_DiscoAPIreportCiStatus__ul_ul2_c4t_rcb}
* IllegalArgumentException (valeurs stockées dans la base de données) : cette exception d'argument impose des conditions POST sur les valeurs d'accès à la base de données.
  * `Statut de découverte La propriété << state >> ne peut pas être nulle.`
  * `La propriété << source >> de l'historique de l'appareil ne peut pas être nulle`
  * `La propriété << problèmes >> de l'historique de l'appareil n'est pas un nombre entier : <`valeur non valide`>`
  * `La propriété << problèmes >> de l'historique des appareils ne peut pas être inférieure à 0 : <`valeur non valide`>`
  {#r_DiscoAPIreportCiStatus__ul_pjt_j4t_rcb}
{#r_DiscoAPIreportCiStatus__ul_ztk_gft_rcb}
{#r_DiscoAPIreportCiStatus__table_fzx_cwt_rcb__entry__3}

| Nom | Type | Description |
|-|-|-|
| sys_id | chaîne | La sys_id d'un enregistrement de l'état Discovery. |
[Tableau 5. Paramètres]

{#r_DiscoAPIreportCiStatus__table_fzx_cwt_rcb} {#r_DiscoAPIreportCiStatus__table_gzx_cwt_rcb__entry__2}

| Type | Description |
|-|-|
| tableau | Tableau JavaScript d'objets [ReportCiStatusOutputJS](https://servicenow-prod.fluidtopics.net/8wUTEuSrUYX1EDfF9YJmkw#c_ReportCiStatusOutputJSScopedAPI "L’API ReportCiStatusOutputJS fournit des méthodes qui renvoient des propriétés d’objet spécifiques pour la méthode DiscoveryAPI reportCiIpAddressStatus, puis convertissent les informations en une chaîne JSON.") immuables. |
[Tableau 6. Renvoie]

{#r_DiscoAPIreportCiStatus__table_gzx_cwt_rcb}  

    var ipResultObjArray = sn_discovery.DiscoveryAPI.reportCiStatus(discoveryStatus);
    for(var idx=0; idx < ipResultObjArray.length; idx++) {    
    var ipResultObj = ipResultObjArray[idx];