List of APIs - Get Network Test results for node

Get Network Test results for node

Returns the test results of the Network tests triggered for a single Video Mesh node. The tests listed below are run as a part of the Network Test execution on the node.

Bandwidth Test - Tests the bandwidth parameters of the Video Mesh node's network. The test is run between the Video Mesh node and cloud services.
DNS Resolution Test - Tests the resolution of IP addresses related to cloud services, against the DNS servers configured on the Video Mesh node's network.
HTTPS Connectivity Test - Tests whether the Video Mesh node is able to connect to cloud services via HTTPS protocol.
Websocket Connectivity Test - Tests whether the Video Mesh node is able to connect to Webex cloud services via Websocket.

GET/v1/videoMesh/testResults/networkTest/nodes

Query Parameters

nodeId

stringrequired

Unique ID of the Video Mesh node.

triggerType

stringrequired

Trigger type.

Possible values: OnDemand, Periodic, All

from

stringrequired

The start date and time of the requested data in any ISO 8601 compliant format. The from parameter cannot have date and time values that exceed to.

stringrequired

The end date and time of the requested data in any ISO 8601 compliant format.

Response Properties

orgId

string

Unique ID of the organization.

from

string

Start date and time (inclusive) of the Network Test data.

string

End date and time (inclusive) of the Network Test data.

items

array[Connectivity Test Results Clusters Object 3]

Network test results.

clusters

array[Per Cluster Connectivity Result3]

List of Video Mesh clusters.

clusterId

string

Unique ID of the Video Mesh cluster.

clusterName

string

Name of the Video Mesh cluster.

nodes

array[Per Node Connectivity Result1]

nodeId

string

Unique ID of the Video Mesh node.

hostNameOrIP

string

Host name or IP Address of the Video Mesh node.

testResults

array[Connectivity Test Results For Node]

timestamp

string

The timestamp of the test run.

triggerType

string

The type of the test being executed. Can be either OnDemand or Periodic.

string

Unique ID of the test.

result

array[DNS Resolution Test]

type

string

The type of test result.

results

array[Service Type Result1]

Test Results from different services.

serviceType

string

Service for which the test was executed.

testResult

string

Result of the test executed.

failureDetails

FailureDetails1

possibleFailureReason

array[string]

Possible reasons for failure for the test.

possibleRemediation

array[string]

Possible fixes for the failures mentioned above.

Response Codes

The list below describes the common success and error responses you should expect from the API:

Code	Status	Description
200	OK	Successful request with body content.
201	Created	The request has succeeded and has led to the creation of a resource.
202	Accepted	The request has been accepted for processing.
204	No Content	Successful request without body content.
400	Bad Request	The request was invalid or cannot be otherwise served. An accompanying error message will explain further.
401	Unauthorized	Authentication credentials were missing or incorrect.
403	Forbidden	The request is understood, but it has been refused or access is not allowed.
404	Not Found	The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.
405	Method Not Allowed	The request was made to a resource using an HTTP request method that is not supported.
409	Conflict	The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.
410	Gone	The requested resource is no longer available.
415	Unsupported Media Type	The request was made to a resource without specifying a media type or used a media type that is not supported.
423	Locked	The requested resource is temporarily unavailable. A `Retry-After` header may be present that specifies how many seconds you need to wait before attempting the request again.
428	Precondition Required	File(s) cannot be scanned for malware and need to be force downloaded.
429	Too Many Requests	Too many requests have been sent in a given amount of time and the request has been rate limited. A `Retry-After` header should be present that specifies how many seconds you need to wait before a successful request can be made.
500	Internal Server Error	Something went wrong on the server. If the issue persists, feel free to contact the Webex Developer Support team.
502	Bad Gateway	The server received an invalid response from an upstream server while processing the request. Try again later.
503	Service Unavailable	Server is overloaded with requests. Try again later.
504	Gateway Timeout	An upstream server failed to respond on time. If your query uses `max` parameter, please try to reduce it.

GET

/v1/videoMesh/testResults/networkTest/nodes{?nodeId,triggerType,from,to}

Header

Content-Type
Authorization
Use personal access token
Bearer
This limited-duration personal access token is hidden for your security.

Query Parameters

nodeId
stringRequired
Unique ID of the Video Mesh node.
triggerType
stringRequired
Trigger type.
from
stringRequired
The start date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. The `from` parameter cannot have date and time values that exceed `to`.
to
stringRequired
The end date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.

