1. REST API for Unified Assurance Microservices
  2. Tasks
  3. Version 1
  4. Discovery (V1)

Get Discovery Status

get

/discovery-service/discovery/request/status/

Gets the status of a discovery request. This is a legacy API. It is only available when the ENABLE_LEGACY_API_ENDPOINTS configuration parameter is set to true on the Discovery Service microservice.

Request

There are no request parameters for this operation.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

Successful operation
Body ()
Root Schema : DiscoveryStatusResponse
Type: object
Additional Properties Allowed
Show Source
The status of all discovery requests.
Example:
{
    "disco-01f107bd-655f-42e0-ae1c-ac4740e734e7":{
        "DiscoveryContextID":"disco-01f107bd-655f-42e0-ae1c-ac4740e734e7",
        "RequestedLevel":[
            1,
            2,
            3
        ],
        "TimestampInitiated":1702215346,
        "ICMPStatus":"Completed",
        "ICMPProgress":6,
        "ICMPTotal":6,
        "SNMPStatus":"Completed",
        "SNMPProgress":6,
        "SNMPTotal":6,
        "APIStatus":"Completed",
        "APIProgress":6,
        "APITotal":6
    },
    "disco-490fda03-dea8-43bd-89f1-9117fb962442":{
        "DiscoveryContextID":"disco-490fda03-dea8-43bd-89f1-9117fb962442",
        "RequestedLevel":[
            1,
            2,
            3
        ],
        "TimestampInitiated":1702216489,
        "ICMPStatus":"Completed",
        "ICMPProgress":2,
        "ICMPTotal":2,
        "SNMPStatus":"Completed",
        "SNMPProgress":2,
        "SNMPTotal":2,
        "APIStatus":"Completed",
        "APIProgress":2,
        "APITotal":2
    }
}
Nested Schema : DiscoveryContextIDStatusResponse
Type: object
The status of a discovery request.
Show Source
  • Minimum Value: 0
    Maximum Value: 2147483647
    The number of REST API jobs completed for the discovery.
    Example: 6
  • Allowed Values: [ "In Progress", "Completed", "NA" ]
    The REST API discovery status.
    Example: Completed
  • Minimum Value: 0
    Maximum Value: 2147483647
    The number of REST API jobs requested for the discovery.
    Example: 6
  • The discovery request ID.
    Example: disco-01f107bd-655f-42e0-ae1c-ac4740e734e7
  • Minimum Value: 0
    Maximum Value: 2147483647
    The number of gNMI jobs completed for the discovery.
    Example: 6
  • Allowed Values: [ "In Progress", "Completed", "NA" ]
    The gNMI discovery status.
    Example: Completed
  • Minimum Value: 0
    Maximum Value: 2147483647
    The number of gNMI jobs requested for the discovery.
    Example: 6
  • Minimum Value: 0
    Maximum Value: 2147483647
    The number of ICMP jobs completed for the discovery.
    Example: 6
  • Allowed Values: [ "In Progress", "Completed", "NA" ]
    The ICMP discovery status.
    Example: Completed
  • Minimum Value: 0
    Maximum Value: 2147483647
    The number of ICMP jobs requested for the discovery.
    Example: 6
  • RequestedLevel
    The types of polling enabled for discovery. Possible values are 1 for ping, 2 for SNMP, and 3 for REST.
  • Minimum Value: 0
    Maximum Value: 2147483647
    The number of SNMP jobs completed for the discovery.
    Example: 6
  • Allowed Values: [ "In Progress", "Completed", "NA" ]
    The SNMP discovery status.
    Example: Completed
  • Minimum Value: 0
    Maximum Value: 2147483647
    The number of SNMP jobs requested for the discovery.
    Example: 6
  • Minimum Value: 0
    Maximum Value: 9223372036854776000
    The Unix time in seconds when discovery was initiated.
    Example: 1702215346
Nested Schema : RequestedLevel
Type: array
The types of polling enabled for discovery. Possible values are 1 for ping, 2 for SNMP, and 3 for REST.
Allowed Values: [ 1, 2, 3 ]
Show Source
Example:
[
    1,
    2,
    3
]

204 Response

No content

401 Response

Unauthorized operation

500 Response

Internal server error
Back to Top