Get tier-1 interface statistics summary information

Get tier-1 interface statistics information.

Request:

Method:

GET

URI Path(s):

/policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/interfaces/{interface-id}/statistics/summary
/policy/api/v1/global-infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/interfaces/{interface-id}/statistics/summary
/policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/interfaces/{interface-id}/statistics/summary

Request Headers:

n/a

Query Parameters:

BaseListRequestParameters+

Name	Description	Type	Notes
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string
enforcement_point_path	Enforcement point path String Path of the enforcement point. When not specified, routes from all enforcement-points are returned. This property is required for retrieving routes in CSV format.	string
included_fields	Comma separated list of fields that should be included in query result Note - this parameter currently only works when used with the search APIs /policy/api/v1/search/query and /policy/api/v1/search/dsl. It is ignored for other list APIs.	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
sort_ascending		boolean
sort_by	Field by which records are sorted	string

Request Body:

n/a

Example Request:

GET https://<policy-mgr>/policy/api/v1/infra/tier-1s/it_t1/locale-services/1-policyconnectivity-252/interfaces/lt1-if-1/statistics/summary?enforcement_point_path=/infra/sites/default/enforcement-points/default

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

PolicyInterfaceStatisticsSummary+

Name	Description	Type	Notes
interface_policy_path	Policy path for the interface Policy path for the interface	string
last_update_timestamp	Timestamp when the data was last updated; unset if data source has never updated the data.	EpochMsTimestamp	Readonly
logical_router_port_id	The ID of the logical router port	string	Required
rx		LogicalRouterPortCounters	Readonly
tx		LogicalRouterPortCounters	Readonly

Example Response:

{ "logical_router_port_id": "b109909a-81a1-4c25-bb54-ce4d0e75b6ad", "per_node_statistics": [ { "transport_node_id": "2ed9af04-21c9-11e9-be65-000c2902dff7", "last_update_timestamp": 1548965795630, "rx": { "total_bytes": 0, "total_packets": 0, "dropped_packets": 0 }, "tx": { "total_bytes": 642, "total_packets": 13, "dropped_packets": 0 } } ] }

Get tier-1 interface statistics summary information

Request:

BaseListRequestParameters (schema)

Example Request:

Successful Response:

PolicyInterfaceStatisticsSummary (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: