openapi: 3.0.0 info: title: Webex Admin Address Book Video Mesh API version: 1.0.0 description: The Webex Admin APIs provide comprehensive programmatic access to administrative functions for managing Webex organizations, users, licenses, and settings. These APIs enable automation of user provisioning, license assignment, compliance management, and audit event retrieval. Administrators can integrate with enterprise identity systems, enforce security policies, monitor usage, and streamline onboarding/offboarding processes. The APIs support granular control over organizational resources, making them ideal for large-scale deployments and custom admin tooling. tags: - name: Video Mesh paths: /videoMesh/clusters/availability: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/ClustersAvailability' example: items: - orgId: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8zNmQ4OTRmNy0yYjU3LTQzYzEtYWNlZS1kNDdlNjc3NjE0MTQ= items: - clusterId: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzFlYjY1ZmRmLTk2NDMtNDE3Zi05OTc0LWFkNzJjYWUwZTEwZjpiMzdmNTgzYy1kZGRjLTQyOGItODJlNS1jYmU2ODFkYjQ5NjI= clusterName: San Jose availabilitySegments: - segmentStartTime: '2021-09-15T15:53:00Z' segmentEndTime: '2021-09-15T16:53:00Z' availability: Available noOfOnlineNodes: 1 noOfOfflineNodes: 1 totalNodes: 2 - segmentStartTime: '2021-09-15T16:53:00Z' segmentEndTime: '2021-09-15T17:53:00Z' availability: Unavailable noOfOnlineNodes: 0 noOfOfflineNodes: 2 totalNodes: 2 from: '2021-09-15T15:53:00Z' to: '2021-09-15T17:53:00Z' '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: List Clusters Availability operationId: List Clusters Availability description: Returns the availability details for all Video Mesh clusters in an organization. tags: - Video Mesh parameters: - name: from in: query description: The starting date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. required: true example: '2021-09-15T15:53:00Z' schema: type: string - name: to in: query description: The ending date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. required: true example: '2021-09-15T17:53:00Z' schema: type: string - name: orgId in: query description: The unique ID for the organization. required: true example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8zNmQ4OTRmNy0yYjU3LTQzYzEtYWNlZS1kNDdlNjc3NjE0MTQ schema: type: string /videoMesh/clusters/availability/{clusterId}: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/ClustersAvailability' example: items: - orgId: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8zNmQ4OTRmNy0yYjU3LTQzYzEtYWNlZS1kNDdlNjc3NjE0MTQ= items: - clusterId: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzFlYjY1ZmRmLTk2NDMtNDE3Zi05OTc0LWFkNzJjYWUwZTEwZjpiMzdmNTgzYy1kZGRjLTQyOGItODJlNS1jYmU2ODFkYjQ5NjI= clusterName: San Jose availabilitySegments: - segmentStartTime: '2021-09-15T15:53:00Z' segmentEndTime: '2021-09-15T16:53:00Z' availability: Available noOfOnlineNodes: 1 noOfOfflineNodes: 1 totalNodes: 2 - segmentStartTime: '2021-09-15T16:53:00Z' segmentEndTime: '2021-09-15T17:53:00Z' availability: Unavailable noOfOnlineNodes: 0 noOfOfflineNodes: 2 totalNodes: 2 from: '2021-09-15T15:53:00Z' to: '2021-09-15T17:53:00Z' '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Get Cluster Availability operationId: Get Cluster Availability description: Returns the availability details of a single Video Mesh cluster in an organization. tags: - Video Mesh parameters: - name: clusterId in: path description: The unique Video Mesh clusterID required: true example: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzFlYjY1ZmRmLTk2NDMtNDE3Zi05OTc0LWFkNzJjYWUwZTEwZjpiMzdmNTgzYy1kZGRjLTQyOGItODJlNS1jYmU2ODFkYjQ5NjI schema: type: string - name: from in: query description: The starting date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. required: true example: '2021-09-15T15:53:00Z' schema: type: string - name: to in: query description: The ending date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. required: true example: '2021-09-15T17:53:00Z' schema: type: string /videoMesh/nodes/availability: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/NodesAvailability' example: items: - orgId: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8zNmQ4OTRmNy0yYjU3LTQzYzEtYWNlZS1kNDdlNjc3NjE0MTQ= items: - clusterId: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzFlYjY1ZmRmLTk2NDMtNDE3Zi05OTc0LWFkNzJjYWUwZTEwZjpiMzdmNTgzYy1kZGRjLTQyOGItODJlNS1jYmU2ODFkYjQ5NjI= clusterName: San Jose hostNameOrIp: xyz.abc.com nodeId: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT05ORUNUT1IvMWViNjVmZGYtOTY0My00MTdmLTk5NzQtYWQ3MmNhZTBlMTBmOmMyNTk0YmY2NDFmZTRkNTFiZDg3YThiMjYxYzg3NWY1 availabilitySegments: - noOfOnlineNodes: 1 noOfOfflineNodes: 0 segmentStartTime: '2021-09-15T15:53:00Z' segmentEndTime: '2021-09-15T16:53:00Z' availability: Available unAvailabilityReason: NA totalNodes: 1 - noOfOnlineNodes: 0 noOfOfflineNodes: 1 segmentStartTime: '2021-09-15T16:53:00Z' segmentEndTime: '2021-09-15T17:53:00Z' availability: Unavailable unAvailabilityReason: Connectivity Issues to the Node totalNodes: 1 from: '2021-09-15T15:53:00Z' to: '2021-09-15T17:53:00Z' '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: List Node Availability operationId: List Node Availability description: Returns the availability details of all nodes in a Video Mesh cluster. tags: - Video Mesh parameters: - name: from in: query description: The starting date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. required: true example: '2021-09-15T15:53:00Z' schema: type: string - name: to in: query description: The ending date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. required: true example: '2021-09-15T17:53:00Z' schema: type: string - name: clusterId in: query description: The unique Video Mesh cluster ID. required: true example: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzM2ZDg5NGY3LTJiNTctNDNjMS1hY2VlLWQ0N2U2Nzc2MTQxNDo1ODJhMWFlYy03YTMwLTQ2MDItYTI2NS02YTE5NDcwOWZkOTg schema: type: string /videoMesh/nodes/availability/{nodeId}: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/SingleNodeAvailability' example: items: - orgId: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8zNmQ4OTRmNy0yYjU3LTQzYzEtYWNlZS1kNDdlNjc3NjE0MTQ= items: - clusterId: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzFlYjY1ZmRmLTk2NDMtNDE3Zi05OTc0LWFkNzJjYWUwZTEwZjpiMzdmNTgzYy1kZGRjLTQyOGItODJlNS1jYmU2ODFkYjQ5NjI= clusterName: San Jose hostNameOrIp: xyz.abc.com nodeId: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT05ORUNUT1IvMWViNjVmZGYtOTY0My00MTdmLTk5NzQtYWQ3MmNhZTBlMTBmOmMyNTk0YmY2NDFmZTRkNTFiZDg3YThiMjYxYzg3NWY1 availabilitySegments: - segmentStartTime: '2021-09-15T15:53:00Z' segmentEndTime: '2021-09-15T16:53:00Z' availability: Available unAvailabilityReason: NA - segmentStartTime: '2021-09-15T16:53:00Z' segmentEndTime: '2021-09-15T17:53:00Z' availability: Unavailable unAvailabilityReason: Connectivity Issues to the Node from: '2021-09-15T15:53:00Z' to: '2021-09-15T17:53:00Z' '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Get Node Availability operationId: Get Node Availability description: Returns the availability details of a single node in a Video Mesh cluster. tags: - Video Mesh parameters: - name: nodeId in: path description: The unique Video Mesh node ID. required: true example: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzM2ZDg5NGY3LTJiNTctNDNjMS1hY2VlLWQ0N2U2Nzc2MTQxNDo1ODJhMWFlYy03YTMwLTQ2MDItYTI2NS02YTE5NDcwOWZkOTg schema: type: string - name: from in: query description: The starting date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. required: true example: '2021-09-15T15:53:00Z' schema: type: string - name: to in: query description: The ending date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. required: true example: '2021-09-15T17:53:00Z' schema: type: string /videoMesh/testResults/mediaHealthMonitorTest: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/MediaHealthMonitoringResultsCollectionfororganization' example: 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 '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: List Media Health Monitoring Tool Test results V2 operationId: List Media Health Monitoring Tool Test results V2 description: '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.' tags: - Video Mesh parameters: - name: orgId in: query description: Unique ID of the organization. required: true example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8yYzNjOWY5NS03M2Q5LTQ0NjAtYTY2OC0wNDcxNjJmZjFiYWQ= schema: type: string - name: triggerType in: query description: Trigger type. required: true example: OnDemand schema: type: string enum: - OnDemand - Periodic - All - name: from in: query description: 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`. required: true example: '2023-01-15T15:53:00Z' schema: type: string - name: to in: query description: The end date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. required: true example: '2023-01-20T15:53:00Z' schema: type: string /videoMesh/testResults/mediaHealthMonitorTest/clusters: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/MediaHealthMonitoringResultsCollectionforcluster' example: orgId: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8yYzNjOWY5NS03M2Q5LTQ0NjAtYTY2OC0wNDcxNjJmZjFiYWQ= from: '2023-01-15T15:53:00Z' to: '2023-01-20T15:53:00Z' items: - clusters: - clusterId: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzJjM2M5Zjk1LTczZDktNDQ2MC1hNjY4LTA0NzE2MmZmMWJhZDpmMWJmMGI1MC0yMDUyLTQ3ZmUtYjg3ZC01MTFjMmZlNzQ3MWI= 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 '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Get Media Health Monitoring Tool Test results for clusters V2 operationId: Get Media Health Monitoring Tool Test results for clusters V2 description: 'Returns the test results of the Media Health Monitoring Tool tests for a single Video Mesh cluster.
Changes in V2:
On-demand test results can be obtained along with the periodic tests that are executed on Video Mesh nodes.' tags: - Video Mesh parameters: - name: clusterId in: query description: Unique ID of the Video Mesh cluster. required: true example: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzJjM2M5Zjk1LTczZDktNDQ2MC1hNjY4LTA0NzE2MmZmMWJhZDpmMWJmMGI1MC0yMDUyLTQ3ZmUtYjg3ZC01MTFjMmZlNzQ3MWI= schema: type: string - name: triggerType in: query description: Trigger type. required: true example: OnDemand schema: type: string enum: - OnDemand - Periodic - All - name: from in: query description: 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`. required: true example: '2023-01-15T15:53:00Z' schema: type: string - name: to in: query description: The end date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. required: true example: '2023-01-20T15:53:00Z' schema: type: string /videoMesh/testResults/mediaHealthMonitorTest/nodes: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/MediaHealthMonitoringResultsCollectionfornode' example: orgId: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8yYzNjOWY5NS03M2Q5LTQ0NjAtYTY2OC0wNDcxNjJmZjFiYWQ= from: '2023-01-15T15:53:00Z' to: '2023-01-20T15:53:00Z' items: - clusters: - clusterId: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzJjM2M5Zjk1LTczZDktNDQ2MC1hNjY4LTA0NzE2MmZmMWJhZDpmMWJmMGI1MC0yMDUyLTQ3ZmUtYjg3ZC01MTFjMmZlNzQ3MWI= clusterName: sanjose nodes: - 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 '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Get Media Health Monitoring Tool Test results for node V2 operationId: Get Media Health Monitoring Tool Test results for node V2 description: 'Returns the test results of the Media Health Monitoring Tool tests for a single Video Mesh node.
Changes in V2:
On-demand test results can be obtained along with the periodic tests that are executed on Video Mesh nodes.' tags: - Video Mesh parameters: - name: nodeId in: query description: Unique ID of the Video Mesh node. required: true example: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT05ORUNUT1IvMmMzYzlmOTUtNzNkOS00NDYwLWE2NjgtMDQ3MTYyZmYxYmFkOjE1NmRmNzg5Yzg1NTRkNTVhMjc1ZGY5OTc4Zjk5MDJk schema: type: string - name: triggerType in: query description: Trigger type. required: true example: OnDemand schema: type: string enum: - OnDemand - Periodic - All - name: from in: query description: 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`. required: true example: '2023-01-15T15:53:00Z' schema: type: string - name: to in: query description: The end date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. required: true example: '2023-01-20T15:53:00Z' schema: type: string /videoMesh/cloudOverflow: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/OverflowtoCloud' example: items: - orgId: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8zNmQ4OTRmNy0yYjU3LTQzYzEtYWNlZS1kNDdlNjc3NjE0MTQ from: '2022-03-23T10:22:03Z' to: '2022-03-24T04:22:03Z' aggregationInterval: 10m items: - timestamp: '2022-03-23T10:30:00Z' overflowDetails: - overflowReason: Capacity exceeded overflowCount: 25 possibleRemediation: Video Mesh exceeded its capacity. If this happens frequently, consider adding more nodes to your clusters. - overflowReason: Connectivity issues overflowCount: 1 possibleRemediation: Connectivity Issues between Video Mesh Node and Cloud. Check your network configuration. - timestamp: '2022-03-23T10:40:00Z' overflowDetails: - overflowReason: Capacity exceeded overflowCount: 38 possibleRemediation: Video Mesh exceeded its capacity. If this happens frequently, consider adding more nodes to your clusters. '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: List Overflow to Cloud details operationId: List Overflow to Cloud details description: Returns details of overflows to the cloud in an organization. tags: - Video Mesh parameters: - name: from in: query description: The starting date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. required: true example: '2021-09-15T15:53:00Z' schema: type: string - name: to in: query description: The ending date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. required: true example: '2021-09-15T17:53:00Z' schema: type: string - name: orgId in: query description: The unique Video Mesh organization ID. required: true example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8zNmQ4OTRmNy0yYjU3LTQzYzEtYWNlZS1kNDdlNjc3NjE0MTQ schema: type: string /videoMesh/callRedirects: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/RedirectforOrg' example: items: - orgId: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8zNmQ4OTRmNy0yYjU3LTQzYzEtYWNlZS1kNDdlNjc3NjE0MTQ from: '2022-03-23T10:22:03Z' to: '2022-03-24T10:22:03Z' aggregationInterval: 10m items: - timestamp: '2022-03-23T10:30:00Z' clusters: - clusterId: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzM2ZDg5NGY3LTJiNTctNDNjMS1hY2VlLWQ0N2U2Nzc2MTQxNDo1ODJhMWFlYy03YTMwLTQ2MDItYTI2NS02YTE5NDcwOWZkOTg clusterName: bangalore redirectDetails: - redirectReason: Capacity exceeded redirectCount: 10 possibleRemediation: Video Mesh exceeded its capacity. If this happens frequently, consider adding more nodes to your clusters. - redirectReason: Connectivity issues redirectCount: 78 possibleRemediation: Connectivity Issues between Video Mesh Node and Cloud. Check your network configuration. - clusterId: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzM2ZDg5NGY3LTJiNTctNDNjMS1hY2VlLWQ0N2U2Nzc2MTQxNDo1ODJhMWFlYy03YTMwLTQ2MDItYTI2NS02YTE5NDcwOTEyMzQ= clusterName: sanjose redirectDetails: - redirectReason: Capacity exceeded redirectCount: 26 possibleRemediation: Video Mesh exceeded its capacity. If this happens frequently, consider adding more nodes to your clusters. - timestamp: '2022-03-23T10:40:00Z' clusters: - clusterId: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzM2ZDg5NGY3LTJiNTctNDNjMS1hY2VlLWQ0N2U2Nzc2MTQxNDo1ODJhMWFlYy03YTMwLTQ2MDItYTI2NS02YTE5NDcwOWZkOTg clusterName: bangalore redirectDetails: - redirectReason: Node upgrading redirectCount: 4 possibleRemediation: Video Mesh Node is being upgraded. Please wait for upgrades to finish. - clusterId: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzM2ZDg5NGY3LTJiNTctNDNjMS1hY2VlLWQ0N2U2Nzc2MTQxNDo1ODJhMWFlYy03YTMwLTQ2MDItYTI2NS02YTE5NDcwOTEyMzQ= clusterName: sanjose redirectDetails: - redirectReason: Connectivity issues redirectCount: 47 possibleRemediation: Connectivity Issues between Video Mesh Node and Cloud. Check your network configuration. '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: List Cluster Redirect details operationId: List Cluster Redirect details description: Returns the redirect details of all Video Mesh clusters in an organization. tags: - Video Mesh parameters: - name: from in: query description: The starting date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. required: true example: '2021-09-15T15:53:00Z' schema: type: string - name: to in: query description: The ending date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. required: true example: '2021-09-15T17:53:00Z' schema: type: string - name: orgId in: query description: The unique Video Mesh organization ID. required: true example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8zNmQ4OTRmNy0yYjU3LTQzYzEtYWNlZS1kNDdlNjc3NjE0MTQ schema: type: string /videoMesh/clusters/callRedirects: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/RedirectForCluster' example: items: - orgId: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8zNmQ4OTRmNy0yYjU3LTQzYzEtYWNlZS1kNDdlNjc3NjE0MTQ from: '2022-03-23T10:22:03Z' to: '2022-03-24T10:22:03Z' aggregationInterval: 10m items: - timestamp: '2022-03-23T10:30:00Z' clusters: - clusterId: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzM2ZDg5NGY3LTJiNTctNDNjMS1hY2VlLWQ0N2U2Nzc2MTQxNDo1ODJhMWFlYy03YTMwLTQ2MDItYTI2NS02YTE5NDcwOWZkOTg clusterName: bangalore redirectDetails: - redirectReason: Capacity exceeded redirectCount: 10 possibleRemediation: Video Mesh exceeded its capacity. If this happens frequently, consider adding more nodes to your clusters. - redirectReason: Connectivity issues redirectCount: 78 possibleRemediation: Connectivity Issues between Video Mesh Node and Cloud. Check your network configuration. - timestamp: '2022-03-23T10:40:00Z' clusters: - clusterId: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzM2ZDg5NGY3LTJiNTctNDNjMS1hY2VlLWQ0N2U2Nzc2MTQxNDo1ODJhMWFlYy03YTMwLTQ2MDItYTI2NS02YTE5NDcwOWZkOTg clusterName: bangalore redirectDetails: - redirectReason: Node upgrading redirectCount: 4 possibleRemediation: Video Mesh Node is being upgraded. Please wait for upgrades to finish. '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Get Cluster Redirect details operationId: Get Cluster Redirect details description: Returns details of cluster redirects for a single Video Mesh cluster. tags: - Video Mesh parameters: - name: from in: query description: The starting date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. required: true example: '2021-09-15T15:53:00Z' schema: type: string - name: to in: query description: The ending date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. required: true example: '2021-09-15T17:53:00Z' schema: type: string - name: clusterId in: query description: The unique Video Mesh Cluster ID. required: true example: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzFlYjY1ZmRmLTk2NDMtNDE3Zi05OTc0LWFkNzJjYWUwZTEwZjpiMzdmNTgzYy1kZGRjLTQyOGItODJlNS1jYmU2ODFkYjQ5NjI schema: type: string /videoMesh/utilization: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/ClustersUtilization' example: items: - orgId: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8zNmQ4OTRmNy0yYjU3LTQzYzEtYWNlZS1kNDdlNjc3NjE0MTQ= aggregationInterval: 10m from: '2022-03-23T10:22:03Z' to: '2022-03-24T10:22:03Z' items: - timestamp: '2022-03-23T10:30:00Z' clusters: - clusterId: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzM2ZDg5NGY3LTJiNTctNDNjMS1hY2VlLWQ0N2U2Nzc2MTQxNDo1ODJhMWFlYy03YTMwLTQ2MDItYTI2NS02YTE5NDcwOTEyMzQ= clusterName: sanjose utilizationMetrics: peakCpu: 54.54 avgCpu: 4.27 activeCalls: 5 activePrivateCalls: 1 - clusterId: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzM2ZDg5NGY3LTJiNTctNDNjMS1hY2VlLWQ0N2U2Nzc2MTQxNDo1ODJhMWFlYy03YTMwLTQ2MDItYTI2NS02YTE5NDcwOWZkOTg= clusterName: bangalore utilizationMetrics: peakCpu: 62 avgCpu: 3.64 activeCalls: 0 activePrivateCalls: 0 - timestamp: '2022-03-23T10:40:00Z' clusters: - clusterId: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzM2ZDg5NGY3LTJiNTctNDNjMS1hY2VlLWQ0N2U2Nzc2MTQxNDo1ODJhMWFlYy03YTMwLTQ2MDItYTI2NS02YTE5NDcwOTEyMzQ= clusterName: sanjose utilizationMetrics: peakCpu: 73.26 avgCpu: 13.16 activeCalls: 7 activePrivateCalls: 2 - clusterId: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzM2ZDg5NGY3LTJiNTctNDNjMS1hY2VlLWQ0N2U2Nzc2MTQxNDo1ODJhMWFlYy03YTMwLTQ2MDItYTI2NS02YTE5NDcwOWZkOTg= clusterName: bangalore utilizationMetrics: peakCpu: 69.75 avgCpu: 57.89 activeCalls: 142 activePrivateCalls: 15 '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: List Clusters Utilization operationId: List Clusters Utilization description: Returns the utilization details of all Video Mesh clusters in an organization. tags: - Video Mesh parameters: - name: from in: query description: The starting date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. required: true example: '2021-09-15T15:53:00Z' schema: type: string - name: to in: query description: The ending date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. required: true example: '2021-09-15T17:53:00Z' schema: type: string - name: orgId in: query description: The unique ID for the organization. required: true example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8zNmQ4OTRmNy0yYjU3LTQzYzEtYWNlZS1kNDdlNjc3NjE0MTQ schema: type: string /videoMesh/clusters/utilization: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/UtilizationForCluster' example: items: - orgId: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8zNmQ4OTRmNy0yYjU3LTQzYzEtYWNlZS1kNDdlNjc3NjE0MTQ= aggregationInterval: 10m from: '2022-03-23T10:22:03Z' to: '2022-03-24T10:22:03Z' items: - timestamp: '2022-03-23T10:30:00Z' clusters: - clusterId: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzM2ZDg5NGY3LTJiNTctNDNjMS1hY2VlLWQ0N2U2Nzc2MTQxNDo1ODJhMWFlYy03YTMwLTQ2MDItYTI2NS02YTE5NDcwOWZkOTg= clusterName: bangalore utilizationMetrics: peakCpu: 62 avgCpu: 3.64 activeCalls: 0 activePrivateCalls: 0 - timestamp: '2022-03-23T10:40:00Z' clusters: - clusterId: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzM2ZDg5NGY3LTJiNTctNDNjMS1hY2VlLWQ0N2U2Nzc2MTQxNDo1ODJhMWFlYy03YTMwLTQ2MDItYTI2NS02YTE5NDcwOWZkOTg= clusterName: bangalore utilizationMetrics: peakCpu: 69.75 avgCpu: 57.89 activeCalls: 142 activePrivateCalls: 15 '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Get Cluster Utilization details operationId: Get Cluster Utilization details description: Returns the utilization details for a single Video Mesh cluster. tags: - Video Mesh parameters: - name: from in: query description: The starting date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. required: true example: '2021-09-15T15:53:00Z' schema: type: string - name: to in: query description: The ending date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. required: true example: '2021-09-15T17:53:00Z' schema: type: string - name: clusterId in: query description: The unique Video Mesh Cluster ID. required: true example: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzFlYjY1ZmRmLTk2NDMtNDE3Zi05OTc0LWFkNzJjYWUwZTEwZjpiMzdmNTgzYy1kZGRjLTQyOGItODJlNS1jYmU2ODFkYjQ5NjI schema: type: string /videoMesh/testResults/reachabilityTest: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/ReachabilityTestresultsfororganization' example: orgId: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8yYzNjOWY5NS03M2Q5LTQ0NjAtYTY2OC0wNDcxNjJmZjFiYWQ= from: '2023-01-15T15:53:00Z' to: '2023-01-20T15:53:00Z' items: - clusters: - clusterId: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzJjM2M5Zjk1LTczZDktNDQ2MC1hNjY4LTA0NzE2MmZmMWJhZDpmMWJmMGI1MC0yMDUyLTQ3ZmUtYjg3ZC01MTFjMmZlNzQ3MWI= clusterName: banglore nodes: - nodeId: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT05ORUNUT1IvMmMzYzlmOTUtNzNkOS00NDYwLWE2NjgtMDQ3MTYyZmYxYmFkOjE1NmRmNzg5Yzg1NTRkNTVhMjc1ZGY5OTc4Zjk5MDJk hostNameOrIP: xyz.company.com testResults: - destinationCluster: Amsterdam Cluster stunResults: - timestamp: '2022-03-15T15:53:00Z' triggerType: OnDemand id: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT01NQU5EX0lELzJjM2M5ZjllLTczZDktNDQ2MC1hNjY4LTA0NzE2MmZmMWJhYzo2NTJmNmMxMC01NjgxLTExZWQtOTkyZS1kNTY5YzlkMDlhNzU udp: - ipAddress: 1.1.1.1 port: 51004 reachable: false - ipAddress: 1.1.1.1 port: 5004 reachable: true tcp: - ipAddress: 1.1.1.1 port: 51004 reachable: false - ipAddress: 1.1.1.1 port: 5004 reachable: true - timestamp: '2022-03-15T16:53:00Z' triggerType: OnDemand id: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT01NQU5EX0lELzJjM2M5ZjllLTczZDktNDQ2MC1hNjY4LTA0NzE2MmZmMWJhYzo2NTJmNmMxMC01NjgxLTExZWQtOTkyZS1kNTY5YzlkMDlhNzU udp: - ipAddress: 1.1.1.1 port: 51004 reachable: false - ipAddress: 1.1.1.1 port: 5004 reachable: true tcp: - ipAddress: 1.1.1.1 port: 51004 reachable: false - ipAddress: 1.1.1.1 port: 5004 reachable: true - nodeId: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT05ORUNUT1IvMmMzYzlmOTUtNzNkOS00NDYwLWE2NjgtMDQ3MTYyZmYxYmFkOjE1NmRmNzg5Yzg1NTRkNTVhMjc1ZGY5OTc4Zjk5MDJk hostNameOrIP: abc.company.com testResults: - destinationCluster: Amsterdam Cluster stunResults: - timestamp: '2022-03-15T15:53:00Z' triggerType: OnDemand id: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT01NQU5EX0lELzJjM2M5ZjllLTczZDktNDQ2MC1hNjY4LTA0NzE2MmZmMWJhYzo2NTJmNmMxMC01NjgxLTExZWQtOTkyZS1kNTY5YzlkMDlhNzU udp: - ipAddress: 1.1.1.1 port: 51004 reachable: false - ipAddress: 1.1.1.1 port: 5004 reachable: true tcp: - ipAddress: 1.1.1.1 port: 51004 reachable: false - ipAddress: 1.1.1.1 port: 5004 reachable: true - timestamp: '2022-03-15T16:53:00Z' triggerType: OnDemand id: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT01NQU5EX0lELzJjM2M5ZjllLTczZDktNDQ2MC1hNjY4LTA0NzE2MmZmMWJhYzo2NTJmNmMxMC01NjgxLTExZWQtOTkyZS1kNTY5YzlkMDlhNzU udp: - ipAddress: 1.1.1.1 port: 51004 reachable: false - ipAddress: 1.1.1.1 port: 5004 reachable: true tcp: - ipAddress: 1.1.1.1 port: 51004 reachable: false - ipAddress: 1.1.1.1 port: 5004 reachable: true - clusterId: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzJjM2M5Zjk1LTczZDktNDQ2MC1hNjY4LTA0NzE2MmZmMWJhZDpmMWJmMGI1MC0yMDUyLTQ3ZmUtYjg3ZC01MTFjMmZlNzQ3MWk= clusterName: sanjose nodes: - nodeId: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT05ORUNUT1IvMmMzYzlmOTUtNzNkOS00NDYwLWE2NjgtMDQ3MTYyZmYxYmFkOjE1NmRmNzg5Yzg1NTRkNTVhMjc1ZGY5OTc4Zjk5MDJk hostNameOrIP: xyz.company.com testResults: - destinationCluster: Amsterdam Cluster stunResults: - timestamp: '2022-03-15T15:53:00Z' triggerType: OnDemand id: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT01NQU5EX0lELzJjM2M5ZjllLTczZDktNDQ2MC1hNjY4LTA0NzE2MmZmMWJhYzo2NTJmNmMxMC01NjgxLTExZWQtOTkyZS1kNTY5YzlkMDlhNzU udp: - ipAddress: 1.1.1.1 port: 51004 reachable: false - ipAddress: 1.1.1.1 port: 5004 reachable: true tcp: - ipAddress: 1.1.1.1 port: 51004 reachable: false - ipAddress: 1.1.1.1 port: 5004 reachable: true - timestamp: '2022-03-15T16:53:00Z' triggerType: OnDemand id: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT01NQU5EX0lELzJjM2M5ZjllLTczZDktNDQ2MC1hNjY4LTA0NzE2MmZmMWJhYzo2NTJmNmMxMC01NjgxLTExZWQtOTkyZS1kNTY5YzlkMDlhNzU udp: - ipAddress: 1.1.1.1 port: 51004 reachable: false - ipAddress: 1.1.1.1 port: 5004 reachable: true tcp: - ipAddress: 1.1.1.1 port: 51004 reachable: false - ipAddress: 1.1.1.1 port: 5004 reachable: true - nodeId: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT05ORUNUT1IvMmMzYzlmOTUtNzNkOS00NDYwLWE2NjgtMDQ3MTYyZmYxYmFkOjE1NmRmNzg5Yzg1NTRkNTVhMjc1ZGY5OTc4Zjk5MDJk hostNameOrIP: abc.company.com testResults: - destinationCluster: Amsterdam Cluster stunResults: - timestamp: '2022-03-15T15:53:00Z' triggerType: OnDemand id: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT01NQU5EX0lELzJjM2M5ZjllLTczZDktNDQ2MC1hNjY4LTA0NzE2MmZmMWJhYzo2NTJmNmMxMC01NjgxLTExZWQtOTkyZS1kNTY5YzlkMDlhNzU udp: - ipAddress: 1.1.1.1 port: 51004 reachable: false - ipAddress: 1.1.1.1 port: 5004 reachable: true tcp: - ipAddress: 1.1.1.1 port: 51004 reachable: false - ipAddress: 1.1.1.1 port: 5004 reachable: true - timestamp: '2022-03-15T16:53:00Z' triggerType: OnDemand id: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT01NQU5EX0lELzJjM2M5ZjllLTczZDktNDQ2MC1hNjY4LTA0NzE2MmZmMWJhYzo2NTJmNmMxMC01NjgxLTExZWQtOTkyZS1kNTY5YzlkMDlhNzU udp: - ipAddress: 1.1.1.1 port: 51004 reachable: false - ipAddress: 1.1.1.1 port: 5004 reachable: true tcp: - ipAddress: 1.1.1.1 port: 51004 reachable: false - ipAddress: 1.1.1.1 port: 5004 reachable: true '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: List Reachability Test results V2 operationId: List Reachability Test results V2 description: 'Returns the test results of the Reachability tests for an organization.
Changes in V2:
1. On-demand test results can be obtained along with the periodic tests that are executed on Video Mesh nodes.
2. You can now view the destination IP address of the destination cluster in the JSON response.' tags: - Video Mesh parameters: - name: orgId in: query description: Unique ID of the organization. required: true example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8yYzNjOWY5NS03M2Q5LTQ0NjAtYTY2OC0wNDcxNjJmZjFiYWQ= schema: type: string - name: triggerType in: query description: Trigger type. required: true example: OnDemand schema: type: string enum: - OnDemand - Periodic - All - name: from in: query description: 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`. required: true example: '2023-01-15T15:53:00Z' schema: type: string - name: to in: query description: The end date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. required: true example: '2023-01-20T15:53:00Z' schema: type: string /videoMesh/testResults/reachabilityTest/clusters: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/ReachabilityTestresultsforcluster' example: orgId: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8yYzNjOWY5NS03M2Q5LTQ0NjAtYTY2OC0wNDcxNjJmZjFiYWQ= from: '2023-01-15T15:53:00Z' to: '2023-01-20T15:53:00Z' items: - clusters: - clusterId: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzJjM2M5Zjk1LTczZDktNDQ2MC1hNjY4LTA0NzE2MmZmMWJhZDpmMWJmMGI1MC0yMDUyLTQ3ZmUtYjg3ZC01MTFjMmZlNzQ3MWI= clusterName: banglore nodes: - nodeId: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT05ORUNUT1IvMmMzYzlmOTUtNzNkOS00NDYwLWE2NjgtMDQ3MTYyZmYxYmFkOjE1NmRmNzg5Yzg1NTRkNTVhMjc1ZGY5OTc4Zjk5MDJk hostNameOrIP: xyz.company.com testResults: - destinationCluster: Amsterdam Cluster stunResults: - timestamp: '2022-03-15T15:53:00Z' triggerType: OnDemand id: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT01NQU5EX0lELzJjM2M5ZjllLTczZDktNDQ2MC1hNjY4LTA0NzE2MmZmMWJhYzo2NTJmNmMxMC01NjgxLTExZWQtOTkyZS1kNTY5YzlkMDlhNzU udp: - ipAddress: 1.1.1.1 port: 51004 reachable: false - ipAddress: 1.1.1.1 port: 5004 reachable: true tcp: - ipAddress: 1.1.1.1 port: 51004 reachable: false - ipAddress: 1.1.1.1 port: 5004 reachable: true - timestamp: '2022-03-15T16:53:00Z' triggerType: OnDemand id: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT01NQU5EX0lELzJjM2M5ZjllLTczZDktNDQ2MC1hNjY4LTA0NzE2MmZmMWJhYzo2NTJmNmMxMC01NjgxLTExZWQtOTkyZS1kNTY5YzlkMDlhNzU udp: - ipAddress: 1.1.1.1 port: 51004 reachable: false - ipAddress: 1.1.1.1 port: 5004 reachable: true tcp: - ipAddress: 1.1.1.1 port: 51004 reachable: false - ipAddress: 1.1.1.1 port: 5004 reachable: true - nodeId: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT05ORUNUT1IvMmMzYzlmOTUtNzNkOS00NDYwLWE2NjgtMDQ3MTYyZmYxYmFkOjE1NmRmNzg5Yzg1NTRkNTVhMjc1ZGY5OTc4Zjk5MDJk hostNameOrIP: abc.company.com testResults: - destinationCluster: Amsterdam Cluster stunResults: - timestamp: '2022-03-15T15:53:00Z' triggerType: OnDemand id: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT01NQU5EX0lELzJjM2M5ZjllLTczZDktNDQ2MC1hNjY4LTA0NzE2MmZmMWJhYzo2NTJmNmMxMC01NjgxLTExZWQtOTkyZS1kNTY5YzlkMDlhNzU udp: - ipAddress: 1.1.1.1 port: 51004 reachable: false - ipAddress: 1.1.1.1 port: 5004 reachable: true tcp: - ipAddress: 1.1.1.1 port: 51004 reachable: false - ipAddress: 1.1.1.1 port: 5004 reachable: true - timestamp: '2022-03-15T16:53:00Z' triggerType: OnDemand id: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT01NQU5EX0lELzJjM2M5ZjllLTczZDktNDQ2MC1hNjY4LTA0NzE2MmZmMWJhYzo2NTJmNmMxMC01NjgxLTExZWQtOTkyZS1kNTY5YzlkMDlhNzU udp: - ipAddress: 1.1.1.1 port: 51004 reachable: false - ipAddress: 1.1.1.1 port: 5004 reachable: true tcp: - ipAddress: 1.1.1.1 port: 51004 reachable: false - ipAddress: 1.1.1.1 port: 5004 reachable: true '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Get Reachability Test results for cluster V2 operationId: Get Reachability Test results for cluster V2 description: 'Returns the test results of the Reachability tests for a single Video Mesh cluster.
Changes in V2:
1. On-demand test results can be obtained along with the periodic tests that are executed on Video Mesh nodes.
2. You can now view the destination IP address of the destination cluster in the JSON response.' tags: - Video Mesh parameters: - name: clusterId in: query description: Unique ID of the Video Mesh cluster. required: true example: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzJjM2M5Zjk1LTczZDktNDQ2MC1hNjY4LTA0NzE2MmZmMWJhZDpmMWJmMGI1MC0yMDUyLTQ3ZmUtYjg3ZC01MTFjMmZlNzQ3MWI= schema: type: string - name: triggerType in: query description: Trigger type. required: true example: OnDemand schema: type: string enum: - OnDemand - Periodic - All - name: from in: query description: 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`. required: true example: '2023-01-15T15:53:00Z' schema: type: string - name: to in: query description: The end date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. required: true example: '2023-01-20T15:53:00Z' schema: type: string /videoMesh/testResults/reachabilityTest/nodes: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/ReachabilityTestresultsfornode' example: orgId: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8yYzNjOWY5NS03M2Q5LTQ0NjAtYTY2OC0wNDcxNjJmZjFiYWQ= from: '2023-01-15T15:53:00Z' to: '2023-01-20T15:53:00Z' items: - clusters: - clusterId: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzJjM2M5Zjk1LTczZDktNDQ2MC1hNjY4LTA0NzE2MmZmMWJhZDpmMWJmMGI1MC0yMDUyLTQ3ZmUtYjg3ZC01MTFjMmZlNzQ3MWI= clusterName: banglore nodes: - nodeId: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT05ORUNUT1IvMmMzYzlmOTUtNzNkOS00NDYwLWE2NjgtMDQ3MTYyZmYxYmFkOjE1NmRmNzg5Yzg1NTRkNTVhMjc1ZGY5OTc4Zjk5MDJk hostNameOrIP: xyz.company.com testResults: - destinationCluster: Amsterdam Cluster stunResults: - timestamp: '2022-03-15T15:53:00Z' triggerType: OnDemand id: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT01NQU5EX0lELzJjM2M5ZjllLTczZDktNDQ2MC1hNjY4LTA0NzE2MmZmMWJhYzo2NTJmNmMxMC01NjgxLTExZWQtOTkyZS1kNTY5YzlkMDlhNzU udp: - ipAddress: 1.1.1.1 port: 51004 reachable: false - ipAddress: 1.1.1.1 port: 5004 reachable: true tcp: - ipAddress: 1.1.1.1 port: 51004 reachable: false - ipAddress: 1.1.1.1 port: 5004 reachable: true - timestamp: '2022-03-15T16:53:00Z' triggerType: OnDemand id: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT01NQU5EX0lELzJjM2M5ZjllLTczZDktNDQ2MC1hNjY4LTA0NzE2MmZmMWJhYzo2NTJmNmMxMC01NjgxLTExZWQtOTkyZS1kNTY5YzlkMDlhNzU udp: - ipAddress: 1.1.1.1 port: 51004 reachable: false - ipAddress: 1.1.1.1 port: 5004 reachable: true tcp: - ipAddress: 1.1.1.1 port: 51004 reachable: false - ipAddress: 1.1.1.1 port: 5004 reachable: true '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Get Reachability Test results for node V2 operationId: Get Reachability Test results for node V2 description: 'Returns the test results of the Reachability tests for a single Video Mesh node.
Changes in V2:
1. On-demand test results can be obtained along with the periodic tests that are executed on Video Mesh nodes.
2. You can now view the destination IP address of the destination cluster in the JSON response.' tags: - Video Mesh parameters: - name: nodeId in: query description: Unique ID of the Video Mesh node. required: true example: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT05ORUNUT1IvMmMzYzlmOTUtNzNkOS00NDYwLWE2NjgtMDQ3MTYyZmYxYmFkOjE1NmRmNzg5Yzg1NTRkNTVhMjc1ZGY5OTc4Zjk5MDJk schema: type: string - name: triggerType in: query description: Trigger type. required: true example: OnDemand schema: type: string enum: - OnDemand - Periodic - All - name: from in: query description: 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`. required: true example: '2023-01-15T15:53:00Z' schema: type: string - name: to in: query description: The end date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. required: true example: '2023-01-20T15:53:00Z' schema: type: string /videoMesh/clusters: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/ClusterDetails' example: items: - orgId: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8zNmQ4OTRmNy0yYjU3LTQzYzEtYWNlZS1kNDdlNjc3NjE0MTQ items: - clusterId: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzFlYjY1ZmRmLTk2NDMtNDE3Zi05OTc0LWFkNzJjYWUwZTEwZjpiMzdmNTgzYy1kZGRjLTQyOGItODJlNS1jYmU2ODFkYjQ5NjI clusterName: Bangalore nodes: - nodeId: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzM2ZDg5NGY3LTJiNTctNDNjMS1hY2VlLWQ0N2U2Nzc2MTQxNDo0NjdiNGIxZC1jZWI2LTQwN2EtYWZmOC1mMjIxZmFiNzhjNzI hostNameOrIp: xyz.abc.com deploymentType: Video Mesh Node Lite location: countryCode: IN city: Bangalore timeZone: Asia/Kolkata - nodeId: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzM2ZDg5NGY3LTJiNTctNDNjMS1hY2VlLWQ0N2U2Nzc2MTQxNDo1ODJhMWFlYy03YTMwLTQ2MDItYTI2NS02YTE5NDcwOWZkOTg hostNameOrIp: 201.21.201.21 deploymentType: Video Mesh Node Lite location: countryCode: IN city: Bangalore timeZone: Asia/Kolkata releaseChannel: alpha upgradeSchedule: scheduleDays: - sunday scheduleTime: 02:00 scheduleTimeZone: Asia/Kolkata upgradePending: true nextUpgradeTime: '2020-03-25T20:30:00Z' - clusterId: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzM2ZDg5NGY3LTJiNTctNDNjMS1hY2VlLWQ0N2U2Nzc2MTQxNDo1ODJhMWFlYy03YTMwLTQ2MDItYTI2NS02YTE5NDcwOTEyMzQ clusterName: San Jose nodes: - nodeId: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzM2ZDg5NGY3LTJiNTctNDNjMS1hY2VlLWQ0N2U2Nzc2MTQxNDo0NjdiNGIxZC1jZWI2LTQwN2EtYWZmOC1mMjIxZmFiNzhjNzI hostNameOrIp: abc.company.com deploymentType: Video Mesh Node Lite location: countryCode: US city: San Jose timeZone: America/Los_Angeles - nodeId: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzM2ZDg5NGY3LTJiNTctNDNjMS1hY2VlLWQ0N2U2Nzc2MTQxNDo1ODJhMWFlYy03YTMwLTQ2MDItYTI2NS02YTE5NDcwOWZkOTg hostNameOrIp: xyz.abc.com deploymentType: Video Mesh Node Lite location: countryCode: US city: San Jose timeZone: America/Los_Angeles releaseChannel: alpha upgradeSchedule: scheduleDays: - sunday scheduleTime: 02:00 scheduleTimeZone: America/Los_Angeles upgradePending: true nextUpgradeTime: '2020-03-26T09:00:00Z' '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: List Cluster Details operationId: List Cluster Details description: Returns the cluster details of all Video Mesh clusters in an organization. tags: - Video Mesh parameters: - name: orgId in: query description: The unique ID for the organization. required: true example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8zNmQ4OTRmNy0yYjU3LTQzYzEtYWNlZS1kNDdlNjc3NjE0MTQ schema: type: string /videoMesh/clusters/{clusterId}: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/SpecificClusterDetails' example: items: - orgId: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8zNmQ4OTRmNy0yYjU3LTQzYzEtYWNlZS1kNDdlNjc3NjE0MTQ items: - clusterId: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzFlYjY1ZmRmLTk2NDMtNDE3Zi05OTc0LWFkNzJjYWUwZTEwZjpiMzdmNTgzYy1kZGRjLTQyOGItODJlNS1jYmU2ODFkYjQ5NjI clusterName: Bangalore nodes: - nodeId: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzM2ZDg5NGY3LTJiNTctNDNjMS1hY2VlLWQ0N2U2Nzc2MTQxNDo0NjdiNGIxZC1jZWI2LTQwN2EtYWZmOC1mMjIxZmFiNzhjNzI hostNameOrIp: xyz.abc.com deploymentType: Video Mesh Node Lite location: countryCode: IN city: Bangalore timeZone: Asia/Kolkata - nodeId: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzM2ZDg5NGY3LTJiNTctNDNjMS1hY2VlLWQ0N2U2Nzc2MTQxNDo1ODJhMWFlYy03YTMwLTQ2MDItYTI2NS02YTE5NDcwOWZkOTg hostNameOrIp: 201.21.201.21 deploymentType: Video Mesh Node Lite location: countryCode: IN city: Bangalore timeZone: Asia/Kolkata releaseChannel: alpha upgradeSchedule: scheduleDays: - sunday scheduleTime: 02:00 scheduleTimeZone: Asia/Kolkata upgradePending: true nextUpgradeTime: '2020-03-25T20:30:00Z' '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Get Cluster Details operationId: Get Cluster Details description: Returns the cluster details for a single Video Mesh cluster. tags: - Video Mesh parameters: - name: clusterId in: path description: The unique Video Mesh Cluster ID. required: true example: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzFlYjY1ZmRmLTk2NDMtNDE3Zi05OTc0LWFkNzJjYWUwZTEwZjpiMzdmNTgzYy1kZGRjLTQyOGItODJlNS1jYmU2ODFkYjQ5NjI schema: type: string /videoMesh/triggerTest/clusters/{clusterId}: post: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/TriggeredTestStatus1' example: orgId: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8yYzNjOWY5NS03M2Q5LTQ0NjAtYTY2OC0wNDcxNjJmZjFiYWQ= commandId: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT01NQU5EX0lELzJjM2M5ZjllLTczZDktNDQ2MC1hNjY4LTA0NzE2MmZmMWJhYzo2NTJmNmMxMC01NjgxLTExZWQtOTkyZS1kNTY5YzlkMDlhNzU clusterId: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzJjM2M5Zjk1LTczZDktNDQ2MC1hNjY4LTA0NzE2MmZmMWJhZDpmMWJmMGI1MC0yMDUyLTQ3ZmUtYjg3ZC01MTFjMmZlNzQ3MWI= nodes: - nodeId: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT05ORUNUT1IvMmMzYzlmOTUtNzNkOS00NDYwLWE2NjgtMDQ3MTYyZmYxYmFkOjE1NmRmNzg5Yzg1NTRkNTVhMjc1ZGY5OTc4Zjk5MDJk status: Dispatched - nodeId: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT05ORUNUT1IvMmMzYzlmOWUtNzNkOS00NDYwLWE2NjgtMDQ3MTYyZmYxYmFjOjE1NmRmNzg5Yzg1NTRkNTVhMjc1ZGU5OTc4Zjk5MDJl status: Dispatched '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Trigger on-demand test for cluster operationId: Trigger on-demand test for cluster description: 'Triggers an on-demand test for a cluster. The test is run on a maximum of 10 nodes present in the cluster, chosen at random, or based on input from the user.' tags: - Video Mesh parameters: - name: clusterId in: path description: Unique ID of the Video Mesh cluster. required: true example: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzJjM2M5Zjk1LTczZDktNDQ2MC1hNjY4LTA0NzE2MmZmMWJhZDpmMWJmMGI1MC0yMDUyLTQ3ZmUtYjg3ZC01MTFjMmZlNzQ3MWI= schema: type: string requestBody: content: application/json: example: type: MediaHealthMonitorTest nodes: - Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT05ORUNUT1IvMmMzYzlmOWUtNzNkOS00NDYwLWE2NjgtMDQ3MTYyZmYxYmFjOjE1NmRmNzg5Yzg1NTRkNTVhMjc1ZGU5OTc4Zjk5MDJk - Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT05ORUNUT1IvMmMzYzlmOWUtNzNkOS00NDYwLWE2NjgtMDQ3MTYyZmYxYmFjOjE1NmRmNzg5Yzg1NTRhYmNhZGVmZ2U5OTc4Zjk5MDJk schema: $ref: '#/components/schemas/TriggerOn-DemandBodyCluster' /videoMesh/triggerTest/nodes/{nodeId}: post: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/TriggeredTestStatus2' example: orgId: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8yYzNjOWY5NS03M2Q5LTQ0NjAtYTY2OC0wNDcxNjJmZjFiYWQ= commandId: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT01NQU5EX0lELzJjM2M5ZjllLTczZDktNDQ2MC1hNjY4LTA0NzE2MmZmMWJhYzo2NTJmNmMxMC01NjgxLTExZWQtOTkyZS1kNTY5YzlkMDlhNzU clusterId: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzJjM2M5Zjk1LTczZDktNDQ2MC1hNjY4LTA0NzE2MmZmMWJhZDpmMWJmMGI1MC0yMDUyLTQ3ZmUtYjg3ZC01MTFjMmZlNzQ3MWk= nodes: - nodeId: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT05ORUNUT1IvMmMzYzlmOTUtNzNkOS00NDYwLWE2NjgtMDQ3MTYyZmYxYmFkOjE1NmRmNzg5Yzg1NTRkNTVhMjc1ZGY5OTc4Zjk5MDJk status: Dispatched '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Trigger on-demand test for node operationId: Trigger on-demand test for node description: Triggers an on-demand test for a node. tags: - Video Mesh parameters: - name: nodeId in: path description: Unique ID of the Video Mesh node. required: true example: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT05ORUNUT1IvMmMzYzlmOTUtNzNkOS00NDYwLWE2NjgtMDQ3MTYyZmYxYmFkOjE1NmRmNzg5Yzg1NTRkNTVhMjc1ZGY5OTc4Zjk5MDJk schema: type: string requestBody: content: application/json: example: type: MediaHealthMonitorTest schema: $ref: '#/components/schemas/TriggerOnDemandBody' /videoMesh/testStatus: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/TriggeredTestStatus1' example: orgId: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8yYzNjOWY5NS03M2Q5LTQ0NjAtYTY2OC0wNDcxNjJmZjFiYWQ= commandId: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT01NQU5EX0lELzJjM2M5ZjllLTczZDktNDQ2MC1hNjY4LTA0NzE2MmZmMWJhYzo2NTJmNmMxMC01NjgxLTExZWQtOTkyZS1kNTY5YzlkMDlhNzU clusterId: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzJjM2M5Zjk1LTczZDktNDQ2MC1hNjY4LTA0NzE2MmZmMWJhZDpmMWJmMGI1MC0yMDUyLTQ3ZmUtYjg3ZC01MTFjMmZlNzQ3MWI= nodes: - nodeId: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT05ORUNUT1IvMmMzYzlmOTUtNzNkOS00NDYwLWE2NjgtMDQ3MTYyZmYxYmFkOjE1NmRmNzg5Yzg1NTRkNTVhMjc1ZGY5OTc4Zjk5MDJk status: Dispatched - nodeId: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT05ORUNUT1IvMmMzYzlmOWUtNzNkOS00NDYwLWE2NjgtMDQ3MTYyZmYxYmFjOjE1NmRmNzg5Yzg1NTRkNTVhMjc1ZGU5OTc4Zjk5MDJl status: Dispatched '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Get Triggered test status operationId: Get Triggered test status description: Returns the status of the test triggered using the Trigger on-demand test API. tags: - Video Mesh parameters: - name: commandId in: query description: The unique command ID generated from Trigger on-demand test API. required: true example: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzFlYjY1ZmRmLTk2NDMtNDE3Zi05OTc0LWFkNzJjYWUwZTEwZjpiMzdmNTgzYy1kZGRjLTQyOGItODJlNS1jYmU2ODFkYjQ5NjI schema: type: string /videoMesh/testResults: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/TriggeredTestResult' example: type: MediaHealthMonitorTest commandId: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT01NQU5EX0lELzJjM2M5ZjllLTczZDktNDQ2MC1hNjY4LTA0NzE2MmZmMWJhYzo2NTJmNmMxMC01NjgxLTExZWQtOTkyZS1kNTY5YzlkMDlhNzU orgId: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8yYzNjOWY5NS03M2Q5LTQ0NjAtYTY2OC0wNDcxNjJmZjFiYWQ= results: - clusters: - clusterId: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzJjM2M5Zjk1LTczZDktNDQ2MC1hNjY4LTA0NzE2MmZmMWJhZDpmMWJmMGI1MC0yMDUyLTQ3ZmUtYjg3ZC01MTFjMmZlNzQ3MWI= clusterName: test_manual 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:1003]. If the issue persists, please contact Cisco Support. - testName: SIP Signalling testResult: Success '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Get Triggered test results operationId: Get Triggered test results description: 'Returns the results of the test triggered using the command ID.
NOTE: The response format depends on the type of test triggered and it is the same as that of [NetworkTest API](/docs/api/v1/video-mesh/list-network-test-results), [MediaHealthMonitorTest API](/docs/api/v1/video-mesh/list-media-health-monitoring-tool-test-results-v2), and [ReachabilityTest API](/docs/api/v1/video-mesh/list-reachability-test-results-v2) respectively.' tags: - Video Mesh parameters: - name: commandId in: query description: The unique command ID generated from Trigger on-demand test API. required: true example: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT01NQU5EX0lELzJjM2M5ZjllLTczZDktNDQ2MC1hNjY4LTA0NzE2MmZmMWJhYzo2NTJmNmMxMC01NjgxLTExZWQtOTkyZS1kNTY5YzlkMDlhNzU schema: type: string /videoMesh/testResults/networkTest: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/ConnectivityTestResultsObject' example: orgId: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8yYzNjOWY5NS03M2Q5LTQ0NjAtYTY2OC0wNDcxNjJmZjFiYWQ= from: '2023-01-15T15:53:00Z' to: '2023-01-20T15:53:00Z' items: - clusters: - clusterId: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzJjM2M5Zjk1LTczZDktNDQ2MC1hNjY4LTA0NzE2MmZmMWJhZDpmMWJmMGI1MC0yMDUyLTQ3ZmUtYjg3ZC01MTFjMmZlNzQ3MWI= clusterName: sanjose 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 - nodeId: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT05ORUNUT1IvMmMzYzlmOTUtNzNkOS00NDYwLWE2NjgtMDQ3MTYyZmYxYmFkOjE1NmRmNzg5Yzg1NTRkNTVhMjc1ZGY5OTc4Zjk5MDJk hostNameOrIP: xyz.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 - 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 '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: List Network Test results operationId: List Network Test results description: 'Returns the test results of the Network tests triggered for an organization. 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.
' tags: - Video Mesh parameters: - name: orgId in: query description: Unique ID of the organization. required: true example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8yYzNjOWY5NS03M2Q5LTQ0NjAtYTY2OC0wNDcxNjJmZjFiYWQ= schema: type: string - name: triggerType in: query description: Trigger type. required: true example: OnDemand schema: type: string enum: - OnDemand - Periodic - All - name: from in: query description: 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`. required: true example: '2023-01-15T15:53:00Z' schema: type: string - name: to in: query description: The end date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. required: true example: '2023-01-20T15:53:00Z' schema: type: string /videoMesh/testResults/networkTest/clusters: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/ConnectivityTestResultsClustersObject' 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 '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Get Network Test results for cluster operationId: Get Network Test results for cluster description: 'Returns the test results of the Network tests triggered for a single Video Mesh cluster. 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.
' tags: - Video Mesh parameters: - name: clusterId in: query description: Unique ID of the Video Mesh cluster. required: true example: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzJjM2M5Zjk1LTczZDktNDQ2MC1hNjY4LTA0NzE2MmZmMWJhZDpmMWJmMGI1MC0yMDUyLTQ3ZmUtYjg3ZC01MTFjMmZlNzQ3MWI= schema: type: string - name: triggerType in: query description: Trigger type. required: true example: OnDemand schema: type: string enum: - OnDemand - Periodic - All - name: from in: query description: 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`. required: true example: '2023-01-15T15:53:00Z' schema: type: string - name: to in: query description: The end date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. required: true example: '2023-01-20T15:53:00Z' schema: type: string /videoMesh/testResults/networkTest/nodes: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/ConnectivityTestResultsNodesObject' example: 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 '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Get Network Test results for node operationId: Get Network Test results for node description: '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.
' tags: - Video Mesh parameters: - name: nodeId in: query description: Unique ID of the Video Mesh node. required: true example: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT05ORUNUT1IvMmMzYzlmOTUtNzNkOS00NDYwLWE2NjgtMDQ3MTYyZmYxYmFkOjE1NmRmNzg5Yzg1NTRkNTVhMjc1ZGY5OTc4Zjk5MDJk schema: type: string - name: triggerType in: query description: Trigger type. required: true example: OnDemand schema: type: string enum: - OnDemand - Periodic - All - name: from in: query description: 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`. required: true example: '2023-01-15T15:53:00Z' schema: type: string - name: to in: query description: The end date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. required: true example: '2023-01-20T15:53:00Z' schema: type: string /videoMesh/clientTypeDistribution: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/ClienttypedistributionforOrg' example: items: - orgId: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8zNmQ4OTRmNy0yYjU3LTQzYzEtYWNlZS1kNDdlNjc3NjE0MTQ from: '2022-03-23T10:22:03Z' to: '2022-03-24T10:22:03Z' aggregationInterval: 10m items: - timestamp: '2022-03-23T10:30:00Z' clusters: - clusterId: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzM2ZDg5NGY3LTJiNTctNDNjMS1hY2VlLWQ0N2U2Nzc2MTQxNDo1ODJhMWFlYy03YTMwLTQ2MDItYTI2NS02YTE5NDcwOWZkOTg clusterName: Bangalore clientTypeDistributionDetails: - deviceType: sipEndpoint description: SIP Devices count: 10 - deviceType: webexAppVdi description: Webex App VDI count: 78 - clusterId: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzM2ZDg5NGY3LTJiNTctNDNjMS1hY2VlLWQ0N2U2Nzc2MTQxNDo1ODJhMWFlYy03YTMwLTQ2MDItYTI2NS02YTE5NDcwOTEyMzQ= clusterName: San Jose clientTypeDistributionDetails: - deviceType: webexForDesktop description: Webex App Desktop count: 26 - timestamp: '2022-03-23T10:40:00Z' clusters: - clusterId: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzM2ZDg5NGY3LTJiNTctNDNjMS1hY2VlLWQ0N2U2Nzc2MTQxNDo1ODJhMWFlYy03YTMwLTQ2MDItYTI2NS02YTE5NDcwOWZkOTg clusterName: Bangalore clientTypeDistributionDetails: - deviceType: webexForMobile description: Webex App Mobile count: 4 - clusterId: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzM2ZDg5NGY3LTJiNTctNDNjMS1hY2VlLWQ0N2U2Nzc2MTQxNDo1ODJhMWFlYy03YTMwLTQ2MDItYTI2NS02YTE5NDcwOTEyMzQ= clusterName: San Jose clientTypeDistributionDetails: - deviceType: webexDevices description: Webex Devices count: 47 '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: List Cluster Client Type Distribution details operationId: List Cluster Client Type Distribution details description: Returns the client type distribution details for all Video Mesh clusters in an organization. tags: - Video Mesh parameters: - name: orgId in: query description: Unique ID of the organization. required: true example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8yYzNjOWY5NS03M2Q5LTQ0NjAtYTY2OC0wNDcxNjJmZjFiYWQ= schema: type: string - name: from in: query description: 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`. required: true example: '2023-01-15T15:53:00Z' schema: type: string - name: to in: query description: The end date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. required: true example: '2023-01-20T15:53:00Z' schema: type: string - name: deviceType in: query description: "Device type(s).\n\n- Possible values:\n `webexDevices` `webexAppVdi` `webexForMobile` `sipEndpoint` `webexForDesktop`" required: true example: webexDevices,webexAppVdi schema: type: string /videoMesh/clientTypeDistribution/clusters: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/ClientTypeDistributionForCluster' example: items: - orgId: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8zNmQ4OTRmNy0yYjU3LTQzYzEtYWNlZS1kNDdlNjc3NjE0MTQ from: '2022-03-23T10:22:03Z' to: '2022-03-24T10:22:03Z' aggregationInterval: 10m items: - timestamp: '2022-03-23T10:30:00Z' clusters: - clusterId: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzM2ZDg5NGY3LTJiNTctNDNjMS1hY2VlLWQ0N2U2Nzc2MTQxNDo1ODJhMWFlYy03YTMwLTQ2MDItYTI2NS02YTE5NDcwOWZkOTg clusterName: Bangalore clientTypeDistributionDetails: - deviceType: sipEndpoint description: SIP Devices count: 10 - deviceType: webexAppVdi description: Webex App VDI count: 78 - timestamp: '2022-03-23T10:40:00Z' clusters: - clusterId: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzM2ZDg5NGY3LTJiNTctNDNjMS1hY2VlLWQ0N2U2Nzc2MTQxNDo1ODJhMWFlYy03YTMwLTQ2MDItYTI2NS02YTE5NDcwOWZkOTg clusterName: Bangalore clientTypeDistributionDetails: - deviceType: webexForMobile description: Webex App Mobile count: 4 '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Get Cluster Client Type Distribution details operationId: Get Cluster Client Type Distribution details description: Returns the client type distribution details for a single Video Mesh cluster. tags: - Video Mesh parameters: - name: clusterId in: query description: Unique ID of the Video Mesh cluster. required: true example: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzJjM2M5Zjk1LTczZDktNDQ2MC1hNjY4LTA0NzE2MmZmMWJhZDpmMWJmMGI1MC0yMDUyLTQ3ZmUtYjg3ZC01MTFjMmZlNzQ3MWI= schema: type: string - name: from in: query description: 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`. required: true example: '2023-01-15T15:53:00Z' schema: type: string - name: to in: query description: The end date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. required: true example: '2023-01-20T15:53:00Z' schema: type: string - name: deviceType in: query description: "Device type(s).\n\n- Possible values:\n `webexDevices` `webexAppVdi` `webexForMobile` `sipEndpoint` `webexForDesktop`" required: true example: webexDevices,webexAppVdi schema: type: string /videoMesh/eventThresholds: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/ListEventThresholdResponse' example: orgId: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8yYzNjOWY5NS03M2Q5LTQ0NjAtYTY2OC0wNDcxNjJmZjFiYWQ eventThresholds: - eventName: clusterCallsRedirected eventThresholdId: Y2lzY29zcGFyazovL3VzL0VWRU5ULzQyN2U5ZTk2LTczYTctNDYwYS04MGZhLTcyNWU4MWE2MDg3Zjo2YzJhZGRmMS0wYjAzLTRiZWEtYjIxYy0xYzFjYzdiY2UwOWQ eventScope: CLUSTER entityId: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzRiNTk5NzkwLWVlMzctMTFlZC1hMDViLTAyNDJhYzEyMDAwMzo2NjMxOTMyNC1lZTM3LTExZWQtYTA1Yi0wMjQyYWMxMjAwMDM thresholdConfig: minThreshold: 10 defaultMinThreshold: 10 - eventName: orgCallsOverflowed eventThresholdId: Y2lzY29zcGFyazovL3VzL0VWRU5ULzQyN2U5ZTk2LTczYTctNDYwYS04MGZhLTcyNWU4MWE2MDg3ZjowM2ZkYjkzZC1jNTllLTQzMjQtODIwNS1lNDIyYzA3NGQ5Mzg eventScope: ORG entityId: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8yYzNjOWY5NS03M2Q5LTQ0NjAtYTY2OC0wNDcxNjJmZjFiYWQ thresholdConfig: minThreshold: 10 defaultMinThreshold: 10 '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: List Event Threshold Configuration operationId: List Event Threshold Configuration description: Returns the event threshold configurations for `orgId` or `clusterId`, with optional filters `eventName` and `eventScope`. tags: - Video Mesh parameters: - name: eventName in: query description: Event name to fetch threshold details. example: clusterCallsRedirected schema: type: string enum: - clusterCallsRedirected - orgCallsOverflowed - name: clusterId in: query description: Unique ID of the Video Mesh Cluster. example: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzJjM2M5Zjk1LTczZDktNDQ2MC1hNjY4LTA0NzE2MmZmMWJhZDpmMWJmMGI1MC0yMDUyLTQ3ZmUtYjg3ZC01MTFjMmZlNzQ3MWI schema: type: string - name: orgId in: query description: Unique ID of the Organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8yYzNjOWY5NS03M2Q5LTQ0NjAtYTY2OC0wNDcxNjJmZjFiYWQ schema: type: string - name: eventScope in: query description: Scope name to filter events. example: CLUSTER schema: type: string enum: - CLUSTER - ORG patch: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/BulkUpdateEventThresholdResponse' example: orgId: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8yYzNjOWY5NS03M2Q5LTQ0NjAtYTY2OC0wNDcxNjJmZjFiYWQ eventThresholds: - eventName: clusterCallsRedirected eventThresholdId: Y2lzY29zcGFyazovL3VzL0VWRU5ULzQyN2U5ZTk2LTczYTctNDYwYS04MGZhLTcyNWU4MWE2MDg3Zjo2YzJhZGRmMS0wYjAzLTRiZWEtYjIxYy0xYzFjYzdiY2UwOWQ eventScope: CLUSTER entityId: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzRiNTk5NzkwLWVlMzctMTFlZC1hMDViLTAyNDJhYzEyMDAwMzo2NjMxOTMyNC1lZTM3LTExZWQtYTA1Yi0wMjQyYWMxMjAwMDM thresholdConfig: minThreshold: 40 defaultMinThreshold: 10 failedEventThresholdIds: - Y2lzY29zcGFyazovL3VzL0VWRU5ULzQyN2U5ZTk2LTczYTctNDYwYS04MGZhLTcyNWU4MWE2MDg3ZjowM2ZkYjkzZC1jNTllLTQzMjQtODIwNS1lNDIyYzA3NGQ5Mzg '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Update Event Threshold Configuration operationId: Update Event Threshold Configuration description: Updates an existing event threshold configuration for given Event Threshold IDs. tags: - Video Mesh parameters: [] requestBody: content: application/json: example: - eventThresholdId: Y2lzY29zcGFyazovL3VzL0VWRU5ULzQyN2U5ZTk2LTczYTctNDYwYS04MGZhLTcyNWU4MWE2MDg3Zjo2YzJhZGRmMS0wYjAzLTRiZWEtYjIxYy0xYzFjYzdiY2UwOWQ thresholdConfig: minThreshold: 40 - eventThresholdId: Y2lzY29zcGFyazovL3VzL0VWRU5ULzQyN2U5ZTk2LTczYTctNDYwYS04MGZhLTcyNWU4MWE2MDg3ZjowM2ZkYjkzZC1jNTllLTQzMjQtODIwNS1lNDIyYzA3NGQ5Mzg thresholdConfig: minThreshold: 60 schema: type: object required: - eventThresholds properties: eventThresholds: type: array items: type: object required: - eventThresholdId - thresholdConfig properties: eventThresholdId: type: string thresholdConfig: type: object required: - minThreshold properties: minThreshold: type: number /videoMesh/eventThresholds/{eventThresholdId}: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/GetEventThresholdResponse' example: orgId: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8yYzNjOWY5NS03M2Q5LTQ0NjAtYTY2OC0wNDcxNjJmZjFiYWQ eventThresholds: - eventName: clusterCallsRedirected eventThresholdId: Y2lzY29zcGFyazovL3VzL0VWRU5ULzQyN2U5ZTk2LTczYTctNDYwYS04MGZhLTcyNWU4MWE2MDg3Zjo2YzJhZGRmMS0wYjAzLTRiZWEtYjIxYy0xYzFjYzdiY2UwOWQ eventScope: CLUSTER entityId: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzRiNTk5NzkwLWVlMzctMTFlZC1hMDViLTAyNDJhYzEyMDAwMzo2NjMxOTMyNC1lZTM3LTExZWQtYTA1Yi0wMjQyYWMxMjAwMDM thresholdConfig: minThreshold: 10 defaultMinThreshold: 10 '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Get Event Threshold Configuration operationId: Get Event Threshold Configuration description: Returns the event threshold configurations for `eventThresholdId`. tags: - Video Mesh parameters: - name: eventThresholdId in: path description: Unique ID of the event threshold configuration. required: true example: Y2lzY29zcGFyazovL3VzL0VWRU5ULzQyN2U5ZTk2LTczYTctNDYwYS04MGZhLTcyNWU4MWE2MDg3Zjo2YzJhZGRmMS0wYjAzLTRiZWEtYjIxYy0xYzFjYzdiY2UwOWQ schema: type: string /videoMesh/eventThresholds/reset: post: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/ResetEventThresholdResponse' example: orgId: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8yYzNjOWY5NS03M2Q5LTQ0NjAtYTY2OC0wNDcxNjJmZjFiYWQ eventThresholds: - eventName: clusterCallsRedirected eventThresholdId: Y2lzY29zcGFyazovL3VzL0VWRU5ULzQyN2U5ZTk2LTczYTctNDYwYS04MGZhLTcyNWU4MWE2MDg3Zjo2YzJhZGRmMS0wYjAzLTRiZWEtYjIxYy0xYzFjYzdiY2UwOWQ eventScope: CLUSTER entityId: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzRiNTk5NzkwLWVlMzctMTFlZC1hMDViLTAyNDJhYzEyMDAwMzo2NjMxOTMyNC1lZTM3LTExZWQtYTA1Yi0wMjQyYWMxMjAwMDM thresholdConfig: minThreshold: 10 defaultMinThreshold: 10 failedEventThresholdIds: - Y2lzY29zcGFyazovL3VzL0VWRU5ULzQyN2U5ZTk2LTczYTctNDYwYS04MGZhLTcyNWU4MWE2MDg3ZjowM2ZkYjkzZC1jNTllLTQzMjQtODIwNS1lNDIyYzA3NGQ5Mzg '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Reset Event Threshold Configuration operationId: Reset Event Threshold Configuration description: Resets the existing event threshold configuration for given Event Threshold IDs to default value. To stop receiving webhook events, use the [Webhooks API](docs/api/v1/webhooks) to delete the webhook in question. tags: - Video Mesh parameters: [] requestBody: content: application/json: example: - Y2lzY29zcGFyazovL3VzL0VWRU5ULzQyN2U5ZTk2LTczYTctNDYwYS04MGZhLTcyNWU4MWE2MDg3Zjo2YzJhZGRmMS0wYjAzLTRiZWEtYjIxYy0xYzFjYzdiY2UwOWQ - Y2lzY29zcGFyazovL3VzL0VWRU5ULzQyN2U5ZTk2LTczYTctNDYwYS04MGZhLTcyNWU4MWE2MDg3ZjowM2ZkYjkzZC1jNTllLTQzMjQtODIwNS1lNDIyYzA3NGQ5Mzg schema: type: object required: - eventThresholdIds properties: eventThresholdIds: type: array items: type: string example: Y2lzY29zcGFyazovL3VzL0VWRU5ULzQyN2U5ZTk2LTczYTctNDYwYS04MGZhLTcyNWU4MWE2MDg3Zjo2YzJhZGRmMS0wYjAzLTRiZWEtYjIxYy0xYzFjYzdiY2UwOWQ components: schemas: UtilizationForClusterTrend2: type: object properties: timestamp: type: string example: '2022-03-23T10:40:00Z' description: Timestamp. clusters: type: array items: $ref: '#/components/schemas/ClusterUtilizationT2Blr' ClusterRedirectBlr2: type: object properties: clusterId: type: string example: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzM2ZDg5NGY3LTJiNTctNDNjMS1hY2VlLWQ0N2U2Nzc2MTQxNDo1ODJhMWFlYy03YTMwLTQ2MDItYTI2NS02YTE5NDcwOWZkOTg description: ID of the Video Mesh cluster. clusterName: type: string example: bangalore description: Name of the Video Mesh cluster. redirectDetails: type: array items: $ref: '#/components/schemas/ClusterRedirectDetailsBlr2' description: Call Redirect Details. ClientTypeDistributionCollectionForCluster: type: object properties: orgId: type: string example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8zNmQ4OTRmNy0yYjU3LTQzYzEtYWNlZS1kNDdlNjc3NjE0MTQ description: The unique ID for the organization. from: type: string example: '2022-03-23T10:22:03Z' description: Start date and time (inclusive) for the Client Type Distribution details. to: type: string example: '2022-03-24T10:22:03Z' description: End date and time (inclusive) of the Client Type Distribution details. aggregationInterval: type: string example: 10m description: The aggregation period of the trend data. items: type: array items: anyOf: - $ref: '#/components/schemas/ClientTypeDistributionTrendForCluster1' - $ref: '#/components/schemas/ClientTypeDistributionTrendForCluster2' description: Client Type Distribution details for the organization. DNSResolutionTest: type: object properties: type: type: string example: DNSResolutionTest description: The type of test result. results: type: array items: anyOf: - $ref: '#/components/schemas/ServiceTypeResult1' - $ref: '#/components/schemas/ServiceTypeResult2' description: Test Results from different services. NodeAvailableTimeline: type: object properties: noOfOnlineNodes: type: number example: 1 description: Number of nodes that are online. noOfOfflineNodes: type: number description: Number of nodes that are offline. segmentStartTime: type: string example: '2021-09-15T15:53:00Z' description: Start date and time of the segment of availability data. segmentEndTime: type: string example: '2021-09-15T16:53:00Z' description: End date and time of the segment of availability data. availability: type: string example: Available description: Availability information of the Video Mesh node. unAvailabilityReason: type: string example: NA description: Reason for the Video Mesh node being unavailable (if any). totalNodes: type: number example: 1 description: Total number of nodes in the Video Mesh cluster. NodesAvailability: type: object properties: items: type: array items: $ref: '#/components/schemas/NodeAvailabilityCollection' ReachabilityTestResultsStunresults1: type: object properties: timestamp: type: string example: '2022-03-15T15:53:00Z' description: The timestamp of the test run. triggerType: type: string example: OnDemand description: The type of the test being executed. Can be either `OnDemand` or `Periodic`. id: type: string example: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT01NQU5EX0lELzJjM2M5ZjllLTczZDktNDQ2MC1hNjY4LTA0NzE2MmZmMWJhYzo2NTJmNmMxMC01NjgxLTExZWQtOTkyZS1kNTY5YzlkMDlhNzU description: Unique ID of the test. udp: type: array items: anyOf: - $ref: '#/components/schemas/ReachabilityTestresultsFailure' - $ref: '#/components/schemas/ReachabilityTestresultsSuccess' description: List of UDP ports being checked in Reachability test. tcp: type: array items: anyOf: - $ref: '#/components/schemas/ReachabilityTestresultsFailure' - $ref: '#/components/schemas/ReachabilityTestresultsSuccess' description: List of TCP ports being checked in Reachability test. PerNodeConnectivityResult1: type: object properties: nodeId: type: string example: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT05ORUNUT1IvMmMzYzlmOTUtNzNkOS00NDYwLWE2NjgtMDQ3MTYyZmYxYmFkOjE1NmRmNzg5Yzg1NTRkNTVhMjc1ZGY5OTc4Zjk5MDJk description: Unique ID of the Video Mesh node. hostNameOrIP: type: string example: abc.company.com description: Host name or IP Address of the Video Mesh node. testResults: type: array items: $ref: '#/components/schemas/ConnectivityTestResultsForNode' RedirectCollectionForCluster: type: object properties: orgId: type: string example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8zNmQ4OTRmNy0yYjU3LTQzYzEtYWNlZS1kNDdlNjc3NjE0MTQ description: The unique ID for the organization. from: type: string example: '2022-03-23T10:22:03Z' description: Start date and time (inclusive) for the Call Redirect details. to: type: string example: '2022-03-24T10:22:03Z' description: End date and time (inclusive) of the Call Redirect details. aggregationInterval: type: string example: 10m description: The aggregation period of the trend data. items: type: array items: anyOf: - $ref: '#/components/schemas/RedirectTrendForCluster1' - $ref: '#/components/schemas/RedirectTrendForCluster2' description: Redirect details for the organization. ReachabilityTestResultsforfirstcluster: type: object properties: clusterId: type: string example: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzJjM2M5Zjk1LTczZDktNDQ2MC1hNjY4LTA0NzE2MmZmMWJhZDpmMWJmMGI1MC0yMDUyLTQ3ZmUtYjg3ZC01MTFjMmZlNzQ3MWI= description: Unique ID of the Video Mesh cluster. clusterName: type: string example: banglore description: Name of the Video Mesh cluster. nodes: type: array items: anyOf: - $ref: '#/components/schemas/ReachabilityTestresultsfirstnode' - $ref: '#/components/schemas/ReachabilityTestresultssecondnode' description: The Video Mesh nodes in the cluster. OverflowDetails3: type: object properties: overflowReason: type: string example: Capacity exceeded description: The reason for this overflow. overflowCount: type: number example: 38 description: Number of overflows. possibleRemediation: type: string example: Video Mesh exceeded its capacity. If this happens frequently, consider adding more nodes to your clusters. description: Any possible remediations for this overflow. MediaHealthMonitoringforfirstcluster: type: object properties: clusterId: type: string example: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzJjM2M5Zjk1LTczZDktNDQ2MC1hNjY4LTA0NzE2MmZmMWJhZDpmMWJmMGI1MC0yMDUyLTQ3ZmUtYjg3ZC01MTFjMmZlNzQ3MWI= description: Unique ID of the Video Mesh cluster. clusterName: type: string example: banglore description: Name of the Video Mesh cluster. nodes: type: array items: anyOf: - $ref: '#/components/schemas/MediaHealthMonitoringsecondnode' - $ref: '#/components/schemas/MediaHealthMonitoringfirstnode' description: The Video Mesh nodes in the cluster. ReachabilityTestResultsforcluster: type: object properties: clusters: type: array items: anyOf: - $ref: '#/components/schemas/ReachabilityTestResultsforfirstcluster' - $ref: '#/components/schemas/ReachabilityTestResultsforsecondcluster' description: List of Video Mesh clusters. FailureDetails2: type: object properties: possibleFailureReason: type: array items: type: string example: 'Connectivity issue detected between the Video Mesh Node and the Webex Cloud [Error Code: 1106].' description: Possible reasons for failure for the test. possibleRemediation: type: array items: type: string example: One or more Webex cloud services may not be responding. Retry the test after some time. If the issue persists, please contact Cisco Support. description: Possible fixes for the failures mentioned above. ResetEventThresholdResponse: type: object properties: orgId: type: string example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8yYzNjOWY5NS03M2Q5LTQ0NjAtYTY2OC0wNDcxNjJmZjFiYWQ description: Unique ID of the organization. eventThresholds: type: array items: $ref: '#/components/schemas/GetEntityThresholdConfig1' description: List of successful updated responses. failedEventThresholdIds: type: array items: type: string example: Y2lzY29zcGFyazovL3VzL0VWRU5ULzQyN2U5ZTk2LTczYTctNDYwYS04MGZhLTcyNWU4MWE2MDg3ZjowM2ZkYjkzZC1jNTllLTQzMjQtODIwNS1lNDIyYzA3NGQ5Mzg description: List of failed or invalid event threshold IDs. ClientTypeDistributionTrend2: type: object properties: timestamp: type: string example: '2022-03-23T10:40:00Z' description: Timestamp. clusters: type: array items: anyOf: - $ref: '#/components/schemas/ClusterClientTypeDistributionBlr2' - $ref: '#/components/schemas/ClusterClientTypeDistributionSJ2' SIPSignallingtestResultFailure: type: object properties: testName: type: string example: SIP Signalling description: The name of the test. testResult: type: string example: Failed description: Test results(Success/Failed). failureReason: type: string example: An internal error occurred in monitoring tool [Error Code:1002]. If the issue persists, please contact Cisco Support. description: Reason for test failure. OverflowDetails1: type: object properties: overflowReason: type: string example: Capacity exceeded description: The reason for this overflow. overflowCount: type: number example: 25 description: Number of overflows. possibleRemediation: type: string example: Video Mesh exceeded its capacity. If this happens frequently, consider adding more nodes to your clusters. description: Any possible remediations for this overflow. ClusterRedirectDetailsSJ2: type: object properties: redirectReason: type: string example: Connectivity issues description: The reason for the redirect. redirectCount: type: number example: 47 description: Number of Call Redirects. possibleRemediation: type: string example: Connectivity Issues between Video Mesh Node and Cloud. Check your network configuration. description: Any possible remediations for this overflow. ClusterRedirectDetailsBlr2: type: object properties: redirectReason: type: string example: Node upgrading description: The reason for the redirect. redirectCount: type: number example: 4 description: Number of Call Redirects. possibleRemediation: type: string example: Video Mesh Node is being upgraded. Please wait for upgrades to finish. description: Any possible remediations for this overflow. ClusterClientTypeDistributionDetailsBlr2: type: object properties: deviceType: type: string example: webexForMobile description: The type of device. description: type: string example: Webex App Mobile description: The description of the device type. count: type: number example: 4 description: The count of the device type. MediaHealthMonitoringTestResultsFailure: type: object properties: timestamp: type: string example: '2022-03-15T15:53:00Z' description: The timestamp of the test run. id: type: string example: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT01NQU5EX0lELzJjM2M5ZjllLTczZDktNDQ2MC1hNjY4LTA0NzE2MmZmMWJhYzo2NTJmNmMxMC01NjgxLTExZWQtOTkyZS1kNTY5YzlkMDlhNzU description: Unique ID of the test. testResults: type: array items: anyOf: - $ref: '#/components/schemas/MediaSignallingtestResultFailure' - $ref: '#/components/schemas/MediaCascadetestResultFailure' - $ref: '#/components/schemas/SIPSignallingtestResultFailure' description: Test results of Media Signalling, SIP Signalling, Media Cascade runs. ClusterRedirectSJ1: type: object properties: clusterId: type: string example: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzM2ZDg5NGY3LTJiNTctNDNjMS1hY2VlLWQ0N2U2Nzc2MTQxNDo1ODJhMWFlYy03YTMwLTQ2MDItYTI2NS02YTE5NDcwOTEyMzQ= description: ID of the Video Mesh cluster. clusterName: type: string example: sanjose description: Name of the Video Mesh cluster. redirectDetails: type: array items: $ref: '#/components/schemas/ClusterRedirectDetailsSJ1' description: Call Redirect Details. MediaCascadetestResultFailure: type: object properties: testName: type: string example: Media Cascade description: The name of the test. testResult: type: string example: Failed description: Test results(Success/Failed). failureReason: type: string example: An internal error occurred in monitoring tool [Error Code:1004]. If the issue persists, please contact Cisco Support. description: Reason for test failure. UtilizationForClusterTrend1: type: object properties: timestamp: type: string example: '2022-03-23T10:30:00Z' description: Timestamp. clusters: type: array items: $ref: '#/components/schemas/ClusterUtilizationT1Blr' ServiceTypeResult2: type: object properties: serviceType: type: string example: ThirdPartyCloud description: Service for which the test was executed. testResult: type: string example: Success description: Result of the test executed. ReachabilityTestResultsforoneclusteronenode: type: object properties: clusters: type: array items: $ref: '#/components/schemas/ReachabilityTestResultsforonecluster' description: List of Video Mesh clusters. ClusterUtilizationTrend2: type: object properties: timestamp: type: string example: '2022-03-23T10:40:00Z' description: Timestamp. clusters: type: array items: anyOf: - $ref: '#/components/schemas/ClusterUtilizationT2SJ' - $ref: '#/components/schemas/ClusterUtilizationT2Blr' BulkUpdateEventThresholdResponse: type: object properties: orgId: type: string example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8yYzNjOWY5NS03M2Q5LTQ0NjAtYTY2OC0wNDcxNjJmZjFiYWQ description: Unique ID of the organization. eventThresholds: type: array items: $ref: '#/components/schemas/UpdateEventThresholdResponse1' description: List of successful updated response failedEventThresholdIds: type: array items: type: string example: Y2lzY29zcGFyazovL3VzL0VWRU5ULzQyN2U5ZTk2LTczYTctNDYwYS04MGZhLTcyNWU4MWE2MDg3ZjowM2ZkYjkzZC1jNTllLTQzMjQtODIwNS1lNDIyYzA3NGQ5Mzg description: List of failed or invalid event threshold IDs. ClusterAvailability: type: object properties: clusterId: type: string example: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzFlYjY1ZmRmLTk2NDMtNDE3Zi05OTc0LWFkNzJjYWUwZTEwZjpiMzdmNTgzYy1kZGRjLTQyOGItODJlNS1jYmU2ODFkYjQ5NjI= description: ID of the Video Mesh cluster. clusterName: type: string example: San Jose description: Name of the Video Mesh cluster. availabilitySegments: type: array items: anyOf: - $ref: '#/components/schemas/ClusterAvailableTimeline' - $ref: '#/components/schemas/ClusterUnAvailableTimeline' ClusterUtilizationT2Blr: type: object properties: clusterId: type: string example: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzM2ZDg5NGY3LTJiNTctNDNjMS1hY2VlLWQ0N2U2Nzc2MTQxNDo1ODJhMWFlYy03YTMwLTQ2MDItYTI2NS02YTE5NDcwOWZkOTg= description: ID of the Video Mesh cluster. clusterName: type: string example: bangalore description: Name of the Video Mesh cluster. utilizationMetrics: $ref: '#/components/schemas/UtilizationMetricsT2Blr' description: Utilization Metric details for the cluster in the time interval. ClusterClientTypeDistributionSJ2: type: object properties: clusterId: type: string example: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzM2ZDg5NGY3LTJiNTctNDNjMS1hY2VlLWQ0N2U2Nzc2MTQxNDo1ODJhMWFlYy03YTMwLTQ2MDItYTI2NS02YTE5NDcwOTEyMzQ= description: ID of the Video Mesh cluster. clusterName: type: string example: San Jose description: Name of the Video Mesh cluster. clientTypeDistributionDetails: type: array items: $ref: '#/components/schemas/ClusterClientTypeDistributionDetailsSJ2' description: Client Type Distribution Details. RedirectTrendForCluster1: type: object properties: timestamp: type: string example: '2022-03-23T10:30:00Z' description: Timestamp. clusters: type: array items: $ref: '#/components/schemas/ClusterRedirectBlr1' MediaSignallingtestResultSuccess: type: object properties: testName: type: string example: Media Signalling description: The name of the test. testResult: type: string example: Success description: The result, either `Success` or `Failed`. MediaHealthMonitoringclusters: type: object properties: clusters: type: array items: anyOf: - $ref: '#/components/schemas/MediaHealthMonitoringforfirstcluster' - $ref: '#/components/schemas/MediaHealthMonitoringforsecondcluster' description: The list of Video Mesh clusters. MediaHealthMonitoringTestResultsSuccess: type: object properties: timestamp: type: string example: '2022-03-15T15:53:00Z' description: The timestamp of the test run. id: type: string example: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT01NQU5EX0lELzJjM2M5ZjllLTczZDktNDQ2MC1hNjY4LTA0NzE2MmZmMWJhYzo2NTJmNmMxMC01NjgxLTExZWQtOTkyZS1kNTY5YzlkMDlhNzU description: Unique ID of the test. testResults: type: array items: anyOf: - $ref: '#/components/schemas/MediaSignallingtestResultSuccess' - $ref: '#/components/schemas/MediaCascadetestResultSuccess' - $ref: '#/components/schemas/SIPSignallingtestResultSuccess' description: Test results of Media Signalling, SIP Signalling, Media Cascade runs. ClusterUnAvailableTimeline: type: object properties: segmentStartTime: type: string example: '2021-09-15T16:53:00Z' description: Start date and time of the segment of availability data. segmentEndTime: type: string example: '2021-09-15T17:53:00Z' description: End date and time of the segment of availability data. availability: type: string example: Unavailable description: Availability information of the Video Mesh cluster. noOfOnlineNodes: type: number description: Number of nodes that are online. noOfOfflineNodes: type: number example: 2 description: Number of nodes that are offline. totalNodes: type: number example: 2 description: Total number of nodes in the Video Mesh cluster. MHMTestResult3: type: object properties: testName: type: string example: SIP Signalling testResult: type: string example: Success Results: type: object properties: clusterId: type: string example: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzJjM2M5Zjk1LTczZDktNDQ2MC1hNjY4LTA0NzE2MmZmMWJhZDpmMWJmMGI1MC0yMDUyLTQ3ZmUtYjg3ZC01MTFjMmZlNzQ3MWI= description: Unique ID of the Video Mesh cluster. clusterName: type: string example: test_manual description: Name of the Video Mesh cluster. nodes: type: array items: $ref: '#/components/schemas/NodesResult' NodeAvailability: type: object properties: clusterId: type: string example: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzFlYjY1ZmRmLTk2NDMtNDE3Zi05OTc0LWFkNzJjYWUwZTEwZjpiMzdmNTgzYy1kZGRjLTQyOGItODJlNS1jYmU2ODFkYjQ5NjI= description: ID of the Video Mesh cluster. clusterName: type: string example: San Jose description: Name of the Video Mesh cluster. hostNameOrIp: type: string example: xyz.abc.com description: Host Name or the IP of the Video Mesh node. nodeId: type: string example: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT05ORUNUT1IvMWViNjVmZGYtOTY0My00MTdmLTk5NzQtYWQ3MmNhZTBlMTBmOmMyNTk0YmY2NDFmZTRkNTFiZDg3YThiMjYxYzg3NWY1 description: ID of the Video Mesh node. availabilitySegments: type: array items: anyOf: - $ref: '#/components/schemas/NodeAvailableTimeline' - $ref: '#/components/schemas/NodeUnAvailableTimeline' MediaCascadetestResultSuccess: type: object properties: testName: type: string example: Media Cascade description: The name of the test. testResult: type: string example: Success description: The result, either `Success` or `Failed`. CloudOverflowTrend1: type: object properties: timestamp: type: string example: '2022-03-23T10:30:00Z' description: Timestamp. overflowDetails: type: array items: anyOf: - $ref: '#/components/schemas/OverflowDetails1' - $ref: '#/components/schemas/OverflowDetails2' description: Overflow Details. EventThresholdConfig1: type: object properties: minThreshold: type: number example: 10 description: Threshold value (in percentage) to trigger an event. defaultMinThreshold: type: number example: 10 description: Deafault Threshold value (in percentage) to trigger an event. ClientTypeDistributionTrendForCluster1: type: object properties: timestamp: type: string example: '2022-03-23T10:30:00Z' description: Timestamp. clusters: type: array items: $ref: '#/components/schemas/ClusterClientTypeDistributionBlr1' ReachabilityTestresultsSuccess: type: object properties: ipAddress: type: string example: 1.1.1.1 description: Destination IP address. port: type: number example: 5004 description: Port number. reachable: type: boolean example: true description: Port reachability information. RedirectForCluster: type: object properties: items: type: array items: $ref: '#/components/schemas/RedirectCollectionForCluster' PernodeMediaHealthMonitoringresult: type: object properties: clusterId: type: string example: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzJjM2M5Zjk1LTczZDktNDQ2MC1hNjY4LTA0NzE2MmZmMWJhZDpmMWJmMGI1MC0yMDUyLTQ3ZmUtYjg3ZC01MTFjMmZlNzQ3MWI= description: Unique ID of the Video Mesh cluster. clusterName: type: string example: sanjose description: Name of the Video Mesh cluster. nodes: type: array items: $ref: '#/components/schemas/MediaHealthMonitoringfirstnode' description: The Video Mesh nodes in the cluster. MediaHealthMonitoringResultsCollectionfororganization: type: object properties: orgId: type: string example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8yYzNjOWY5NS03M2Q5LTQ0NjAtYTY2OC0wNDcxNjJmZjFiYWQ= description: Unique ID of the organization. from: type: string example: '2023-01-15T15:53:00Z' description: Start date and time (inclusive) of the Media Health Monitoring Tool data. to: type: string example: '2023-01-20T15:53:00Z' description: End date and time (inclusive) of the Media Health Monitoring Tool data. items: type: array items: $ref: '#/components/schemas/MediaHealthMonitoringclusters' description: Media Health Monitoring Tool test results. GetEntityThresholdConfig1: type: object properties: eventName: type: string example: clusterCallsRedirected description: Name of the event. eventThresholdId: type: string example: Y2lzY29zcGFyazovL3VzL0VWRU5ULzQyN2U5ZTk2LTczYTctNDYwYS04MGZhLTcyNWU4MWE2MDg3Zjo2YzJhZGRmMS0wYjAzLTRiZWEtYjIxYy0xYzFjYzdiY2UwOWQ description: Unique ID of the event threshold configuration. eventScope: type: string example: CLUSTER description: The `eventScope` is scope of event. entityId: type: string example: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzRiNTk5NzkwLWVlMzctMTFlZC1hMDViLTAyNDJhYzEyMDAwMzo2NjMxOTMyNC1lZTM3LTExZWQtYTA1Yi0wMjQyYWMxMjAwMDM description: The `entityId` is the unique ID of the Organization or the unique ID of the Video Mesh Cluster. thresholdConfig: $ref: '#/components/schemas/EventThresholdConfig1' description: Threshold configuration of an `entityId`. ClusterClientTypeDistributionDetailsBlr1b: type: object properties: deviceType: type: string example: webexAppVdi description: The type of device. description: type: string example: Webex App VDI description: The description of the device type. count: type: number example: 78 description: ' The count of the device type.' ClusterClientTypeDistributionBlr1: type: object properties: clusterId: type: string example: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzM2ZDg5NGY3LTJiNTctNDNjMS1hY2VlLWQ0N2U2Nzc2MTQxNDo1ODJhMWFlYy03YTMwLTQ2MDItYTI2NS02YTE5NDcwOWZkOTg description: ID of the Video Mesh cluster. clusterName: type: string example: Bangalore description: Name of the Video Mesh cluster. clientTypeDistributionDetails: type: array items: anyOf: - $ref: '#/components/schemas/ClusterClientTypeDistributionDetailsBlr1a' - $ref: '#/components/schemas/ClusterClientTypeDistributionDetailsBlr1b' description: Client Type Distribution Details. ClusterAvailabilityCollection: type: object properties: orgId: type: string example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8zNmQ4OTRmNy0yYjU3LTQzYzEtYWNlZS1kNDdlNjc3NjE0MTQ= description: The unique ID for the organization. items: type: array items: $ref: '#/components/schemas/ClusterAvailability' description: Availability details of the Video Mesh cluster. from: type: string example: '2021-09-15T15:53:00Z' description: Start date and time (inclusive) of the availability data. to: type: string example: '2021-09-15T17:53:00Z' description: End date and time (inclusive) of the availability data. ClusterClientTypeDistributionDetailsBlr1a: type: object properties: deviceType: type: string example: sipEndpoint description: The type of device. description: type: string example: SIP Devices description: The description of the device type. count: type: number example: 10 description: ' The count of the device type.' UtilizationMetricsT2SJ: type: object properties: peakCpu: type: number example: 73.26 description: Peak CPU usage during the time interval. avgCpu: type: number example: 13.16 description: Average CPU usage during the time interval. activeCalls: type: number example: 7 description: Maximum active calls at a point in the time interval. activePrivateCalls: type: number example: 2 description: Maximum active private calls at a point in the time interval. ClusterRedirectBlr1: type: object properties: clusterId: type: string example: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzM2ZDg5NGY3LTJiNTctNDNjMS1hY2VlLWQ0N2U2Nzc2MTQxNDo1ODJhMWFlYy03YTMwLTQ2MDItYTI2NS02YTE5NDcwOWZkOTg description: ID of the Video Mesh cluster. clusterName: type: string example: bangalore description: Name of the Video Mesh cluster. redirectDetails: type: array items: anyOf: - $ref: '#/components/schemas/ClusterRedirectDetailsBlr1a' - $ref: '#/components/schemas/ClusterRedirectDetailsBlr1b' description: Call Redirect Details. ClusterUtilizationT1Blr: type: object properties: clusterId: type: string example: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzM2ZDg5NGY3LTJiNTctNDNjMS1hY2VlLWQ0N2U2Nzc2MTQxNDo1ODJhMWFlYy03YTMwLTQ2MDItYTI2NS02YTE5NDcwOWZkOTg= description: ID of the Video Mesh cluster. clusterName: type: string example: bangalore description: Name of the Video Mesh cluster. utilizationMetrics: $ref: '#/components/schemas/UtilizationMetricsT1Blr' description: Utilization details for the cluster in the time interval. RedirectforOrg: type: object properties: items: type: array items: $ref: '#/components/schemas/RedirectCollectionForOrg' NodeStatusList2: type: object properties: nodeId: type: string example: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT05ORUNUT1IvMmMzYzlmOWUtNzNkOS00NDYwLWE2NjgtMDQ3MTYyZmYxYmFjOjE1NmRmNzg5Yzg1NTRkNTVhMjc1ZGU5OTc4Zjk5MDJl description: Unique ID of the Video Mesh node. status: type: string enum: - Dispatched - Completed - Errored description: Status of the test triggered. NodeUnAvailableTimeline: type: object properties: noOfOnlineNodes: type: number description: Number of nodes that are online. noOfOfflineNodes: type: number example: 1 description: Number of nodes that are offline. segmentStartTime: type: string example: '2021-09-15T16:53:00Z' description: Start date and time of the segment of availability data. segmentEndTime: type: string example: '2021-09-15T17:53:00Z' description: End date and time of the segment of availability data. availability: type: string example: Unavailable description: Availability information of the Video Mesh node unAvailabilityReason: type: string example: Connectivity Issues to the Node description: Reason for the Video Mesh node being unavailable (if any). totalNodes: type: number example: 1 description: Total number of nodes in the Video Mesh cluster. ClusterDetails: type: object properties: items: type: array items: $ref: '#/components/schemas/ClusterDetailsCollection' ServiceTypeResult4: type: object properties: serviceType: type: string example: WebexCloud description: Service for which the test was executed. testResult: type: string example: Failed description: Result of the test executed. failureDetails: $ref: '#/components/schemas/FailureDetails3' ConnectivityTestResultsForNode: type: object properties: timestamp: type: string example: '2022-03-15T15:53:00Z' description: The timestamp of the test run. triggerType: type: string example: OnDemand description: The type of the test being executed. Can be either `OnDemand` or `Periodic`. id: type: string example: Y2lzY29zcGFyazovL3VzL0NPTU1BTkRJRC8xZWI2NWZkZi05NjQzLTQxN2YtOTk3NC1hZDcyY2FlMGUxMGY6YWRlODhhNjAtMzk5Mi0xMWVkLTlhYmQtYzUyMjRiZjNjMzQ4 description: Unique ID of the test. result: type: array items: anyOf: - $ref: '#/components/schemas/DNSResolutionTest' - $ref: '#/components/schemas/WebSocketConnectivityTest' - $ref: '#/components/schemas/HTTPConnectivityTest' - $ref: '#/components/schemas/BandwidthTest' ConnectivityTestResultsClustersObject1: type: object properties: clusters: type: array items: anyOf: - $ref: '#/components/schemas/PerClusterConnectivityResult1' - $ref: '#/components/schemas/PerClusterConnectivityResult2' description: List of Video Mesh clusters. SJClusterDetails: type: object properties: clusterId: type: string example: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzM2ZDg5NGY3LTJiNTctNDNjMS1hY2VlLWQ0N2U2Nzc2MTQxNDo1ODJhMWFlYy03YTMwLTQ2MDItYTI2NS02YTE5NDcwOTEyMzQ description: ID of the Video Mesh cluster. clusterName: type: string example: San Jose description: Name of the Video Mesh cluster. nodes: type: array items: anyOf: - $ref: '#/components/schemas/SJNode1' - $ref: '#/components/schemas/SJNode2' description: The Video Mesh nodes in the cluster. releaseChannel: type: string example: alpha description: Release Channel of the Video Mesh cluster. upgradeSchedule: $ref: '#/components/schemas/ClusterUpgradeScheduleSJ' description: Upgrade Schedule details of the Video Mesh cluster. NodeAvailabilityCollection: type: object properties: orgId: type: string example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8zNmQ4OTRmNy0yYjU3LTQzYzEtYWNlZS1kNDdlNjc3NjE0MTQ= description: Unique ID for a Video Mesh organization. items: type: array items: $ref: '#/components/schemas/NodeAvailability' description: Availability details of the Video Mesh cluster. from: type: string example: '2021-09-15T15:53:00Z' description: Start date and time (inclusive) of the availability data. to: type: string example: '2021-09-15T17:53:00Z' description: End date and time (inclusive) of the availability data. WebSocketConnectivityTest: type: object properties: type: type: string example: WebSocketConnectivityTest description: The type of test result. results: type: array items: $ref: '#/components/schemas/ServiceTypeResult5' description: Test Results from different services. ClusterDetailsCollection: type: object properties: orgId: type: string example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8zNmQ4OTRmNy0yYjU3LTQzYzEtYWNlZS1kNDdlNjc3NjE0MTQ description: The unique ID for the organization. items: type: array items: anyOf: - $ref: '#/components/schemas/BlrClusterDetails' - $ref: '#/components/schemas/SJClusterDetails' description: ' Details of all the clusters of the organization.' TestClustersResult: type: object properties: clusters: type: array items: $ref: '#/components/schemas/Results' SingleNodeAvailabilityObject: type: object properties: clusterId: type: string example: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzFlYjY1ZmRmLTk2NDMtNDE3Zi05OTc0LWFkNzJjYWUwZTEwZjpiMzdmNTgzYy1kZGRjLTQyOGItODJlNS1jYmU2ODFkYjQ5NjI= description: ID of the Video Mesh cluster. clusterName: type: string example: San Jose description: Name of the Video Mesh cluster. hostNameOrIp: type: string example: xyz.abc.com description: Host Name or the IP of the Video Mesh node. nodeId: type: string example: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT05ORUNUT1IvMWViNjVmZGYtOTY0My00MTdmLTk5NzQtYWQ3MmNhZTBlMTBmOmMyNTk0YmY2NDFmZTRkNTFiZDg3YThiMjYxYzg3NWY1 description: ID of the Video Mesh node. availabilitySegments: type: array items: anyOf: - $ref: '#/components/schemas/SingleNodeAvailableTimeline' - $ref: '#/components/schemas/SingleNodeUnAvailableTimeline' MHMTestResult1: type: object properties: testName: type: string example: Media Signalling testResult: type: string example: Failed failureReason: type: string example: An internal error occurred in monitoring tool [Error Code:1003]. If the issue persists, please contact Cisco Support. ReachabilityTestResultsforsinglecluster: type: object properties: clusters: type: array items: $ref: '#/components/schemas/ReachabilityTestResultsforfirstcluster' description: List of Video Mesh clusters. ReachabilityTestresultsFailure: type: object properties: ipAddress: type: string example: 1.1.1.1 description: Destination IP address. port: type: number example: 51004 description: Port number. reachable: type: boolean description: Port reachability information. TriggerOnDemandBody: type: object properties: type: type: string enum: - ReachabilityTest - NetworkTest - MediaHealthMonitorTest description: "Test type to trigger on node.\n * `ReachabilityTest` - Used to test whether the media ports within the Video Mesh node are open, and whether the Video Mesh node is able to reach the cloud clusters pertaining to the media containers via those ports.\n * `NetworkTest` - Used to test the network environment of the Video Mesh node by running various connectivity, bandwidth, and DNS resolution tests against Webex Cloud and ThirdParty Cloud (Docker) services.\n * `MediaHealthMonitorTest` - Used to test the meetings and call health of Video Mesh nodes using signalling and cascading methods.\n" ClusterClientTypeDistributionDetailsSJ2: type: object properties: deviceType: type: string example: webexDevices description: The type of device. description: type: string example: Webex Devices description: The description of the device type. count: type: number example: 47 description: The count of the device type. ClustersAvailability: type: object properties: items: type: array items: $ref: '#/components/schemas/ClusterAvailabilityCollection' CloudOverflowTrend2: type: object properties: timestamp: type: string example: '2022-03-23T10:40:00Z' description: Timestamp. overflowDetails: type: array items: $ref: '#/components/schemas/OverflowDetails3' description: Overflow Details. ClusterClientTypeDistributionDetailsSJ1: type: object properties: deviceType: type: string example: webexForDesktop description: The type of device. description: type: string example: Webex App Desktop description: The description of the device type. count: type: number example: 26 description: The count of the device type. BlrNodeLocation: type: object properties: countryCode: type: string example: IN description: Country code of the Location where the Video Mesh node is deployed. city: type: string example: Bangalore description: City where Video Mesh node is deployed. timeZone: type: string example: Asia/Kolkata description: Time zone in which the Video Mesh node is deployed. ClustersUtilization: type: object properties: items: type: array items: $ref: '#/components/schemas/ClusterUtilizationCollection' RedirectTrend1: type: object properties: timestamp: type: string example: '2022-03-23T10:30:00Z' description: Timestamp. clusters: type: array items: anyOf: - $ref: '#/components/schemas/ClusterRedirectBlr1' - $ref: '#/components/schemas/ClusterRedirectSJ1' ClientTypeDistributionForCluster: type: object properties: items: type: array items: $ref: '#/components/schemas/ClientTypeDistributionCollectionForCluster' ClienttypedistributionCollectionforOrg: type: object properties: orgId: type: string example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8zNmQ4OTRmNy0yYjU3LTQzYzEtYWNlZS1kNDdlNjc3NjE0MTQ description: The unique ID for the organization. from: type: string example: '2022-03-23T10:22:03Z' description: Start date and time (inclusive) for the Client Type Distribution details. to: type: string example: '2022-03-24T10:22:03Z' description: End date and time (inclusive) of the Client Type Distribution details. aggregationInterval: type: string example: 10m description: The aggregation period of the trend data. items: type: array items: anyOf: - $ref: '#/components/schemas/ClientTypeDistributionTrend1' - $ref: '#/components/schemas/ClientTypeDistributionTrend2' description: Client Type Distribution details for the organization. PerclusterMediaHealthMonitoringresult: type: object properties: clusterId: type: string example: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzJjM2M5Zjk1LTczZDktNDQ2MC1hNjY4LTA0NzE2MmZmMWJhZDpmMWJmMGI1MC0yMDUyLTQ3ZmUtYjg3ZC01MTFjMmZlNzQ3MWI= description: Unique ID of the Video Mesh cluster. clusterName: type: string example: sanjose description: Name of the Video Mesh cluster. nodes: type: array items: anyOf: - $ref: '#/components/schemas/MediaHealthMonitoringsecondnode' - $ref: '#/components/schemas/MediaHealthMonitoringfirstnode' description: The Video Mesh nodes in the cluster. UpdateEventThresholdConfig1: type: object properties: minThreshold: type: number example: 40 description: Threshold value (in percentage) to trigger an event. defaultMinThreshold: type: number example: 10 description: Deafault Threshold value (in percentage) to trigger an event. OverflowDetails2: type: object properties: overflowReason: type: string example: Connectivity issues description: The reason for this overflow. overflowCount: type: number example: 1 description: Number of overflows. possibleRemediation: type: string example: Connectivity Issues between Video Mesh Node and Cloud. Check your network configuration. description: Any possible remediations for this overflow. ReachabilityTestresultsfornode: type: object properties: orgId: type: string example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8yYzNjOWY5NS03M2Q5LTQ0NjAtYTY2OC0wNDcxNjJmZjFiYWQ= description: Unique ID of the organization. from: type: string example: '2023-01-15T15:53:00Z' description: Start date and time (inclusive) of the Reachability test results data. to: type: string example: '2023-01-20T15:53:00Z' description: End date and time (inclusive) of the Reachability test results data. items: type: array items: $ref: '#/components/schemas/ReachabilityTestResultsforoneclusteronenode' description: Reachability test results data. UtilizationForClusterCollection: type: object properties: orgId: type: string example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8zNmQ4OTRmNy0yYjU3LTQzYzEtYWNlZS1kNDdlNjc3NjE0MTQ= description: The unique ID for the organization. aggregationInterval: type: string example: 10m description: The aggregation period of the trend data. from: type: string example: '2022-03-23T10:22:03Z' description: Start date and time (inclusive) of the utilization data. to: type: string example: '2022-03-24T10:22:03Z' description: End date and time (inclusive) of the utilization data. items: type: array items: anyOf: - $ref: '#/components/schemas/UtilizationForClusterTrend1' - $ref: '#/components/schemas/UtilizationForClusterTrend2' description: Utilization details of the Video Mesh cluster. SpecificClusterDetails: type: object properties: items: type: array items: $ref: '#/components/schemas/SpecificClusterDetailsCollection' GetEntityThresholdConfig2: type: object properties: eventName: type: string example: orgCallsOverflowed description: Name of the event. eventThresholdId: type: string example: Y2lzY29zcGFyazovL3VzL0VWRU5ULzQyN2U5ZTk2LTczYTctNDYwYS04MGZhLTcyNWU4MWE2MDg3ZjowM2ZkYjkzZC1jNTllLTQzMjQtODIwNS1lNDIyYzA3NGQ5Mzg description: Unique ID of the event threshold configuration. eventScope: type: string example: ORG description: The `eventScope` is scope of event. entityId: type: string example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8yYzNjOWY5NS03M2Q5LTQ0NjAtYTY2OC0wNDcxNjJmZjFiYWQ description: The `entityId` is the unique ID of the Organization or the unique ID of the Video Mesh Cluster. thresholdConfig: $ref: '#/components/schemas/EventThresholdConfig2' description: Threshold configuration of an `entityId`. ReachabilityTestresultsdestinationcluster: type: object properties: destinationCluster: type: string example: Amsterdam Cluster description: Cloud Webex cluster against which Reachability test is being executed. stunResults: type: array items: anyOf: - $ref: '#/components/schemas/ReachabilityTestResultsStunresults1' - $ref: '#/components/schemas/ReachabilityTestResultsStunresults2' description: STUN test results for a Video Mesh cluster. OverflowtoCloudCollection: type: object properties: orgId: type: string example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8zNmQ4OTRmNy0yYjU3LTQzYzEtYWNlZS1kNDdlNjc3NjE0MTQ description: The unique ID for the organization. from: type: string example: '2022-03-23T10:22:03Z' description: Start date and time (inclusive) for the Overflow to Cloud data. to: type: string example: '2022-03-24T04:22:03Z' description: End date and time (inclusive) for the Overflow to Cloud data. aggregationInterval: type: string example: 10m description: The aggregation period of the trend data. items: type: array items: anyOf: - $ref: '#/components/schemas/CloudOverflowTrend1' - $ref: '#/components/schemas/CloudOverflowTrend2' description: Overflow data for the organization. ClusterRedirectDetailsBlr1a: type: object properties: redirectReason: type: string example: Capacity exceeded description: The reason for the redirect. redirectCount: type: number example: 10 description: Number of Call Redirects. possibleRemediation: type: string example: Video Mesh exceeded its capacity. If this happens frequently, consider adding more nodes to your clusters. description: ' Any possible remediations for this overflow.' NodesResult: type: object properties: nodeId: type: string example: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT05ORUNUT1IvMmMzYzlmOTUtNzNkOS00NDYwLWE2NjgtMDQ3MTYyZmYxYmFkOjE1NmRmNzg5Yzg1NTRkNTVhMjc1ZGY5OTc4Zjk5MDJk description: ' Unique ID of the Video Mesh node.' hostNameOrIP: type: string example: abc.company.com description: Host name or IP Address of the Video Mesh node. mhmTestResults: type: array items: $ref: '#/components/schemas/MHMTestResults' ClusterUpgradeScheduleBlr: type: object properties: scheduleDays: type: array items: $ref: '#/components/schemas/ScheduleDays' description: Days of the week when scheduled upgrades will occur for the Video Mesh cluster. scheduleTime: type: string example: 02:00 description: Time when scheduled upgrade will occur for the Video Mesh cluster. scheduleTimeZone: type: string example: Asia/Kolkata description: Timezone of the scheduled upgrade of Video Mesh cluster. upgradePending: type: boolean example: true description: Upgrade Pending information. nextUpgradeTime: type: string example: '2020-03-25T20:30:00Z' description: Time when the next upgrade is scheduled for the Video Mesh cluster. ClusterClientTypeDistributionSJ1: type: object properties: clusterId: type: string example: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzM2ZDg5NGY3LTJiNTctNDNjMS1hY2VlLWQ0N2U2Nzc2MTQxNDo1ODJhMWFlYy03YTMwLTQ2MDItYTI2NS02YTE5NDcwOTEyMzQ= description: ID of the Video Mesh cluster. clusterName: type: string example: San Jose description: Name of the Video Mesh cluster. clientTypeDistributionDetails: type: array items: $ref: '#/components/schemas/ClusterClientTypeDistributionDetailsSJ1' description: Client Type Distribution Details. BlrNode1: type: object properties: nodeId: type: string example: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzM2ZDg5NGY3LTJiNTctNDNjMS1hY2VlLWQ0N2U2Nzc2MTQxNDo0NjdiNGIxZC1jZWI2LTQwN2EtYWZmOC1mMjIxZmFiNzhjNzI description: ID of the Video Mesh node. hostNameOrIp: type: string example: xyz.abc.com description: Host Name or the IP of the Video Mesh node. deploymentType: type: string example: Video Mesh Node Lite description: Deployment Type of the Video Mesh node. location: $ref: '#/components/schemas/BlrNodeLocation' description: Location details of the Video Mesh node. SIPSignallingtestResultSuccess: type: object properties: testName: type: string example: SIP Signalling description: The name of the test. testResult: type: string example: Success description: The result, either `Success` or `Failed`. ConnectivityTestResultsNodesObject: type: object properties: orgId: type: string example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8yYzNjOWY5NS03M2Q5LTQ0NjAtYTY2OC0wNDcxNjJmZjFiYWQ= description: Unique ID of the organization. from: type: string example: '2023-01-15T15:53:00Z' description: Start date and time (inclusive) of the Network Test data. to: type: string example: '2023-01-20T15:53:00Z' description: End date and time (inclusive) of the Network Test data. items: type: array items: $ref: '#/components/schemas/ConnectivityTestResultsClustersObject3' description: Network test results. ListEventThresholdResponse: type: object properties: orgId: type: string example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8yYzNjOWY5NS03M2Q5LTQ0NjAtYTY2OC0wNDcxNjJmZjFiYWQ description: Unique ID of the organization. eventThresholds: type: array items: anyOf: - $ref: '#/components/schemas/GetEntityThresholdConfig1' - $ref: '#/components/schemas/GetEntityThresholdConfig2' TriggeredTestStatus2: type: object properties: orgId: type: string example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8yYzNjOWY5NS03M2Q5LTQ0NjAtYTY2OC0wNDcxNjJmZjFiYWQ= description: Unique ID of the organization. commandId: type: string example: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT01NQU5EX0lELzJjM2M5ZjllLTczZDktNDQ2MC1hNjY4LTA0NzE2MmZmMWJhYzo2NTJmNmMxMC01NjgxLTExZWQtOTkyZS1kNTY5YzlkMDlhNzU description: The unique ID of the test being executed. clusterId: type: string example: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzJjM2M5Zjk1LTczZDktNDQ2MC1hNjY4LTA0NzE2MmZmMWJhZDpmMWJmMGI1MC0yMDUyLTQ3ZmUtYjg3ZC01MTFjMmZlNzQ3MWk= description: Unique ID of the Video Mesh cluster. nodes: type: array items: $ref: '#/components/schemas/NodeStatusList1' UtilizationMetricsT1SJ: type: object properties: peakCpu: type: number example: 54.54 description: Peak CPU usage during the time interval. avgCpu: type: number example: 4.27 description: Average CPU usage during the time interval. activeCalls: type: number example: 5 description: Maximum active calls at a point in the time interval. activePrivateCalls: type: number example: 1 description: Maximum active private calls at a point in the time interval. SingleNodeAvailableTimeline: type: object properties: segmentStartTime: type: string example: '2021-09-15T15:53:00Z' description: Start date and time of the segment of availability data. segmentEndTime: type: string example: '2021-09-15T16:53:00Z' description: End date and time of the segment of availability data. availability: type: string example: Available description: Availability information of the Video Mesh node. unAvailabilityReason: type: string example: NA description: Reason for the Video Mesh node being unavailable (if any). MediaHealthMonitoringsecondnode: type: object properties: nodeId: type: string example: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT05ORUNUT1IvMmMzYzlmOTUtNzNkOS00NDYwLWE2NjgtMDQ3MTYyZmYxYmFkOjE1NmRmNzg5Yzg1NTRkNTVhMjc1ZGY5OTc4Zjk5MDJk description: Unique ID of the Video Mesh node. hostNameOrIP: type: string example: abc.company.com description: Host name or the IP of the Video Mesh node. mhmTestResults: type: array items: anyOf: - $ref: '#/components/schemas/MediaHealthMonitoringTestResultsFailure' - $ref: '#/components/schemas/MediaHealthMonitoringTestResultsSuccess' description: The Media Health Monitoring Tool test results for a single Video Mesh node. ConnectivityTestResultsClustersObject2: type: object properties: clusters: type: array items: $ref: '#/components/schemas/PerClusterConnectivityResult2' description: List of Video Mesh clusters. MediaHealthMonitoringResultsCollectionforcluster: type: object properties: orgId: type: string example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8yYzNjOWY5NS03M2Q5LTQ0NjAtYTY2OC0wNDcxNjJmZjFiYWQ= description: Unique ID of the organization. from: type: string example: '2023-01-15T15:53:00Z' description: Start date and time (inclusive) of the Media Health Monitoring Tool data. to: type: string example: '2023-01-20T15:53:00Z' description: End date and time (inclusive) of the Media Health Monitoring Tool data. items: type: array items: $ref: '#/components/schemas/PerclusterMediaHealthMonitoringclusters' description: Media Health Monitoring Tool test results. ReachabilityTestresultsfororganization: type: object properties: orgId: type: string example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8yYzNjOWY5NS03M2Q5LTQ0NjAtYTY2OC0wNDcxNjJmZjFiYWQ= description: Unique ID of the organization. from: type: string example: '2023-01-15T15:53:00Z' description: Start date and time (inclusive) of the Reachability test results data. to: type: string example: '2023-01-20T15:53:00Z' description: End date and time (inclusive) of the Reachability test results data. items: type: array items: $ref: '#/components/schemas/ReachabilityTestResultsforcluster' description: Reachability test results data. TriggeredTestStatus1: type: object properties: orgId: type: string example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8yYzNjOWY5NS03M2Q5LTQ0NjAtYTY2OC0wNDcxNjJmZjFiYWQ= description: Unique ID of the organization. commandId: type: string example: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT01NQU5EX0lELzJjM2M5ZjllLTczZDktNDQ2MC1hNjY4LTA0NzE2MmZmMWJhYzo2NTJmNmMxMC01NjgxLTExZWQtOTkyZS1kNTY5YzlkMDlhNzU description: The unique ID of the test being executed. clusterId: type: string example: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzJjM2M5Zjk1LTczZDktNDQ2MC1hNjY4LTA0NzE2MmZmMWJhZDpmMWJmMGI1MC0yMDUyLTQ3ZmUtYjg3ZC01MTFjMmZlNzQ3MWI= description: ' Unique ID of the Video Mesh cluster.' nodes: type: array items: anyOf: - $ref: '#/components/schemas/NodeStatusList1' - $ref: '#/components/schemas/NodeStatusList2' BlrNode2: type: object properties: nodeId: type: string example: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzM2ZDg5NGY3LTJiNTctNDNjMS1hY2VlLWQ0N2U2Nzc2MTQxNDo1ODJhMWFlYy03YTMwLTQ2MDItYTI2NS02YTE5NDcwOWZkOTg description: ID of the Video Mesh node. hostNameOrIp: type: string example: 201.21.201.21 description: Host Name or the IP of the Video Mesh node. deploymentType: type: string example: Video Mesh Node Lite description: Deployment Type of the Video Mesh node. location: $ref: '#/components/schemas/BlrNodeLocation' description: Location details of the Video Mesh node. NodeStatusList1: type: object properties: nodeId: type: string example: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT05ORUNUT1IvMmMzYzlmOTUtNzNkOS00NDYwLWE2NjgtMDQ3MTYyZmYxYmFkOjE1NmRmNzg5Yzg1NTRkNTVhMjc1ZGY5OTc4Zjk5MDJk description: Unique ID of the Video Mesh node. status: type: string enum: - Dispatched - Completed - Errored description: Status of the test triggered. ClusterRedirectDetailsBlr1b: type: object properties: redirectReason: type: string example: Connectivity issues description: The reason for the redirect. redirectCount: type: number example: 78 description: Number of Call Redirects. possibleRemediation: type: string example: Connectivity Issues between Video Mesh Node and Cloud. Check your network configuration. description: ' Any possible remediations for this overflow.' PerNodeConnectivityResult3: type: object properties: nodeId: type: string example: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT05ORUNUT1IvMmMzYzlmOTUtNzNkOS00NDYwLWE2NjgtMDQ3MTYyZmYxYmFkOjE1NmRmNzg5Yzg1NTRkNTVhMjc1ZGY5OTc4Zjk5MDJk description: Unique ID of the Video Mesh node. hostNameOrIP: type: string example: xyz.company.com description: Host name or IP Address of the Video Mesh node. testResults: type: array items: $ref: '#/components/schemas/ConnectivityTestResultsForNode' SJNode1: type: object properties: nodeId: type: string example: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzM2ZDg5NGY3LTJiNTctNDNjMS1hY2VlLWQ0N2U2Nzc2MTQxNDo0NjdiNGIxZC1jZWI2LTQwN2EtYWZmOC1mMjIxZmFiNzhjNzI description: ID of the Video Mesh node. hostNameOrIp: type: string example: abc.company.com description: Host Name or the IP of the Video Mesh node. deploymentType: type: string example: Video Mesh Node Lite description: Deployment Type of the Video Mesh node. location: $ref: '#/components/schemas/SJNodeLocation' description: Location details of the Video Mesh node. ClientTypeDistributionTrendForCluster2: type: object properties: timestamp: type: string example: '2022-03-23T10:40:00Z' description: Timestamp. clusters: type: array items: $ref: '#/components/schemas/ClusterClientTypeDistributionBlr2' PernodeMediaHealthMonitoringclusters: type: object properties: clusters: type: array items: $ref: '#/components/schemas/PernodeMediaHealthMonitoringresult' description: The list of Video Mesh clusters. ConnectivityTestResultsObject: type: object properties: orgId: type: string example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8yYzNjOWY5NS03M2Q5LTQ0NjAtYTY2OC0wNDcxNjJmZjFiYWQ= description: Unique ID of the organization. from: type: string example: '2023-01-15T15:53:00Z' description: Start date and time (inclusive) of the Network Test data. to: type: string example: '2023-01-20T15:53:00Z' description: End date and time (inclusive) of the Network Test data. items: type: array items: $ref: '#/components/schemas/ConnectivityTestResultsClustersObject1' description: Network test results. RedirectTrendForCluster2: type: object properties: timestamp: type: string example: '2022-03-23T10:40:00Z' description: Timestamp. clusters: type: array items: $ref: '#/components/schemas/ClusterRedirectBlr2' ClusterAvailableTimeline: type: object properties: segmentStartTime: type: string example: '2021-09-15T15:53:00Z' description: Start date and time of the segment of availability data. segmentEndTime: type: string example: '2021-09-15T16:53:00Z' description: End date and time of the segment of availability data. availability: type: string example: Available description: Availability information of the Video Mesh cluster. noOfOnlineNodes: type: number example: 1 description: Number of nodes that are online. noOfOfflineNodes: type: number example: 1 description: Number of nodes that are offline. totalNodes: type: number example: 2 description: Total number of nodes in the Video Mesh cluster. MediaHealthMonitoringforsecondcluster: type: object properties: clusterId: type: string example: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzJjM2M5Zjk1LTczZDktNDQ2MC1hNjY4LTA0NzE2MmZmMWJhZDpmMWJmMGI1MC0yMDUyLTQ3ZmUtYjg3ZC01MTFjMmZlNzQ3MWk= description: Unique ID of the Video Mesh cluster. clusterName: type: string example: sanjose description: Name of the Video Mesh cluster. nodes: type: array items: anyOf: - $ref: '#/components/schemas/MediaHealthMonitoringsecondnode' - $ref: '#/components/schemas/MediaHealthMonitoringfirstnode' description: The Video Mesh nodes in the cluster. UtilizationMetricsT1Blr: type: object properties: peakCpu: type: number example: 62 description: Peak CPU usage during the time interval. avgCpu: type: number example: 3.64 description: Average CPU usage during the time interval. activeCalls: type: number description: Maximum active calls at a point in the time interval. activePrivateCalls: type: number description: Maximum active private calls at a point in the time interval. ConnectivityTestResultsClustersObject3: type: object properties: clusters: type: array items: $ref: '#/components/schemas/PerClusterConnectivityResult3' description: List of Video Mesh clusters. SpecificClusterDetailsCollection: type: object properties: orgId: type: string example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8zNmQ4OTRmNy0yYjU3LTQzYzEtYWNlZS1kNDdlNjc3NjE0MTQ description: The unique ID for the organization. items: type: array items: $ref: '#/components/schemas/BlrClusterDetails' description: ' Details of the cluster.' UtilizationMetricsT2Blr: type: object properties: peakCpu: type: number example: 69.75 description: Peak CPU usage during the time interval. avgCpu: type: number example: 57.89 description: Average CPU usage during the time interval. activeCalls: type: number example: 142 description: Maximum active calls at a point in the time interval. activePrivateCalls: type: number example: 15 description: Maximum active private calls at a point in the time interval. ReachabilityTestresultssecondnode: type: object properties: nodeId: type: string example: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT05ORUNUT1IvMmMzYzlmOTUtNzNkOS00NDYwLWE2NjgtMDQ3MTYyZmYxYmFkOjE1NmRmNzg5Yzg1NTRkNTVhMjc1ZGY5OTc4Zjk5MDJk description: Unique ID of the Video Mesh node. hostNameOrIP: type: string example: abc.company.com description: Host name or the IP of the Video Mesh node. testResults: type: array items: $ref: '#/components/schemas/ReachabilityTestresultsdestinationcluster' description: ' Reachability test results for a single Video Mesh node.' ClusterUtilizationT2SJ: type: object properties: clusterId: type: string example: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzM2ZDg5NGY3LTJiNTctNDNjMS1hY2VlLWQ0N2U2Nzc2MTQxNDo1ODJhMWFlYy03YTMwLTQ2MDItYTI2NS02YTE5NDcwOTEyMzQ= description: ID of the Video Mesh cluster. clusterName: type: string example: sanjose description: Name of the Video Mesh cluster. utilizationMetrics: $ref: '#/components/schemas/UtilizationMetricsT2SJ' description: Utilization details for the cluster in the time interval. PerClusterConnectivityResult3: type: object properties: clusterId: type: string example: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzJjM2M5Zjk1LTczZDktNDQ2MC1hNjY4LTA0NzE2MmZmMWJhZDpmMWJmMGI1MC0yMDUyLTQ3ZmUtYjg3ZC01MTFjMmZlNzQ3MWI= description: Unique ID of the Video Mesh cluster. clusterName: type: string example: shangai description: Name of the Video Mesh cluster. nodes: type: array items: $ref: '#/components/schemas/PerNodeConnectivityResult1' ReachabilityTestresultsforcluster: type: object properties: orgId: type: string example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8yYzNjOWY5NS03M2Q5LTQ0NjAtYTY2OC0wNDcxNjJmZjFiYWQ= description: Unique ID of the organization. from: type: string example: '2023-01-15T15:53:00Z' description: Start date and time (inclusive) of the Reachability test results data. to: type: string example: '2023-01-20T15:53:00Z' description: End date and time (inclusive) of the Reachability test results data. items: type: array items: $ref: '#/components/schemas/ReachabilityTestResultsforsinglecluster' description: Reachability test results data. MHMTestResult2: type: object properties: testName: type: string example: Media Cascade testResult: type: string example: Failed failureReason: type: string example: An internal error occurred in monitoring tool [Error Code:1003]. If the issue persists, please contact Cisco Support. ClusterRedirectDetailsSJ1: type: object properties: redirectReason: type: string example: Capacity exceeded description: The reason for the redirect. redirectCount: type: number example: 26 description: Number of Call Redirects. possibleRemediation: type: string example: Video Mesh exceeded its capacity. If this happens frequently, consider adding more nodes to your clusters. description: Any possible remediations for this overflow. ClusterUpgradeScheduleSJ: type: object properties: scheduleDays: type: array items: $ref: '#/components/schemas/ScheduleDays' description: Days of the week when scheduled upgrades will occur for the Video Mesh cluster. scheduleTime: type: string example: 02:00 description: Time when scheduled upgrade will occur for the Video Mesh cluster. scheduleTimeZone: type: string example: America/Los_Angeles description: Timezone of the scheduled upgrade of Video Mesh cluster. upgradePending: type: boolean example: true description: Upgrade Pending information. nextUpgradeTime: type: string example: '2020-03-26T09:00:00Z' description: Time when the next upgrade is scheduled for the Video Mesh cluster. PerClusterConnectivityResult1: type: object properties: clusterId: type: string example: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzJjM2M5Zjk1LTczZDktNDQ2MC1hNjY4LTA0NzE2MmZmMWJhZDpmMWJmMGI1MC0yMDUyLTQ3ZmUtYjg3ZC01MTFjMmZlNzQ3MWI= description: Unique ID of the Video Mesh cluster. clusterName: type: string example: sanjose description: Name of the Video Mesh cluster. nodes: type: array items: anyOf: - $ref: '#/components/schemas/PerNodeConnectivityResult1' - $ref: '#/components/schemas/PerNodeConnectivityResult3' RedirectCollectionForOrg: type: object properties: orgId: type: string example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8zNmQ4OTRmNy0yYjU3LTQzYzEtYWNlZS1kNDdlNjc3NjE0MTQ description: The unique ID for the organization. from: type: string example: '2022-03-23T10:22:03Z' description: Start date and time (inclusive) for the Call Redirect details. to: type: string example: '2022-03-24T10:22:03Z' description: End date and time (inclusive) of the Call Redirect details. aggregationInterval: type: string example: 10m description: The aggregation period of the trend data. items: type: array items: anyOf: - $ref: '#/components/schemas/RedirectTrend1' - $ref: '#/components/schemas/RedirectTrend2' description: Redirect details for the organization. EventThresholdConfig2: type: object properties: minThreshold: type: number example: 10 description: Threshold value (in percentage) to trigger an event. defaultMinThreshold: type: number example: 10 description: 'Deafault Threshold value (in percentage) to trigger an event. ' GetEventThresholdResponse: type: object properties: orgId: type: string example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8yYzNjOWY5NS03M2Q5LTQ0NjAtYTY2OC0wNDcxNjJmZjFiYWQ description: Unique ID of the organization. eventThresholds: type: array items: $ref: '#/components/schemas/GetEntityThresholdConfig1' MediaHealthMonitoringfirstnode: type: object properties: nodeId: type: string example: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT05ORUNUT1IvMmMzYzlmOTUtNzNkOS00NDYwLWE2NjgtMDQ3MTYyZmYxYmFkOjE1NmRmNzg5Yzg1NTRkNTVhMjc1ZGY5OTc4Zjk5MDJk description: Unique ID of the Video Mesh node. hostNameOrIP: type: string example: xyz.company.com description: Host name or IP Address of the Video Mesh node. mhmTestResults: type: array items: anyOf: - $ref: '#/components/schemas/MediaHealthMonitoringTestResultsFailure' - $ref: '#/components/schemas/MediaHealthMonitoringTestResultsSuccess' description: ' The Media Health Monitoring Tool test results for a single Video Mesh node.' ConnectivityTestResultsClustersObject: type: object properties: orgId: type: string example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8yYzNjOWY5NS03M2Q5LTQ0NjAtYTY2OC0wNDcxNjJmZjFiYWQ= description: Unique ID of the organization. from: type: string example: '2023-01-15T15:53:00Z' description: Start date and time (inclusive) of the Network Test data. to: type: string example: '2023-01-20T15:53:00Z' description: End date and time (inclusive) of the Network Test data. items: type: array items: $ref: '#/components/schemas/ConnectivityTestResultsClustersObject2' description: Network test results. PerNodeConnectivityResult2: type: object properties: nodeId: type: string example: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT05ORUNUT1IvMmMzYzlmOTUtNzNkOS00NDYwLWE2NjgtMDQ3MTYyZmYxYmFkOjE1NmRmNzg5Yzg1NTRkNTVhMjc1ZGY5OTc4Zjk5MDJk description: Unique ID of the Video Mesh node. hostNameOrIP: type: string example: def.company.com description: Host name or IP Address of the Video Mesh node. testResults: type: array items: $ref: '#/components/schemas/ConnectivityTestResultsForNode' RedirectTrend2: type: object properties: timestamp: type: string example: '2022-03-23T10:40:00Z' description: Timestamp. clusters: type: array items: anyOf: - $ref: '#/components/schemas/ClusterRedirectBlr2' - $ref: '#/components/schemas/ClusterRedirectSJ2' TriggeredTestResult: type: object properties: type: type: string example: MediaHealthMonitorTest description: Test type of the command ID. commandId: type: string example: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT01NQU5EX0lELzJjM2M5ZjllLTczZDktNDQ2MC1hNjY4LTA0NzE2MmZmMWJhYzo2NTJmNmMxMC01NjgxLTExZWQtOTkyZS1kNTY5YzlkMDlhNzU description: The unique ID for the test being executed. orgId: type: string example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8yYzNjOWY5NS03M2Q5LTQ0NjAtYTY2OC0wNDcxNjJmZjFiYWQ= description: Unique ID of the organization. results: type: array items: $ref: '#/components/schemas/TestClustersResult' BlrClusterDetails: type: object properties: clusterId: type: string example: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzFlYjY1ZmRmLTk2NDMtNDE3Zi05OTc0LWFkNzJjYWUwZTEwZjpiMzdmNTgzYy1kZGRjLTQyOGItODJlNS1jYmU2ODFkYjQ5NjI description: ID of the Video Mesh cluster. clusterName: type: string example: Bangalore description: Name of the Video Mesh cluster. nodes: type: array items: anyOf: - $ref: '#/components/schemas/BlrNode1' - $ref: '#/components/schemas/BlrNode2' description: The Video Mesh nodes in the cluster. releaseChannel: type: string example: alpha description: Release Channel of the Video Mesh cluster. upgradeSchedule: $ref: '#/components/schemas/ClusterUpgradeScheduleBlr' description: Upgrade Schedule details of the Video Mesh cluster. ServiceTypeResult3: type: object properties: serviceType: type: string example: WebexCloud description: Service for which test was executed. testResult: type: string example: Failed description: Result of the test executed. failureDetails: $ref: '#/components/schemas/FailureDetails2' ServiceTypeResult1: type: object properties: serviceType: type: string example: WebexCloud description: Service for which the test was executed. testResult: type: string example: Failed description: Result of the test executed. failureDetails: $ref: '#/components/schemas/FailureDetails1' SingleNodeUnAvailableTimeline: type: object properties: segmentStartTime: type: string example: '2021-09-15T16:53:00Z' description: Start date and time of the segment of availability data. segmentEndTime: type: string example: '2021-09-15T17:53:00Z' description: End date and time of the segment of availability data. availability: type: string example: Unavailable description: Availability information of the Video Mesh node. unAvailabilityReason: type: string example: Connectivity Issues to the Node description: Reason for the Video Mesh node being unavailable (if any). ServiceTypeResult5: type: object properties: serviceType: type: string example: WebexCloud description: Service for which the test was executed. testResult: type: string example: Success description: Result of the test executed. MediaHealthMonitoringResultsCollectionfornode: type: object properties: orgId: type: string example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8yYzNjOWY5NS03M2Q5LTQ0NjAtYTY2OC0wNDcxNjJmZjFiYWQ= description: Unique ID of the organization. from: type: string example: '2023-01-15T15:53:00Z' description: Start date and time (inclusive) of the Media Health Monitoring Tool data. to: type: string example: '2023-01-20T15:53:00Z' description: End date and time (inclusive) of the Media Health Monitoring Tool data. items: type: array items: $ref: '#/components/schemas/PernodeMediaHealthMonitoringclusters' description: Media Health Monitoring Tool test results. FailureDetails1: type: object properties: possibleFailureReason: type: array items: type: string example: 'DNS Resolution issue detected in the Video Mesh Node [Error Code: 1302].' description: Possible reasons for failure for the test. possibleRemediation: type: array items: type: string example: 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. description: Possible fixes for the failures mentioned above. SJNodeLocation: type: object properties: countryCode: type: string example: US description: Country Code of the Location where the Video Mesh node is deployed. city: type: string example: San Jose description: City where Video Mesh node is deployed. timeZone: type: string example: America/Los_Angeles description: Time zone in which the Video Mesh node is deployed. HTTPConnectivityTest: type: object properties: type: type: string example: HTTPConnectivityTest description: The type of test result. results: type: array items: anyOf: - $ref: '#/components/schemas/ServiceTypeResult3' - $ref: '#/components/schemas/ServiceTypeResult2' description: Test Results from different services. ReachabilityTestResultsStunresults2: type: object properties: timestamp: type: string example: '2022-03-15T16:53:00Z' description: The timestamp of the test run. triggerType: type: string example: OnDemand description: The type of the test being executed. Can be either `OnDemand` or `Periodic`. id: type: string example: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT01NQU5EX0lELzJjM2M5ZjllLTczZDktNDQ2MC1hNjY4LTA0NzE2MmZmMWJhYzo2NTJmNmMxMC01NjgxLTExZWQtOTkyZS1kNTY5YzlkMDlhNzU description: Unique ID of the test. udp: type: array items: anyOf: - $ref: '#/components/schemas/ReachabilityTestresultsFailure' - $ref: '#/components/schemas/ReachabilityTestresultsSuccess' description: List of UDP ports being checked in Reachability test. tcp: type: array items: anyOf: - $ref: '#/components/schemas/ReachabilityTestresultsFailure' - $ref: '#/components/schemas/ReachabilityTestresultsSuccess' description: List of TCP ports being checked in Reachability test. ClientTypeDistributionTrend1: type: object properties: timestamp: type: string example: '2022-03-23T10:30:00Z' description: Timestamp. clusters: type: array items: anyOf: - $ref: '#/components/schemas/ClusterClientTypeDistributionBlr1' - $ref: '#/components/schemas/ClusterClientTypeDistributionSJ1' MHMTestResults: type: object properties: timestamp: type: string example: '2022-03-15T15:53:00Z' description: The timestamp of the test run. id: type: string example: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT01NQU5EX0lELzJjM2M5ZjllLTczZDktNDQ2MC1hNjY4LTA0NzE2MmZmMWJhYzo2NTJmNmMxMC01NjgxLTExZWQtOTkyZS1kNTY5YzlkMDlhNzU testResults: type: array items: anyOf: - $ref: '#/components/schemas/MHMTestResult1' - $ref: '#/components/schemas/MHMTestResult2' - $ref: '#/components/schemas/MHMTestResult3' OverflowtoCloud: type: object properties: items: type: array items: $ref: '#/components/schemas/OverflowtoCloudCollection' BandwidthTest: type: object properties: type: type: string example: BandwidthTest description: The type of test result. results: type: array items: anyOf: - $ref: '#/components/schemas/ServiceTypeResult4' - $ref: '#/components/schemas/ServiceTypeResult2' description: Test Results from different services. SJNode2: type: object properties: nodeId: type: string example: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzM2ZDg5NGY3LTJiNTctNDNjMS1hY2VlLWQ0N2U2Nzc2MTQxNDo1ODJhMWFlYy03YTMwLTQ2MDItYTI2NS02YTE5NDcwOWZkOTg description: ID of the Video Mesh node. hostNameOrIp: type: string example: xyz.abc.com description: Host Name or the IP of the Video Mesh node. deploymentType: type: string example: Video Mesh Node Lite description: Deployment Type of the Video Mesh node. location: $ref: '#/components/schemas/SJNodeLocation' description: Location details of the Video Mesh node. ClienttypedistributionforOrg: type: object properties: items: type: array items: $ref: '#/components/schemas/ClienttypedistributionCollectionforOrg' PerclusterMediaHealthMonitoringclusters: type: object properties: clusters: type: array items: $ref: '#/components/schemas/PerclusterMediaHealthMonitoringresult' description: List of Video Mesh clusters. MediaSignallingtestResultFailure: type: object properties: testName: type: string example: Media Signalling description: The name of the test. testResult: type: string example: Failed description: Test results(Success/Failed). failureReason: type: string example: An internal error occurred in monitoring tool [Error Code:1003]. If the issue persists, please contact Cisco Support. description: Reason for test failure. TriggerOn-DemandBodyCluster: type: object properties: type: type: string enum: - ReachabilityTest - NetworkTest - MediaHealthMonitorTest description: "Test type to trigger on node.\n * `ReachabilityTest` - Used to test whether the media ports within the Video Mesh node are open, and whether the Video Mesh node is able to reach the cloud clusters pertaining to the media containers via those ports.\n * `NetworkTest` - Used to test the network environment of the Video Mesh node by running various connectivity, bandwidth, and DNS resolution tests against Webex Cloud and ThirdParty Cloud (Docker) services.\n * `MediaHealthMonitorTest` - Used to test the meetings and call health of Video Mesh nodes using signaling and cascading methods.\n" nodes: type: array items: type: string example: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT05ORUNUT1IvMmMzYzlmOWUtNzNkOS00NDYwLWE2NjgtMDQ3MTYyZmYxYmFjOjE1NmRmNzg5Yzg1NTRkNTVhMjc1ZGU5OTc4Zjk5MDJk,Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT05ORUNUT1IvMmMzYzlmOWUtNzNkOS00NDYwLWE2NjgtMDQ3MTYyZmYxYmFjOjE1NmRmNzg5Yzg1NTRhYmNhZGVmZ2U5OTc4Zjk5MDJk description: List of nodes to test. ClusterUtilizationT1SJ: type: object properties: clusterId: type: string example: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzM2ZDg5NGY3LTJiNTctNDNjMS1hY2VlLWQ0N2U2Nzc2MTQxNDo1ODJhMWFlYy03YTMwLTQ2MDItYTI2NS02YTE5NDcwOTEyMzQ= description: ID of the Video Mesh cluster. clusterName: type: string example: sanjose description: Name of the Video Mesh cluster. utilizationMetrics: $ref: '#/components/schemas/UtilizationMetricsT1SJ' description: Utilization details for the cluster in the time interval. UtilizationForCluster: type: object properties: items: type: array items: $ref: '#/components/schemas/UtilizationForClusterCollection' ClusterRedirectSJ2: type: object properties: clusterId: type: string example: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzM2ZDg5NGY3LTJiNTctNDNjMS1hY2VlLWQ0N2U2Nzc2MTQxNDo1ODJhMWFlYy03YTMwLTQ2MDItYTI2NS02YTE5NDcwOTEyMzQ= description: ID of the Video Mesh cluster. clusterName: type: string example: sanjose description: Name of the Video Mesh cluster. redirectDetails: type: array items: $ref: '#/components/schemas/ClusterRedirectDetailsSJ2' description: Call Redirect Details. ReachabilityTestResultsforonecluster: type: object properties: clusterId: type: string example: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzJjM2M5Zjk1LTczZDktNDQ2MC1hNjY4LTA0NzE2MmZmMWJhZDpmMWJmMGI1MC0yMDUyLTQ3ZmUtYjg3ZC01MTFjMmZlNzQ3MWI= description: Unique ID of the Video Mesh cluster. clusterName: type: string example: banglore description: Name of the Video Mesh cluster. nodes: type: array items: $ref: '#/components/schemas/ReachabilityTestresultsfirstnode' description: The Video Mesh nodes in the cluster. ClusterUtilizationCollection: type: object properties: orgId: type: string example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8zNmQ4OTRmNy0yYjU3LTQzYzEtYWNlZS1kNDdlNjc3NjE0MTQ= description: The unique ID for the organization. aggregationInterval: type: string example: 10m description: The aggregation period of the trend data. from: type: string example: '2022-03-23T10:22:03Z' description: Start date and time (inclusive) of the utilization data. to: type: string example: '2022-03-24T10:22:03Z' description: End date and time (inclusive) of the utilization data. items: type: array items: anyOf: - $ref: '#/components/schemas/ClusterUtilizationTrend1' - $ref: '#/components/schemas/ClusterUtilizationTrend2' description: Utilization details of the Video Mesh cluster ClusterClientTypeDistributionBlr2: type: object properties: clusterId: type: string example: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzM2ZDg5NGY3LTJiNTctNDNjMS1hY2VlLWQ0N2U2Nzc2MTQxNDo1ODJhMWFlYy03YTMwLTQ2MDItYTI2NS02YTE5NDcwOWZkOTg description: ID of the Video Mesh cluster. clusterName: type: string example: Bangalore description: Name of the Video Mesh cluster. clientTypeDistributionDetails: type: array items: $ref: '#/components/schemas/ClusterClientTypeDistributionDetailsBlr2' description: Client Type Distribution Details. SingleNodeAvailability: type: object properties: items: type: array items: $ref: '#/components/schemas/SingleNodeAvailabilityCollection' FailureDetails3: type: object properties: possibleFailureReason: type: array items: type: string example: 'Degraded Network Bandwidth speed detected in the Video Mesh Node connectivity to the Webex Cloud [Error Code: 1402,1405].' description: Possible reasons for failure for the test. possibleRemediation: type: array items: type: string example: 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. description: Possible fixes for the failures mentioned above. PerClusterConnectivityResult2: type: object properties: clusterId: type: string example: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzJjM2M5Zjk1LTczZDktNDQ2MC1hNjY4LTA0NzE2MmZmMWJhZDpmMWJmMGI1MC0yMDUyLTQ3ZmUtYjg3ZC01MTFjMmZlNzQ3MWk= description: Unique ID of the Video Mesh cluster. clusterName: type: string example: shangai description: Name of the Video Mesh cluster. nodes: type: array items: $ref: '#/components/schemas/PerNodeConnectivityResult2' ClusterUtilizationTrend1: type: object properties: timestamp: type: string example: '2022-03-23T10:30:00Z' description: Timestamp. clusters: type: array items: anyOf: - $ref: '#/components/schemas/ClusterUtilizationT1SJ' - $ref: '#/components/schemas/ClusterUtilizationT1Blr' ReachabilityTestResultsforsecondcluster: type: object properties: clusterId: type: string example: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzJjM2M5Zjk1LTczZDktNDQ2MC1hNjY4LTA0NzE2MmZmMWJhZDpmMWJmMGI1MC0yMDUyLTQ3ZmUtYjg3ZC01MTFjMmZlNzQ3MWk= description: Unique ID of the Video Mesh cluster. clusterName: type: string example: sanjose description: Name of the Video Mesh cluster. nodes: type: array items: anyOf: - $ref: '#/components/schemas/ReachabilityTestresultsfirstnode' - $ref: '#/components/schemas/ReachabilityTestresultssecondnode' description: The Video Mesh nodes in the cluster. UpdateEventThresholdResponse1: type: object properties: eventName: type: string example: clusterCallsRedirected description: Name of the event. eventThresholdId: type: string example: Y2lzY29zcGFyazovL3VzL0VWRU5ULzQyN2U5ZTk2LTczYTctNDYwYS04MGZhLTcyNWU4MWE2MDg3Zjo2YzJhZGRmMS0wYjAzLTRiZWEtYjIxYy0xYzFjYzdiY2UwOWQ description: Unique ID of the event threshold configuration. eventScope: type: string example: CLUSTER description: The `eventScope` is scope of event. entityId: type: string example: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzRiNTk5NzkwLWVlMzctMTFlZC1hMDViLTAyNDJhYzEyMDAwMzo2NjMxOTMyNC1lZTM3LTExZWQtYTA1Yi0wMjQyYWMxMjAwMDM description: The `entityId` is the unique ID of the Organization or the unique ID of the Video Mesh Cluster. thresholdConfig: $ref: '#/components/schemas/UpdateEventThresholdConfig1' description: Threshold configuration of an `entityId`. ReachabilityTestresultsfirstnode: type: object properties: nodeId: type: string example: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT05ORUNUT1IvMmMzYzlmOTUtNzNkOS00NDYwLWE2NjgtMDQ3MTYyZmYxYmFkOjE1NmRmNzg5Yzg1NTRkNTVhMjc1ZGY5OTc4Zjk5MDJk description: Unique ID of the Video Mesh node. hostNameOrIP: type: string example: xyz.company.com description: Host name or the IP of the Video Mesh node. testResults: type: array items: $ref: '#/components/schemas/ReachabilityTestresultsdestinationcluster' description: ' Reachability test results for a single Video Mesh node.' SingleNodeAvailabilityCollection: type: object properties: orgId: type: string example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8zNmQ4OTRmNy0yYjU3LTQzYzEtYWNlZS1kNDdlNjc3NjE0MTQ= description: Unique ID for a Video Mesh organization. items: type: array items: $ref: '#/components/schemas/SingleNodeAvailabilityObject' description: Availability details of the Video Mesh cluster. from: type: string example: '2021-09-15T15:53:00Z' description: Start date and time (inclusive) of the availability data. to: type: string example: '2021-09-15T17:53:00Z' description: End date and time (inclusive) of the availability data. ScheduleDays: type: string enum: - sunday - saturday - tuesday - friday - wednesday - thursday - monday securitySchemes: oauth2: flows: authorizationCode: authorizationUrl: / scopes: {} tokenUrl: / type: oauth2 bearer-key: type: http description: e.g. Bearer YOUR_AUTHORIZATION_TOKEN scheme: bearer bearerFormat: JWT bearerAuth: type: oauth2 description: OAuth 2.0 Bearer token authentication flows: authorizationCode: authorizationUrl: https://webexapis.com/v1/authorize tokenUrl: https://webexapis.com/v1/access_token scopes: spark:applications_token: Create access tokens for Service Apps