List of APIs - List Media Health Monitoring Tool Test results V2

List Media Health Monitoring Tool Test results V2

Returns the test results of the Media Health Monitoring Tool tests for an organization.

Changes in V2:

On-demand test results can be obtained along with the periodic tests that are executed on Video Mesh nodes.

GET/v1/videoMesh/testResults/mediaHealthMonitorTest

Query Parameters

orgId

stringrequired

Unique ID of the organization.

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 Media Health Monitoring Tool data.

string

End date and time (inclusive) of the Media Health Monitoring Tool data.

items

array[Media Health Monitoring clusters]

Media Health Monitoring Tool test results.

clusters

array[Media Health Monitoring for first cluster]

The list of Video Mesh clusters.

clusterId

string

Unique ID of the Video Mesh cluster.

clusterName

string

Name of the Video Mesh cluster.

nodes

array[Media Health Monitoring second node]

The Video Mesh nodes in the cluster.

nodeId

string

Unique ID of the Video Mesh node.

hostNameOrIP

string

Host name or the IP of the Video Mesh node.

mhmTestResults

array[Media Health Monitoring Test Results Failure]

The Media Health Monitoring Tool test results for a single Video Mesh node.

timestamp

string

The timestamp of the test run.

string

Unique ID of the test.

testResults

array[Media Signalling testResult Failure]

Test results of Media Signalling, SIP Signalling, Media Cascade runs.

testName

string

The name of the test.

testResult

string

Test results(Success/Failed).

failureReason

string

