Query Object Stats (v2.4)

POST 
/v2.4/api/tenants/:tenant_id/monitor/object_stats

Query and get object statistics.

Request

Path Parameters

tenant_id stringrequired

ID of the tenant.

application/json

Body

Details of object stats query

end_time date

The end time of the object stats query.

filter ObjectStatsFilterrequired

Filters according to the specifications.

element string[]

The object stats query element.

site string[]required

The object stats query site.

name string

The name of the object stats. Maz size = 128.

object_id stringrequired

The object ID.

object_type stringrequired

Possible values: [PeerStatistics, IntfStatistics, CellularModuleStatistics, CellularAPNStatistics, CellularAPNV6Statistics, MulticastStatistics, SecurityPolicyRule, IntfPoEStatistics, IntfLLDPStatistics, IntfAAAStatistics, IntfSTPStatistics, STPStatistics, PoEStatistics, AppSummaryStats]

The object type.

start_time date

The start time of the object stats query.

Responses

200

Successful Operation

application/json

Schema

Schema

data object

Example (from schema)

{
  "data": {}
}

400

Bad Request

application/json

Schema

Schema

_error ErrorResponse[]
Array [
code string
The error code.
message string
The error message.
]

Example (from schema)

{
  "_error": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "value": {
    "_error": [
      {
        "code": "INVALID_REQUEST_ERROR_0001"
      },
      {
        "code": "OBJECT_STATS_QUERY_OBJECT_TYPE_REQUIRED"
      },
      {
        "code": "OBJECT_STATS_QUERY_OBJECT_ID_REQUIRED"
      },
      {
        "code": "OBJECT_STATS_QUERY_FILTER_REQUIRED"
      },
      {
        "code": "OBJECT_STATS_QUERY_FILTER_SITE_ID_REQUIRED"
      },
      {
        "code": "OBJECT_STATS_QUERY_OBJECT_TYPE_UNSUPPORTED"
      },
      {
        "code": "OBJECT_STATS_QUERY_OBJECT_ID_INVALID_VALUE"
      },
      {
        "code": "OBJECT_STATS_QUERY_ELEMENT_ID_INVALID_VALUE"
      },
      {
        "code": "OBJECT_STATS_QUERY_SITE_ID_INVALID_VALUE"
      },
      {
        "code": "OBJECT_STATS_QUERY_ELEMENT_LIST_LENGTH_EXCEEDED"
      },
      {
        "code": "OBJECT_STATS_QUERY_SITE_LIST_LENGTH_EXCEEDED"
      },
      {
        "code": "OBJECT_STATS_QUERY_START_TIME_BEFORE_END_TIME"
      },
      {
        "code": "INVALID_STATS_REQUEST_BODY"
      },
      {
        "code": "FUTURE_TIME_ERROR"
      }
    ]
  }
}

Loading...