1. REST API for Session Border Controller, Enterprise Session Border Controller, and Subscriber-Aware Load Balancer, Release 9.3.0
  2. Tasks
  3. statistics

Get current HDR collections status

get

https://{managementIp}/rest/{version}/statistics/collections

Retrieves the current status of all Historical Data Records (HDR) collections and push receivers.

This API is only available for SBC and ESBC.

Request

Path Parameters
Header Parameters
  • The value in the Authorization header must be the string "Bearer {access token}", where {access token} is a valid, unexpired token received in response to a prior /rest/{version}/auth/token request.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

OK - Requested data is returned in response body
Body ()
Root Schema : response
Type: object
Show Source
Nested Schema : data
Type: object
Show Source
Nested Schema : messages
Type: object
Nested Schema : collectionStatus
Type: object
Show Source
Nested Schema : groups
Type: array
Show Source
Nested Schema : push
Type: object
Show Source
Nested Schema : pushReceivers
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : group
Type: object
Show Source
Nested Schema : startTime
Match One Schema
Show Source
  • Example: 2018-09-05T08:41:55.0-0400
  • Allowed Values: [ "now", "never" ]
Nested Schema : items
Match One Schema
Show Source
  • Example: 2018-09-05T08:41:55.0-0400
  • Allowed Values: [ "now", "never" ]
Nested Schema : items
Type: object
Show Source
Nested Schema : pushReceiver
Type: object
Show Source

400 Response

The request is malformed in some way or is missing required information and therefore cannot be processed.
Body ()
Root Schema : response
Type: object
Show Source
Nested Schema : data
Type: object
Nested Schema : messages
Type: array
Show Source
Nested Schema : items
Type: object
Show Source

401 Response

Unauthorized - Request lacks valid authentication credentials.
Body ()
Root Schema : response
Type: object
Show Source
Nested Schema : data
Type: object
Nested Schema : messages
Type: array
Show Source
Nested Schema : items
Type: object
Show Source

404 Response

Resource not found
Body ()
Root Schema : response
Type: object
Show Source
Nested Schema : data
Type: object
Nested Schema : messages
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Back to Top

Examples

Examples of Accessing the API

See Authenticate for how to acquire a token.

The following example shows how to get current HDR collections status using curl.

curl -X GET \
    --header "Accept: application/xml" \
    --header "Authorization: Bearer $TOKEN" \
    "https://${SBCIP}/rest/v1.2/statistics/collections"

The following example shows how to get current HDR collections status using Python.

import requests
headers = { "Accept":"application/xml", "Authorization":"Bearer " + token }
url  = "https://" + sbcip + "/rest/v1.2/statistics/collections"
resp = requests.get(url, headers=headers)

Example of the Response Body

The following example shows the contents of the response body in XML.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<response>
  <data>
    <collectionStatus>
      <status>running</status>
      <groups>
        <group>
          <name>temperature</name>
          <bootState>disabled</bootState>
          <startTime>now</startTime>
          <endTime>never</endTime>
        </group>
      </groups>
      <push>
        <nextPush>2019-01-16T09:01:05-0500</nextPush>
        <subsequentPushMinutes>5</subsequentPushMinutes>
      </push>
      <pushReceivers>
        <pushReceiver>
          <address>10.4.4.4</address>
          <state>reachable</state>
        </pushReceiver>
      </pushReceivers>
    </collectionStatus>
  </data>
  <messages/>
  <links/>
</response>
Back to Top