NVIDIA UFM Cyber-AI Documentation v2.8.0

Pagination

The Pagination REST API is used for retrieving large datasets in manageable pages. Pagination works by restricting the quantity of items returned in each response, thus reducing server load and minimizing content download time.

  • Supported URLs:

    Copy
    Copied!
                

    GET /cyber-ai/anomalies/network GET /cyber-ai/alerts/filter GET /cyber-ai/anomalies/tenant GET /cyber-ai/anomalies/logical-server GET /cyber-ai/telemetry/link-status GET /cyber-ai/prediction/link-anomaly GET /cyber-ai/prediction/link-failure GET /cyber-ai/anomalies/cable/threshold GET /cyber-ai/anomalies/cable/deviation

  • URL Filters:

    • Page Number – the requested page number:

      Copy
      Copied!
                  

      ?page_number=<number>

      Example: ?page_number=1.

    • Page Size - the requested page size:

      Copy
      Copied!
                  

      ?rpp=<size>

      Example: ?rpp=10.

    • Filter - column filter:

      Copy
      Copied!
                  

      ?filter=<column name>[<filter type>]<value>

      Example: ?filter=timestamp[eq]2024.

      The filter supports the following types:

      • Equals: eq

      • Not equal: neq

      • Contains: con

      • Not contains: ncon

      • Starts with: sw

      • Ends with: ew

      • Multi equals: eqm

To filter multiple columns, send each column in a separate filter. F or example: ?filter=timestamp[eq]2024&filter=node_guid[con]n.

    • Sorting - column sorting:

      Copy
      Copied!
                  

      ?sorting=<column name>[<asc|desc>]

      Example: ?sorting=timestamp[desc].

To sort multiple columns, send all columns in the same filter separated by commas. F or example: ?sorting=timestamp[asc],node_guid[asc].

  • Request Data

    Copy
    Copied!
                

    none

  • Response

    Copy
    Copied!
                

    { "data”: [ { "alert_id":106782, "occurrence":2, "severity":"Warning", "description":"PortXmitWaitExtended is 130.05% above the average", "influencers”: [ "PortXmitWaitExtended" ], "percentage":130.05, "influencers_display_names”: [ "Port Xmit Wait Extended" ], "timestamp":1709773200 } ], "filtered_resources":1, "first_index":1, "last_index":1, "num_of_pages":1 }

    Note

    If successful, the page is returned in JSON format.

  • Response codes

    Status

    Description

    200

    Success

    400

    Bad Request (invalid argument)

© Copyright 2024, NVIDIA. Last updated on May 6, 2024.