List of APIs - Get Cluster Availability

Get Cluster Availability

Returns the availability details of a single Video Mesh cluster in an organization.

GET/v1/videoMesh/clusters/availability/{clusterId}

URI Parameters

clusterId

stringrequired

The unique Video Mesh clusterID

Query Parameters

from

stringrequired

The starting date and time of the requested data in any ISO 8601 compliant format. from cannot be after to.

stringrequired

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

Response Properties

items

array[Cluster Availability Collection]

orgId

string

The unique ID for the organization.

items

array[ClusterAvailability]

Availability details of the Video Mesh cluster.

clusterId

string

ID of the Video Mesh cluster.

clusterName

string

Name of the Video Mesh cluster.

availabilitySegments

array[ClusterAvailableTimeline]

segmentStartTime

string

Start date and time of the segment of availability data.

segmentEndTime

string

End date and time of the segment of availability data.

availability

string

Availability information of the Video Mesh cluster.

noOfOnlineNodes

number

Number of nodes that are online.

noOfOfflineNodes

number

Number of nodes that are offline.

totalNodes

number

Total number of nodes in the Video Mesh cluster.

from

string

Start date and time (inclusive) of the availability data.

string

End date and time (inclusive) of the availability data.

Response Codes

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

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

GET

/v1/videoMesh/clusters/availability/{?from,to}

Header

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

Query Parameters

from
stringRequired
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`.
to
stringRequired
The ending date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.

https://webexapis.com/v1/videoMesh/clusters/availability/Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzFlYjY1ZmRmLTk2NDMtNDE3Zi05OTc0LWFkNzJjYWUwZTEwZjpiMzdmNTgzYy1kZGRjLTQyOGItODJlNS1jYmU2ODFkYjQ5NjI?from=2021-09-15T15:53:00Z&to=2021-09-15T17:53:00Z

200 / OK

{
  "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"
    }
  ]
}