---
sourceDocument: Xanadu-API-Referenz
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/de-DE/xanadu/api-reference

 Release :

    - xanadu

ft:locale :

    - de-DE

ft:publication_title :

    - Xanadu-API-Referenz

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# DiscoveryAPI : Bereichsbezogen

# DiscoveryAPI : Bereichsbezogen {#ariaid-title1}

* Freigeben Version: Xanadu
* 
* Aktualisiert 1. August 2024
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 2 Minuten Lesedauer

Die DiscoveryAPI -Klasse bietet Methoden, die eine schnelle Discovery einer einzelnen IPv4-Adresse starten und Zusammenfassungen zuvor gestarteter Discovery-Status für ein einzelnes Configuration Item (CI) oder für alle gescannten CIs zurückgeben.

Diese Klasse wird im Namespace `sn_discovery ausgeführt`.

## DiscoveryAPI - discoveryIpAddress(String ipAddress, Zeichenfolgenanwendung, Zeichenfolgenquelle) {#ariaid-title2}

Erkennt eine angegebene IPv4-Adresse.
Ein MID Server wird basierend auf der angegebenen IP-Adresse oder der angegebenen Anwendung automatisch ausgewählt.
{#r_DiscoAPIdiscoverIpAddress__table_c4m_wcd_qcb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Anwendung | Zeichenfolge | Optional. Für den MID-Server konfigurierte Anwendung. Um einen source -Parameter, aber keinen application -Parameter zu definieren, verwenden Sie „NULL" als Platzhalter. Standard: Discovery |
| ipAddress | Zeichenfolge | Zu erkennende IP-Adresse. |
| Quelle | Zeichenfolge | Optional. Quelle der Discovery. Derselbe Wert wird im optionalen Feld Quelle im Datensatz Discovery-Status angezeigt, der angibt, wie die Discovery ausgelöst wurde. Standard: Discovery_API |
[Tabelle : 1. Parameter]

{#r_DiscoAPIdiscoverIpAddress__table_c4m_wcd_qcb} {#r_DiscoAPIdiscoverIpAddress__table_d4m_wcd_qcb__entry__2}

| Typ | Beschreibung |
|-|-|
| Zeichenfolge | sys_id des Discovery-Statusdatensatzes. Die folgenden Ausnahmen können während der MID-Server-Auswahl ausgelöst werden: * NoSuitableMidServerFoundException: `Für diese Discovery ist kein geeigneter MID-Server verfügbar` * BadArgumentException: `Ungültiges Argument bei der MID-Server-Auswahl erkannt` {#r_DiscoAPIdiscoverIpAddress__ul_ms4_lqj_qcb} |
[Tabelle : 2. Ergebnisse]

{#r_DiscoAPIdiscoverIpAddress__table_d4m_wcd_qcb}  

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

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

Wird verwendet, um eine Zusammenfassung des Discovery-Status eines Konfigurationselements anhand der spezifischen Status-sys_id und IPv4-Adresse zurückzugeben.
Die folgenden Ausnahmen können ausgelöst werden:

* DiscoveryStatusNotFoundException: `Zeigt diese Nachricht an: Discovery-Status mit Sys-ID „<`ungültiger Wert`>" ist nicht vorhanden`
* DiscoveryDeviceHistoryNotFoundException: `Geräteverlauf mit Discovery-Status-Sys-ID „<`ungültiger Wert`>" und ipAddress „<`ungültiger Wert`>" ist nicht vorhanden`
* IllegalArgumentException (ungültige Eingabeargumente): Diese Argumentausnahme verhindert, dass Eingabewerte NULL sind.
  * `Sys-ID des Discovery-Status darf nicht NULL sein `
  * `ipAddress darf nicht NULL sein`
  {#r_DiscoAPIreportCiIpAddressStatus__ul_ul2_c4t_rcb}
* IllegalArgumentException (Werte in Datenbank gespeichert): Diese Argumentausnahme verhindert, dass fehlerhafte Daten an den Aufrufer zurückgegeben werden, wenn die Attributwerte ungültig sind.
  * `Die Eigenschaft „state" für den Discovery-Status darf nicht NULL sein`
  * `Die Eigenschaft „Quelle" des Geräteverlaufs darf nicht NULL sein `
  * `Die Eigenschaft „Probleme" des Geräteverlaufs ist keine Ganzzahl: <`ungültiger Wert`>`
  * `Die Eigenschaft „Probleme" im Geräteverlauf darf nicht kleiner als 0 sein: <`ungültiger Wert`>`
  {#r_DiscoAPIreportCiIpAddressStatus__ul_pjt_j4t_rcb}
{#r_DiscoAPIreportCiIpAddressStatus__ul_ztk_gft_rcb}
{#r_DiscoAPIreportCiIpAddressStatus__table_jlm_mts_rcb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| ipAddress | Zeichenfolge | Die gescannte IPv4-Adresse. |
| SysId des Discovery-Status | Zeichenfolge | Die sys_id des Discovery-Statusdatensatzes für die gescannte IP-Adresse. |
[Tabelle : 3. Parameter]

{#r_DiscoAPIreportCiIpAddressStatus__table_jlm_mts_rcb} {#r_DiscoAPIreportCiIpAddressStatus__table_klm_mts_rcb__entry__2}

| Typ | Beschreibung |
|-|-|
| array | JavaScript-Array unveränderlicher [ReportCiStatusOutputJS](https://servicenow-prod.fluidtopics.net/mDtURunpbSh6pWydBMSu3w#c_ReportCiStatusOutputJSScopedAPI "Die ReportCiStatusOutputJS -API stellt Methoden bereit, die bestimmte Objekteigenschaften für die DiscoveryAPI-Methode reportCiIpAddressStatus zurückgeben und konvertiert die Informationen dann in eine JSON-Zeichenfolge.") -Objekte. |
[Tabelle : 4. Ergebnisse]

{#r_DiscoAPIreportCiIpAddressStatus__table_klm_mts_rcb}  

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

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

Wird verwendet, um eine Zusammenfassung des CI-Discovery-Status anhand einer bestimmten sys_id für den Discovery-Status zurückzugeben.
Die folgenden Ausnahmen können ausgelöst werden:

* DiscoveryStatusNotFoundException: `Discovery-Status mit Sys-ID „<`ungültiger Wert`>" ist nicht vorhanden `
* DiscoveryDeviceHistoryNotFoundException: `Geräteverlauf mit Discovery-Status-Sys-ID „<`ungültiger Wert`>" und ipAddress „<`ungültiger Wert`>" ist nicht vorhanden`
* IllegalArgumentException (ungültige Eingabeargumente): Diese Argumentausnahme verhindert, dass Eingabewerte NULL sind.
  * `Sys-ID des Discovery-Status darf nicht NULL sein`
  * `ipAddress darf nicht NULL sein`
  {#r_DiscoAPIreportCiStatus__ul_ul2_c4t_rcb}
* IllegalArgumentException (Werte in Datenbank gespeichert): Diese Argumentausnahme erzwingt Nachbedingungen für Datenbankzugriffswerte.
  * `Die Eigenschaft „state" für den Discovery-Status darf nicht NULL sein`
  * `Die Eigenschaft „Quelle" des Geräteverlaufs darf nicht NULL sein`
  * `Die Eigenschaft „Probleme" des Geräteverlaufs ist keine Ganzzahl: <`ungültiger Wert`>`
  * `Die Eigenschaft „Probleme" im Geräteverlauf darf nicht kleiner als 0 sein: <`ungültiger Wert`>`
  {#r_DiscoAPIreportCiStatus__ul_pjt_j4t_rcb}
{#r_DiscoAPIreportCiStatus__ul_ztk_gft_rcb}
{#r_DiscoAPIreportCiStatus__table_fzx_cwt_rcb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| sys_id | Zeichenfolge | Die sys_id eines Discovery-Statusdatensatzes. |
[Tabelle : 5. Parameter]

{#r_DiscoAPIreportCiStatus__table_fzx_cwt_rcb} {#r_DiscoAPIreportCiStatus__table_gzx_cwt_rcb__entry__2}

| Typ | Beschreibung |
|-|-|
| array | JavaScript-Array unveränderlicher [ReportCiStatusOutputJS](https://servicenow-prod.fluidtopics.net/mDtURunpbSh6pWydBMSu3w#c_ReportCiStatusOutputJSScopedAPI "Die ReportCiStatusOutputJS -API stellt Methoden bereit, die bestimmte Objekteigenschaften für die DiscoveryAPI-Methode reportCiIpAddressStatus zurückgeben und konvertiert die Informationen dann in eine JSON-Zeichenfolge.") -Objekte. |
[Tabelle : 6. Ergebnisse]

{#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];