Get Cluster Utilization details
Returns the utilization details for a single Video Mesh cluster.
GET/v1/videoMesh/clusters/utilization
Query Parameters
Response Properties
items
array[Utilization For Cluster Collection]
orgId
string
The unique ID for the organization.
aggregationInterval
string
The aggregation period of the trend data.
from
string
Start date and time (inclusive) of the utilization data.
to
string
End date and time (inclusive) of the utilization data.
items
array[UtilizationForClusterTrend1]
Utilization details of the Video Mesh cluster.
timestamp
string
Timestamp.
clusters
array[ClusterUtilizationT1Blr]
clusterId
string
ID of the Video Mesh cluster.
clusterName
string
Name of the Video Mesh cluster.
utilizationMetrics
UtilizationMetricsT1Blr
Utilization details for the cluster in the time interval.
peakCpu
number
Peak CPU usage during the time interval.
avgCpu
number
Average CPU usage during the time interval.
activeCalls
number
Maximum active calls at a point in the time interval.
activePrivateCalls
number
Maximum active private calls at a point in the time interval.
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/utilization{?from,to,clusterId}
Log in to try the API.
Header
Query Parameters
- 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`.
- The ending date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.
- The unique Video Mesh Cluster ID.
https://webexapis.com/v1/videoMesh/clusters/utilization?from=2021-09-15T15:53:00Z&to=2021-09-15T17:53:00Z&clusterId=Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzFlYjY1ZmRmLTk2NDMtNDE3Zi05OTc0LWFkNzJjYWUwZTEwZjpiMzdmNTgzYy1kZGRjLTQyOGItODJlNS1jYmU2ODFkYjQ5NjI
200 / OK
{
"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
}
}
]
}
]
}
]
}