---
sourceDocument: Referência de API do Xanadu
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/pt-BR/xanadu/api-reference

 Release :

    - xanadu

ft:locale :

    - pt-BR

ft:publication_title :

    - Referência de API do Xanadu

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# DiscoveryAPI - com escopo

# DiscoveryAPI - com escopo {#ariaid-title1}

* Versão de lançamento: Xanadu
* 
* Atualizado 1 de ago. de 2024
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 3 min. de leitura

A classe DiscoveryAPI fornece métodos que iniciam uma descoberta rápida de um único endereço IPv4 e retornam resumos de status de descoberta iniciados anteriormente para um único item de configuração (IC) ou para todos os ICs verificados.

Esta classe é executada no namespace `sn_discovery`.

## DiscoveryAPI - discoveryIpAddress (cadeia de caracteres ipAddress, aplicação de cadeia de caracteres, origem de cadeia de caracteres) {#ariaid-title2}

Descobre um endereço IPv4 especificado.
Um MID Server é selecionado automaticamente, com base no endereço IP fornecido ou na aplicação especificada.
{#r_DiscoAPIdiscoverIpAddress__table_c4m_wcd_qcb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| aplicação | Cadeia de caracteres | Opcional. Aplicação configurada para o MID Server. Para definir um parâmetro source, mas não um parâmetro application, use "NULL" como o espaço reservado. Padrão: Descoberta |
| ipAddress | Cadeia de caracteres | Endereço IP a ser descoberto. |
| origem | Cadeia de caracteres | Opcional. Origem da Descoberta. Esse mesmo valor aparece no campo opcional Origem no registro de Status da descoberta, que indica como a Descoberta foi acionada. Padrão: Discovery_API |
[Tabela 1. Parâmetros]

{#r_DiscoAPIdiscoverIpAddress__table_c4m_wcd_qcb} {#r_DiscoAPIdiscoverIpAddress__table_d4m_wcd_qcb__entry__2}

| Tipo | Descrição |
|-|-|
| Cadeia de caracteres | sys_id do registro de status da descoberta. As seguintes exceções podem ser lançadas durante a seleção do MID Server: * NoSuitableMidServerFoundException: `nenhum MID Server apropriado disponível para esta Descoberta` * BadArgumentException: `argumento inválido detectado durante a seleção do MID Server` {#r_DiscoAPIdiscoverIpAddress__ul_ms4_lqj_qcb} |
[Tabela 2. Retorna]

{#r_DiscoAPIdiscoverIpAddress__table_d4m_wcd_qcb}  

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

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

Usado para retornar um resumo do status de descoberta de um item de configuração de acordo com o status específico sys_id e o endereço IPv4.
As seguintes exceções podem ser lançadas:

* DiscoveryStatusNotFoundException: `Exibe esta mensagem: O status da descoberta com o SYS ID '<`valor inválido`>' não existe`
* DiscoveryDeviceHistoryNotFoundException: `o histórico de dispositivos com o SYS ID do status da descoberta '<`valor inválido`>' e o endereço IP '<`valor inválido`>' não existe`
* IllegalArgumentException (argumentos de entrada inválidos): esta exceção de argumento evita que os valores de entrada sejam nulos.
  * `O SYS ID do status da descoberta não pode ser nulo `
  * `ipAddress não pode ser nulo`
  {#r_DiscoAPIreportCiIpAddressStatus__ul_ul2_c4t_rcb}
* IllegalArgumentException (valores armazenados no banco de dados): esta exceção de argumento evita que dados incorretos sejam retornados ao solicitante no caso de valores de atributo incorretos.
  * `A propriedade "estado" do status da descoberta não pode ser nula`
  * `A propriedade de "origem" do histórico do dispositivo não pode ser nula `
  * `A propriedade "problemas" do histórico do dispositivo não é um número inteiro: <`valor inválido`>`
  * `A propriedade "problemas" do histórico do dispositivo não pode ser inferior a 0: <`valor inválido`>`
  {#r_DiscoAPIreportCiIpAddressStatus__ul_pjt_j4t_rcb}
{#r_DiscoAPIreportCiIpAddressStatus__ul_ztk_gft_rcb}
{#r_DiscoAPIreportCiIpAddressStatus__table_jlm_mts_rcb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| ipAddress | Cadeia de caracteres | O endereço IPv4 que foi verificado. |
| discoveryStatusSysId | Cadeia de caracteres | O sys_id do registro de status da Descoberta para o endereço IP que foi verificado. |
[Tabela 3. Parâmetros]

{#r_DiscoAPIreportCiIpAddressStatus__table_jlm_mts_rcb} {#r_DiscoAPIreportCiIpAddressStatus__table_klm_mts_rcb__entry__2}

| Tipo | Descrição |
|-|-|
| matriz | Matriz JavaScript de objetos [ReportCiStatusOutputJS](https://servicenow-prod.fluidtopics.net/cB5IrUZ9fRhvChj6INU~Lw#c_ReportCiStatusOutputJSScopedAPI "A API ReportCiStatusOutputJS fornece métodos que retornam propriedades de objeto específicas para o método reportCiIpAddressStatus da DiscoveryAPI e convertem as informações em uma cadeia de caracteres JSON.") imutáveis. |
[Tabela 4. Retorna]

{#r_DiscoAPIreportCiIpAddressStatus__table_klm_mts_rcb}  

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

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

Usado para retornar um resumo de um status de descoberta de IC de acordo com um sys_id de status de descoberta específico.
As seguintes exceções podem ser lançadas:

* DiscoveryStatusNotFoundException: `o status da descoberta com o SYS ID '<`valor inválido`>' não existe `
* DiscoveryDeviceHistoryNotFoundException: `o histórico de dispositivos com o SYS ID do status da descoberta '<`valor inválido`>' e o endereço IP '<`valor inválido`>' não existe`
* IllegalArgumentException (argumentos de entrada inválidos): esta exceção de argumento evita que os valores de entrada sejam nulos.
  * `O SYS ID do status da descoberta não pode ser nulo`
  * `ipAddress não pode ser nulo`
  {#r_DiscoAPIreportCiStatus__ul_ul2_c4t_rcb}
* IllegalArgumentException (valores armazenados no banco de dados): esta exceção de argumento impõe pós-condições nos valores de acesso ao banco de dados.
  * `A propriedade "estado" do status da descoberta não pode ser nula`
  * `A propriedade de "origem" do histórico do dispositivo não pode ser nula`
  * `A propriedade "problemas" do histórico do dispositivo não é um número inteiro: <`valor inválido`>`
  * `A propriedade "problemas" do histórico do dispositivo não pode ser inferior a 0: <`valor inválido`>`
  {#r_DiscoAPIreportCiStatus__ul_pjt_j4t_rcb}
{#r_DiscoAPIreportCiStatus__ul_ztk_gft_rcb}
{#r_DiscoAPIreportCiStatus__table_fzx_cwt_rcb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| sys_id | Cadeia de caracteres | O sys_id de um registro de status da Descoberta. |
[Tabela 5. Parâmetros]

{#r_DiscoAPIreportCiStatus__table_fzx_cwt_rcb} {#r_DiscoAPIreportCiStatus__table_gzx_cwt_rcb__entry__2}

| Tipo | Descrição |
|-|-|
| matriz | Matriz JavaScript de objetos [ReportCiStatusOutputJS](https://servicenow-prod.fluidtopics.net/cB5IrUZ9fRhvChj6INU~Lw#c_ReportCiStatusOutputJSScopedAPI "A API ReportCiStatusOutputJS fornece métodos que retornam propriedades de objeto específicas para o método reportCiIpAddressStatus da DiscoveryAPI e convertem as informações em uma cadeia de caracteres JSON.") imutáveis. |
[Tabela 6. Retorna]

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