List of APIs - Get Cluster Details | Webex for Developers

Get Cluster Details

Returns the cluster details for a single Video Mesh cluster.

GET/v1/videoMesh/clusters/{clusterId}

URI Parameters

clusterId

stringrequired

The unique Video Mesh Cluster ID.

Response Properties

items

array[Specific Cluster Details Collection]

orgId

string

The unique ID for the organization.

items

array[BlrClusterDetails]

Details of the cluster.

clusterId

string

ID of the Video Mesh cluster.

clusterName

string

Name of the Video Mesh cluster.

nodes

array[BlrNode1]

The Video Mesh nodes in the cluster.

nodeId

string

ID of the Video Mesh node.

hostNameOrIp

string

Host Name or the IP of the Video Mesh node.

deploymentType

string

Deployment Type of the Video Mesh node.

location

BlrNodeLocation

Location details of the Video Mesh node.

countryCode

string

Country code of the Location where the Video Mesh node is deployed.

city

string

City where Video Mesh node is deployed.

timeZone

string

Time zone in which the Video Mesh node is deployed.

releaseChannel

string

Release Channel of the Video Mesh cluster.

upgradeSchedule

ClusterUpgradeScheduleBlr

Upgrade Schedule details of the Video Mesh cluster.

scheduleDays

array[string]

Days of the week when scheduled upgrades will occur for the Video Mesh cluster.

scheduleTime

string

Time when scheduled upgrade will occur for the Video Mesh cluster.

scheduleTimeZone

string

Timezone of the scheduled upgrade of Video Mesh cluster.

upgradePending

boolean

Upgrade Pending information.

nextUpgradeTime

string

Time when the next upgrade is scheduled for the Video Mesh cluster.

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/

Header

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

https://webexapis.com/v1/videoMesh/clusters/Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzFlYjY1ZmRmLTk2NDMtNDE3Zi05OTc0LWFkNzJjYWUwZTEwZjpiMzdmNTgzYy1kZGRjLTQyOGItODJlNS1jYmU2ODFkYjQ5NjI

200 / OK

{
  "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",
              "monday",
              "tuesday"
            ],
            "scheduleTime": "02:00",
            "scheduleTimeZone": "Asia/Kolkata",
            "upgradePending": true,
            "nextUpgradeTime": "2020-03-25T20:30:00Z"
          }
        }
      ]
    }
  ]
}