Developer Documentation
Get Gateway Policy Rule Statistics
Get statistics of a gateway rule. - no enforcement point path specified: Stats will be evaluated on each enforcement. point. - {enforcement_point_path}: Stats are evaluated only on the given enforcement point.
Request
URLURL
https://nsxmanager.your.domain/policy/api/v1/infra/domains/{domain-id}/gateway-policies/{gateway-policy-id}/rules/{rule-id}/statistics
Path Parameters
Path Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | Not available |
| required |
|
string | Not available |
| required |
|
string | Not available |
Query Parameters
Query Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| optional |
|
string | String Path of the enforcement point |
Response
Response
Response BodyResponse Body
200 OK returns
RuleStatisticsListResult
{
"_links": [
{
"action": "string",
"href": "string",
"rel": "string"
}
],
"_schema": "string",
"_self": {
"action": "string",
"href": "string",
"rel": "string"
},
"cursor": "string",
"result_count": 0,
"results": [
{
"enforcement_point": "string",
"statistics": {
"_links": [
{
"action": "string",
"href": "string",
"rel": "string"
}
],
"_schema": "string",
"_self": {
"action": "string",
"href": "string",
"rel": "string"
},
"byte_count": 0,
"hit_count": 0,
"internal_rule_id": "string",
"lr_path": "string",
"max_popularity_index": 0,
"max_session_count": 0,
"packet_count": 0,
"popularity_index": 0,
"rule": "string",
"session_count": 0,
"total_session_count": 0
}
}
],
"sort_ascending": false,
"sort_by": "string"
}| Property Name | Type | Description |
|---|---|---|
| _links | array of ResourceLink |
The server will populate this field when returing the resource. Ignored on PUT and POST. |
| _schema | string |
Schema for this resource |
| _self | SelfResourceLink |
Link to this resource |
| cursor | string |
Opaque cursor to be used for getting next page of records (supplied by current result page) |
| result_count | integer |
Count of results found (across all pages), set only on first page |
| results | array of RuleStatisticsForEnforcementPoint |
RuleStatistics list results |
| sort_ascending | boolean |
If true, results are sorted in ascending order |
| sort_by | string |
Field by which records are sorted |
Errors
| Code | Returns | Description |
|---|---|---|
| 500 | InternalServerError | The server encountered an unexpected condition which prevented it from fulfilling the request. |
| 503 | ServiceUnavailable | The server is currently unavailable (because it is overloaded or down for maintenance). |
| 400 | BadRequest | The request cannot be fulfilled due to bad syntax. |
| 403 | Forbidden | The server understood the request, but is refusing to fulfill it. |
| 404 | Nothing | Not Found |
| 412 | PreconditionFailed | Not available |
On This Page
Gateway Policies Operations
delete
delete