Reason for test failure.

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/mediaHealthMonitorTest{?orgId,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

orgId
stringRequired
Unique ID of the organization.
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/mediaHealthMonitorTest?orgId=Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8yYzNjOWY5NS03M2Q5LTQ0NjAtYTY2OC0wNDcxNjJmZjFiYWQ=&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": "banglore",
          "nodes": [
            {
              "nodeId": "Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT05ORUNUT1IvMmMzYzlmOTUtNzNkOS00NDYwLWE2NjgtMDQ3MTYyZmYxYmFkOjE1NmRmNzg5Yzg1NTRkNTVhMjc1ZGY5OTc4Zjk5MDJk",
              "hostNameOrIP": "abc.company.com",
              "mhmTestResults": [
                {
                  "timestamp": "2022-03-15T15:53:00Z",
                  "id": "Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT01NQU5EX0lELzJjM2M5ZjllLTczZDktNDQ2MC1hNjY4LTA0NzE2MmZmMWJhYzo2NTJmNmMxMC01NjgxLTExZWQtOTkyZS1kNTY5YzlkMDlhNzU",
                  "testResults": [
                    {
                      "testName": "Media Signalling",
                      "testResult": "Failed",
                      "failureReason": "An internal error occurred in monitoring tool [Error Code:1003]. If the issue persists, please contact Cisco Support."
                    },
                    {
                      "testName": "Media Cascade",
                      "testResult": "Failed",
                      "failureReason": "An internal error occurred in monitoring tool [Error Code:1004]. If the issue persists, please contact Cisco Support."
                    },
                    {
                      "testName": "SIP Signalling",
                      "testResult": "Failed",
                      "failureReason": "An internal error occurred in monitoring tool [Error Code:1002]. If the issue persists, please contact Cisco Support."
                    }
                  ]
                },
                {
                  "timestamp": "2022-03-15T15:53:00Z",
                  "id": "Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT01NQU5EX0lELzJjM2M5ZjllLTczZDktNDQ2MC1hNjY4LTA0NzE2MmZmMWJhYzo2NTJmNmMxMC01NjgxLTExZWQtOTkyZS1kNTY5YzlkMDlhNzU",
                  "testResults": [
                    {
                      "testName": "Media Signalling",
                      "testResult": "Success"
                    },
                    {
                      "testName": "Media Cascade",
                      "testResult": "Success"
                    },
                    {
                      "testName": "SIP Signalling",
                      "testResult": "Success"
                    }
                  ]
                }
              ]
            },
            {
              "nodeId": "Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT05ORUNUT1IvMmMzYzlmOTUtNzNkOS00NDYwLWE2NjgtMDQ3MTYyZmYxYmFkOjE1NmRmNzg5Yzg1NTRkNTVhMjc1ZGY5OTc4Zjk5MDJk",
              "hostNameOrIP": "xyz.company.com",
              "mhmTestResults": [
                {
                  "timestamp": "2022-03-15T15:53:00Z",
                  "id": "Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT01NQU5EX0lELzJjM2M5ZjllLTczZDktNDQ2MC1hNjY4LTA0NzE2MmZmMWJhYzo2NTJmNmMxMC01NjgxLTExZWQtOTkyZS1kNTY5YzlkMDlhNzU",
                  "testResults": [
                    {
                      "testName": "Media Signalling",
                      "testResult": "Failed",
                      "failureReason": "An internal error occurred in monitoring tool [Error Code:1003]. If the issue persists, please contact Cisco Support."
                    },
                    {
                      "testName": "Media Cascade",
                      "testResult": "Failed",
                      "failureReason": "An internal error occurred in monitoring tool [Error Code:1004]. If the issue persists, please contact Cisco Support."
                    },
                    {
                      "testName": "SIP Signalling",
                      "testResult": "Failed",
                      "failureReason": "An internal error occurred in monitoring tool [Error Code:1002]. If the issue persists, please contact Cisco Support."
                    }
                  ]
                },
                {
                  "timestamp": "2022-03-15T15:53:00Z",
                  "id": "Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT01NQU5EX0lELzJjM2M5ZjllLTczZDktNDQ2MC1hNjY4LTA0NzE2MmZmMWJhYzo2NTJmNmMxMC01NjgxLTExZWQtOTkyZS1kNTY5YzlkMDlhNzU",
                  "testResults": [
                    {
                      "testName": "Media Signalling",
                      "testResult": "Success"
                    },
                    {
                      "testName": "Media Cascade",
                      "testResult": "Success"
                    },
                    {
                      "testName": "SIP Signalling",
                      "testResult": "Success"
                    }
                  ]
                }
              ]
            }
          ]
        },
        {
          "clusterId": "Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzJjM2M5Zjk1LTczZDktNDQ2MC1hNjY4LTA0NzE2MmZmMWJhZDpmMWJmMGI1MC0yMDUyLTQ3ZmUtYjg3ZC01MTFjMmZlNzQ3MWk=",
          "clusterName": "sanjose",
          "nodes": [
            {
              "nodeId": "Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT05ORUNUT1IvMmMzYzlmOTUtNzNkOS00NDYwLWE2NjgtMDQ3MTYyZmYxYmFkOjE1NmRmNzg5Yzg1NTRkNTVhMjc1ZGY5OTc4Zjk5MDJk",
              "hostNameOrIP": "abc.company.com",
              "mhmTestResults": [
                {
                  "timestamp": "2022-03-15T15:53:00Z",
                  "id": "Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT01NQU5EX0lELzJjM2M5ZjllLTczZDktNDQ2MC1hNjY4LTA0NzE2MmZmMWJhYzo2NTJmNmMxMC01NjgxLTExZWQtOTkyZS1kNTY5YzlkMDlhNzU",
                  "testResults": [
                    {
                      "testName": "Media Signalling",
                      "testResult": "Failed",
                      "failureReason": "An internal error occurred in monitoring tool [Error Code:1003]. If the issue persists, please contact Cisco Support."
                    },
                    {
                      "testName": "Media Cascade",
                      "testResult": "Failed",
                      "failureReason": "An internal error occurred in monitoring tool [Error Code:1004]. If the issue persists, please contact Cisco Support."
                    },
                    {
                      "testName": "SIP Signalling",
                      "testResult": "Failed",
                      "failureReason": "An internal error occurred in monitoring tool [Error Code:1002]. If the issue persists, please contact Cisco Support."
                    }
                  ]
                },
                {
                  "timestamp": "2022-03-15T15:53:00Z",
                  "id": "Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT01NQU5EX0lELzJjM2M5ZjllLTczZDktNDQ2MC1hNjY4LTA0NzE2MmZmMWJhYzo2NTJmNmMxMC01NjgxLTExZWQtOTkyZS1kNTY5YzlkMDlhNzU",
                  "testResults": [
                    {
                      "testName": "Media Signalling",
                      "testResult": "Success"
                    },
                    {
                      "testName": "Media Cascade",
                      "testResult": "Success"
                    },
                    {
                      "testName": "SIP Signalling",
                      "testResult": "Success"
                    }
                  ]
                }
              ]
            },
            {
              "nodeId": "Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT05ORUNUT1IvMmMzYzlmOTUtNzNkOS00NDYwLWE2NjgtMDQ3MTYyZmYxYmFkOjE1NmRmNzg5Yzg1NTRkNTVhMjc1ZGY5OTc4Zjk5MDJk",
              "hostNameOrIP": "xyz.company.com",
              "mhmTestResults": [
                {
                  "timestamp": "2022-03-15T15:53:00Z",
                  "id": "Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT01NQU5EX0lELzJjM2M5ZjllLTczZDktNDQ2MC1hNjY4LTA0NzE2MmZmMWJhYzo2NTJmNmMxMC01NjgxLTExZWQtOTkyZS1kNTY5YzlkMDlhNzU",
                  "testResults": [
                    {
                      "testName": "Media Signalling",
                      "testResult": "Failed",
                      "failureReason": "An internal error occurred in monitoring tool [Error Code:1003]. If the issue persists, please contact Cisco Support."
                    },
                    {
                      "testName": "Media Cascade",
                      "testResult": "Failed",
                      "failureReason": "An internal error occurred in monitoring tool [Error Code:1004]. If the issue persists, please contact Cisco Support."
                    },
                    {
                      "testName": "SIP Signalling",
                      "testResult": "Failed",
                      "failureReason": "An internal error occurred in monitoring tool [Error Code:1002]. If the issue persists, please contact Cisco Support."
                    }
                  ]
                },
                {
                  "timestamp": "2022-03-15T15:53:00Z",
                  "id": "Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT01NQU5EX0lELzJjM2M5ZjllLTczZDktNDQ2MC1hNjY4LTA0NzE2MmZmMWJhYzo2NTJmNmMxMC01NjgxLTExZWQtOTkyZS1kNTY5YzlkMDlhNzU",
                  "testResults": [
                    {
                      "testName": "Media Signalling",
                      "testResult": "Success"
                    },
                    {
                      "testName": "Media Cascade",
                      "testResult": "Success"
                    },
                    {
                      "testName": "SIP Signalling",
                      "testResult": "Success"
                    }
                  ]
                }
              ]
            }
          ]
        }
      ]
    }
  ]
}