List of APIs - List Overflow to Cloud details

List Overflow to Cloud details

Returns details of overflows to the cloud in an organization.

GET/v1/videoMesh/cloudOverflow

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.

orgId

stringrequired

The unique Video Mesh organization ID.

Response Properties

items

array[Overflow to Cloud Collection]

orgId

string

The unique ID for the organization.

from

string

Start date and time (inclusive) for the Overflow to Cloud data.

string

End date and time (inclusive) for the Overflow to Cloud data.

aggregationInterval

string

The aggregation period of the trend data.

items

array[CloudOverflowTrend1]

Overflow data for the organization.

timestamp

string

Timestamp.

overflowDetails

array[OverflowDetails1]

Overflow Details.

overflowReason

string

The reason for this overflow.

overflowCount

number

Number of overflows.

possibleRemediation

string

Any possible remediations for this overflow.

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/cloudOverflow{?from,to,orgId}

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.
orgId
stringRequired
The unique Video Mesh organization ID.

https://api-usgov.webex.com/v1/videoMesh/cloudOverflow?from=2021-09-15T15:53:00Z&to=2021-09-15T17:53:00Z&orgId=Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8zNmQ4OTRmNy0yYjU3LTQzYzEtYWNlZS1kNDdlNjc3NjE0MTQ

200 / OK

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