---
sourceDocument: オーストラリア API リファレンス
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/ja-JP/api-reference

 Release :

    - australia

ft:locale :

    - ja-JP

ft:publication_title :

    - オーストラリア API リファレンス

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# ディスカバリーAPI :スコープ対象

# ディスカバリーAPI :スコープ対象 {#ariaid-title1}

* リリースバージョン: Australia
* 
* 更新日 2026年03月12日
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 所要時間：5分

DiscoveryAPI クラスは、単一の IPv4 アドレスのクイックディスカバリーを開始し、単一の構成アイテム (CI) またはスキャンされたすべての CI について、以前に起動されたディスカバリーステータスのサマリーを返すメソッドを提供します。

このクラスの実行は、 `sn_discovery` 名前空間にあります。

## ディスカバリーAPI - discoverIpAddress(String ipAddress, String application, String source) {#ariaid-title2}

指定された IPv4 アドレスを検出します。
指定された IP アドレスまたは指定されたアプリケーションに基づいて、MID サーバーが自動的に選択されます。
{#r_DiscoAPIdiscoverIpAddress__table_c4m_wcd_qcb__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| application | 文字列 | オプション。MID サーバー用に構成されたアプリケーション。 applicationパラメーターではなくsourceパラメーターを定義するには、プレースホルダーとして「NULL」を使用します。 デフォルト:ディスカバリー |
| ipAddress | 文字列 | 検出する IP アドレス。 |
| ソース | 文字列 | オプション。ディスカバリーのソース。これと同じ値がディスカバリーステータスレコードのオプションの \[ ソース \] フィールドに表示され、ディスカバリーがどのようにトリガーされたかが示されます。 デフォルト値:Discovery_API |
[表 : 1. パラメーター]

{#r_DiscoAPIdiscoverIpAddress__table_c4m_wcd_qcb} {#r_DiscoAPIdiscoverIpAddress__table_d4m_wcd_qcb__entry__2}

| タイプ | 説明 |
|-|-|
| 文字列 | ディスカバリーステータスレコードsys_id。 MID サーバーの選択中に次の例外がスローされる可能性があります。 * NoSuitableMidServerFoundException: `このディスカバリーに利用可能な適切な MID サーバーがありません` * BadArgumentException: `MID サーバーの選択中に無効な引数が検出されました` {#r_DiscoAPIdiscoverIpAddress__ul_ms4_lqj_qcb} |
[表 : 2. 返される内容]

{#r_DiscoAPIdiscoverIpAddress__table_d4m_wcd_qcb}  

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

## ディスカバリーAPI:reportCiIpAddressStatus(オブジェクト ipAddress, オブジェクト discoveryStatusSysId) {#ariaid-title3}

特定のステータスsys_idと IPv4 アドレスを指定して、構成アイテムのディスカバリーステータスのサマリーを返すために使用されます。
次の例外がスローされる可能性があります。

* DiscoveryStatusNotFoundException: `次のメッセージを表示します:Sys ID が「<`無効な値`>」のディスカバリーステータスは存在しません`
* DiscoveryDeviceHistoryNotFoundException: `ディスカバリーステータスの Sys ID が「<`無効な値`>」で ipAddress<無効な`値`>」のデバイス履歴は存在しません`
* IllegalArgumentException (無効な入力引数):この引数の例外により、入力値が null になることはありません。
  * `ディスカバリーステータス Sys ID を null にすることはできません `
  * `ipAddress を null にすることはできません`
  {#r_DiscoAPIreportCiIpAddressStatus__ul_ul2_c4t_rcb}
* IllegalArgumentException (データベースに格納されている値):この引数の例外は、属性値が正しくない場合に、誤ったデータが呼び出し元に返されるのを防ぎます。
  * `ディスカバリーステータスの「ステータス」プロパティを null にすることはできません`
  * `デバイス履歴の「ソース」プロパティを null にすることはできません `
  * `デバイス履歴の「issues」プロパティが整数ではありません:<`無効な値`です>`
  * `デバイス履歴の「問題」プロパティを 0 未満にすることはできません:<`無効な値`です>`
  {#r_DiscoAPIreportCiIpAddressStatus__ul_pjt_j4t_rcb}
{#r_DiscoAPIreportCiIpAddressStatus__ul_ztk_gft_rcb}
{#r_DiscoAPIreportCiIpAddressStatus__table_jlm_mts_rcb__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| ipAddress | string | スキャンされた IPv4 アドレス。 |
| discoveryStatusSysId | string | スキャンされた IP アドレスのディスカバリーステータスレコードのsys_id。 |
[表 : 3. パラメーター]

{#r_DiscoAPIreportCiIpAddressStatus__table_jlm_mts_rcb} {#r_DiscoAPIreportCiIpAddressStatus__table_klm_mts_rcb__entry__2}

| タイプ | 説明 |
|-|-|
| アレイ | 不変の [ReportCiStatusOutputJS](https://servicenow-prod.fluidtopics.net/uQFo2mRNixctKlzmJNFI~w#c_ReportCiStatusOutputJSScopedAPI "ReportCiStatusOutputJS API には、DiscoveryAPI の reportCiIpAddressStatus メソッドの特定のオブジェクトプロパティを返し、その情報を JSON 文字列に変換するメソッドが用意されています。") オブジェクトの JavaScript 配列。 |
[表 : 4. 返される内容]

{#r_DiscoAPIreportCiIpAddressStatus__table_klm_mts_rcb}  

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

## ディスカバリーAPI:reportCiStatus(オブジェクト discoveryStatusSysId) {#ariaid-title4}

特定のディスカバリーステータスsys_id指定された CI ディスカバリーステータスのサマリーを返すために使用されます。
次の例外がスローされる可能性があります。

* DiscoveryStatusNotFoundException: `Sys ID が「<`無効な値`>」のディスカバリーステータスは存在しません `
* DiscoveryDeviceHistoryNotFoundException: `ディスカバリーステータスの Sys ID が「<`無効な値`>」で ipAddress<無効な`値`>」のデバイス履歴は存在しません`
* IllegalArgumentException (無効な入力引数):この引数の例外により、入力値が null になることはありません。
  * `ディスカバリーステータス Sys ID を null にすることはできません`
  * `ipAddress を null にすることはできません`
  {#r_DiscoAPIreportCiStatus__ul_ul2_c4t_rcb}
* IllegalArgumentException (データベースに格納されている値): この引数の例外は、データベースアクセス値に事後条件を課します。
  * `ディスカバリーステータスの「ステータス」プロパティを null にすることはできません`
  * `デバイス履歴の「ソース」プロパティを null にすることはできません`
  * `デバイス履歴の「issues」プロパティが整数ではありません:<`無効な値`です>`
  * `デバイス履歴の「問題」プロパティを 0 未満にすることはできません:<`無効な値`です>`
  {#r_DiscoAPIreportCiStatus__ul_pjt_j4t_rcb}
{#r_DiscoAPIreportCiStatus__ul_ztk_gft_rcb}
{#r_DiscoAPIreportCiStatus__table_fzx_cwt_rcb__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| sys_id | string | ディスカバリーステータスレコードのsys_id。 |
[表 : 5. パラメーター]

{#r_DiscoAPIreportCiStatus__table_fzx_cwt_rcb} {#r_DiscoAPIreportCiStatus__table_gzx_cwt_rcb__entry__2}

| タイプ | 説明 |
|-|-|
| アレイ | 不変の [ReportCiStatusOutputJS](https://servicenow-prod.fluidtopics.net/uQFo2mRNixctKlzmJNFI~w#c_ReportCiStatusOutputJSScopedAPI "ReportCiStatusOutputJS API には、DiscoveryAPI の reportCiIpAddressStatus メソッドの特定のオブジェクトプロパティを返し、その情報を JSON 文字列に変換するメソッドが用意されています。") オブジェクトの JavaScript 配列。 |
[表 : 6. 返される内容]

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