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

 Release :

    - yokohama

ft:locale :

    - de-DE

ft:publication_title :

    - Yokohama-API-Referenz

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# DiscoveryAPI -- Umfang

# DiscoveryAPI -- Umfang {#ariaid-title1}

* Freigeben Version: Yokohama
* 
* Aktualisiert 30. Januar 2025
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 2 Minuten Lesedauer

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

Diese Klasse wird ausgeführt in `sn_Discovery `Namespace.

## DiscoveryAPI -- discoverIpAddress(Zeichenfolge ipAddress, Zeichenfolgenanwendung, Zeichenfolgenquelle) {#ariaid-title2}

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

| Name | Typ | Beschreibung |
|-|-|-|
| Anwendung | Zeichenfolge | Optional. Anwendung, die für den MID-Server konfiguriert ist. Zum Definieren von sourceParameter, aber nicht applicationParameter, verwenden Sie „Null" als Platzhalter. Standard: Discovery |
| ipAddress | Zeichenfolge | Zu erkennende IP-Adresse. |
| Quelle | Zeichenfolge | Optional. Quelle der Discovery. Derselbe Wert wird optional in angezeigt Quelle Feld im Discovery-Statusdatensatz, das 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-Serverauswahl ausgelöst werden: * NoSuitableMidServerFoundException: `Für diese Discovery ist kein geeigneter MID-Server verfügbar ` * BadArgumentException: `Ungültiges Argument während der MID-Serverauswahl erkannt ` {#r_DiscoAPIdiscoverIpAddress__ul_ms4_lqj_qcb} |
[Tabelle : 2. Rückgaben]

{#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.
  * `Discovery-Status-SYS-ID 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 im Falle von ungültigen Attributwerten an den Anrufer zurückgegeben werden.
  * `Die Eigenschaft „Status" des 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" des Geräteverlaufs 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 IPv4-Adresse, die gescannt wurde. |
| DiscoveryStatusSysId | 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 von unveränderlichen Elementen [BerichtCiStatusOutputJS](https://servicenow-prod.fluidtopics.net/CPlHgktwBYFBy9yXmF8EVQ#c_ReportCiStatusOutputJSScopedAPI "Die BerichtCiStatusOutputJS Die API stellt Methoden bereit, die bestimmte Objekteigenschaften für zurückgeben DiscoveryAPI-BerichtCiIpAddressStatus Methode und konvertiert die Informationen dann in eine JSON-Zeichenfolge.")Objekte. |
[Tabelle : 4. Rückgaben]

{#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 eines CI-Discovery-Status anhand einer bestimmten Discovery-Status-sys_ID 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.
  * `Discovery-Status-SYS-ID darf nicht null sein`
  * `Ipaddress darf nicht null sein`
  {#r_DiscoAPIreportCiStatus__ul_ul2_c4t_rcb}
* IllegalArgumentException (Werte in Datenbank gespeichert): Diese Argumentausnahme erzwingt Post-Bedingungen für Datenbankzugriffswerte.
  * `Die Eigenschaft „Status" des 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" des Geräteverlaufs 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 von unveränderlichen Elementen [BerichtCiStatusOutputJS](https://servicenow-prod.fluidtopics.net/CPlHgktwBYFBy9yXmF8EVQ#c_ReportCiStatusOutputJSScopedAPI "Die BerichtCiStatusOutputJS Die API stellt Methoden bereit, die bestimmte Objekteigenschaften für zurückgeben DiscoveryAPI-BerichtCiIpAddressStatus Methode und konvertiert die Informationen dann in eine JSON-Zeichenfolge.")Objekte. |
[Tabelle : 6. Rückgaben]

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


