---
sourceDocument: Xanadu API リファレンス
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/ja-JP/xanadu/api-reference

 Release :

    - xanadu

ft:locale :

    - ja-JP

ft:publication_title :

    - Xanadu API リファレンス

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# DiscoveryAPI - スコープ指定

# DiscoveryAPI - スコープ指定 {#ariaid-title1}

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

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

このクラスは `sn_discovery` 名前空間で実行されます。

## DiscoveryAPI - discoverIpAddress(文字列 ipAddress, 文字列 application, 文字列 source) {#ariaid-title2}

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

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

## DiscoveryAPI:reportCiIpAddressStatus(オブジェクト ipAddress, オブジェクト discoveryStatusSysId) {#ariaid-title3}

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

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

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

{#r_DiscoAPIreportCiIpAddressStatus__table_jlm_mts_rcb} {#r_DiscoAPIreportCiIpAddressStatus__table_klm_mts_rcb__entry__2}

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

{#r_DiscoAPIreportCiIpAddressStatus__table_klm_mts_rcb}  

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

## DiscoveryAPI - 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 (データベースに格納されている値): この引数例外は、データベースアクセス値に事後条件を課します。
  * `ディスカバリーステータスの「state」プロパティを null にすることはできません`
  * `デバイス履歴の「source」プロパティを null にすることはできません`
  * `デバイス履歴の「問題」プロパティが整数ではありません:<`無効な値`>`
  * `デバイス履歴の「問題」プロパティを 0 未満にすることはできません:<`無効な値`>`
  {#r_DiscoAPIreportCiStatus__ul_pjt_j4t_rcb}
{#r_DiscoAPIreportCiStatus__ul_ztk_gft_rcb}
{#r_DiscoAPIreportCiStatus__table_fzx_cwt_rcb__entry__3}

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

{#r_DiscoAPIreportCiStatus__table_fzx_cwt_rcb} {#r_DiscoAPIreportCiStatus__table_gzx_cwt_rcb__entry__2}

| タイプ | 説明 |
|-|-|
| アレイ | 不変の [ReportCiStatusOutputJS](https://servicenow-prod.fluidtopics.net/ggWN0gTHGO8Hsgu8Qhb~sQ#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];