https://webexapis.com/v1/videoMesh/testResults/networkTest/nodes?nodeId=Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT05ORUNUT1IvMmMzYzlmOTUtNzNkOS00NDYwLWE2NjgtMDQ3MTYyZmYxYmFkOjE1NmRmNzg5Yzg1NTRkNTVhMjc1ZGY5OTc4Zjk5MDJk&triggerType=%5Bobject%20Object%5D,%5Bobject%20Object%5D,%5Bobject%20Object%5D&from=2023-01-15T15:53:00Z&to=2023-01-20T15:53:00Z

200 / OK

{
  "orgId": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8yYzNjOWY5NS03M2Q5LTQ0NjAtYTY2OC0wNDcxNjJmZjFiYWQ=",
  "from": "2023-01-15T15:53:00Z",
  "to": "2023-01-20T15:53:00Z",
  "items": [
    {
      "clusters": [
        {
          "clusterId": "Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzJjM2M5Zjk1LTczZDktNDQ2MC1hNjY4LTA0NzE2MmZmMWJhZDpmMWJmMGI1MC0yMDUyLTQ3ZmUtYjg3ZC01MTFjMmZlNzQ3MWI=",
          "clusterName": "shangai",
          "nodes": [
            {
              "nodeId": "Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT05ORUNUT1IvMmMzYzlmOTUtNzNkOS00NDYwLWE2NjgtMDQ3MTYyZmYxYmFkOjE1NmRmNzg5Yzg1NTRkNTVhMjc1ZGY5OTc4Zjk5MDJk",
              "hostNameOrIP": "abc.company.com",
              "testResults": [
                {
                  "timestamp": "2022-03-15T15:53:00Z",
                  "triggerType": "OnDemand",
                  "id": "Y2lzY29zcGFyazovL3VzL0NPTU1BTkRJRC8xZWI2NWZkZi05NjQzLTQxN2YtOTk3NC1hZDcyY2FlMGUxMGY6YWRlODhhNjAtMzk5Mi0xMWVkLTlhYmQtYzUyMjRiZjNjMzQ4",
                  "result": [
                    {
                      "type": "DNSResolutionTest",
                      "results": [
                        {
                          "serviceType": "WebexCloud",
                          "testResult": "Failed",
                          "failureDetails": {
                            "possibleFailureReason": [
                              "DNS Resolution issue detected in the Video Mesh Node [Error Code: 1302]."
                            ],
                            "possibleRemediation": [
                              "Please ensure that the configured DNS Servers are correct and healthy, and verify the network settings are adhering to the Video Mesh Deployment Guide. If the issue persists, please contact Cisco Support."
                            ]
                          }
                        },
                        {
                          "serviceType": "ThirdPartyCloud",
                          "testResult": "Success"
                        }
                      ]
                    },
                    {
                      "type": "WebSocketConnectivityTest",
                      "results": [
                        {
                          "serviceType": "WebexCloud",
                          "testResult": "Success"
                        }
                      ]
                    },
                    {
                      "type": "HTTPConnectivityTest",
                      "results": [
                        {
                          "serviceType": "WebexCloud",
                          "testResult": "Failed",
                          "failureDetails": {
                            "possibleFailureReason": [
                              "Connectivity issue detected between the Video Mesh Node and the Webex Cloud [Error Code: 1106]."
                            ],
                            "possibleRemediation": [
                              "One or more Webex cloud services may not be responding. Retry the test after some time. If the issue persists, please contact Cisco Support."
                            ]
                          }
                        },
                        {
                          "serviceType": "ThirdPartyCloud",
                          "testResult": "Success"
                        }
                      ]
                    },
                    {
                      "type": "BandwidthTest",
                      "results": [
                        {
                          "serviceType": "WebexCloud",
                          "testResult": "Failed",
                          "failureDetails": {
                            "possibleFailureReason": [
                              "Degraded Network Bandwidth speed detected in the Video Mesh Node connectivity to the Webex Cloud [Error Code: 1402,1405]."
                            ],
                            "possibleRemediation": [
                              "Please refer to Video Mesh deployment guide to ensure the network settings are configured correctly, and the minimum internet speed requirements are met. If the issue persists, please contact Cisco Support."
                            ]
                          }
                        },
                        {
                          "serviceType": "ThirdPartyCloud",
                          "testResult": "Success"
                        }
                      ]
                    }
                  ]
                }
              ]
            }
          ]
        }
      ]
    }
  ]
}