Webex · Example Payload
Webex Get Network Test Results For Cluster Example

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing
Webex Get Network Test Results For Cluster Example is an example object payload from Webex, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.
Top-level fields

operationIdmethodpathsummaryrequestExamplesresponseExamples
Example Payload

{
  "operationId": "Get Network Test results for cluster",
  "method": "GET",
  "path": "/videoMesh/testResults/networkTest/clusters",
  "summary": "Get Network Test results for cluster",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "orgId": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8yYzNjOWY5NS03M2Q5LTQ0NjAtYTY2OC0wNDcxNjJmZjFiYWQ=",
        "from": "2023-01-15T15:53:00Z",
        "to": "2023-01-20T15:53:00Z",
        "items": [
          {
            "clusters": [
              {
                "clusterId": "Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzJjM2M5Zjk1LTczZDktNDQ2MC1hNjY4LTA0NzE2MmZmMWJhZDpmMWJmMGI1MC0yMDUyLTQ3ZmUtYjg3ZC01MTFjMmZlNzQ3MWk=",
                "clusterName": "shangai",
                "nodes": [
                  {
                    "nodeId": "Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT05ORUNUT1IvMmMzYzlmOTUtNzNkOS00NDYwLWE2NjgtMDQ3MTYyZmYxYmFkOjE1NmRmNzg5Yzg1NTRkNTVhMjc1ZGY5OTc4Zjk5MDJk",
                    "hostNameOrIP": "def.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"
                              }
                            ]
                          }
                        ]
                      }
                    ]
                  }
                ]
              }
            ]
          }
        ]
      }
    }
  ]
}