Get Gateway Rule Statistics

Get Gateway 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
URI
GET
https://nsxmanager.your.domain/policy/api/v1/infra/domains/{domain-id}/gateway-policies/{gateway-policy-id}/rules/{rule-id}/statistics
COPY
Path Parameters
string
domain-id
Required

domain-id

string
gateway-policy-id
Required

gateway-policy-id

string
rule-id
Required

rule-id

Query Parameters
string
enforcement_point_path
Optional

String Path of the enforcement point


Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns RuleStatisticsListResult of type(s) application/json
This response body class contains all of the following: ListResult , InlineRuleStatisticsListResult1
{
    "_links": [
        {
            "action": "string",
            "href": "string",
            "rel": "string"
        }
    ],
    "_schema": "string",
    "_self": {
        "action": "string",
        "href": "string",
        "rel": "string"
    },
    "cursor": "string",
    "result_count": 0,
    "sort_ascending": false,
    "sort_by": "string",
    "results": [
        {
            "enforcement_point": "string",
            "statistics": {
                "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
            }
        }
    ]
}

400
Returns BadRequest of type(s) application/json
This response body class contains all of the following: RelatedApiError , InlineApiError1
{
    "details": "string",
    "error_code": 0,
    "error_message": "string",
    "module_name": "string",
    "related_errors": [
        {
            "details": "string",
            "error_code": 0,
            "error_message": "string",
            "module_name": "string"
        }
    ]
}

403
Returns Forbidden of type(s) application/json
This response body class contains all of the following: RelatedApiError , InlineApiError1
{
    "details": "string",
    "error_code": 0,
    "error_message": "string",
    "module_name": "string",
    "related_errors": [
        {
            "details": "string",
            "error_code": 0,
            "error_message": "string",
            "module_name": "string"
        }
    ]
}

404

Not Found

Operation doesn't return any data structure

412
Returns PreconditionFailed of type(s) application/json
This response body class contains all of the following: RelatedApiError , InlineApiError1
{
    "details": "string",
    "error_code": 0,
    "error_message": "string",
    "module_name": "string",
    "related_errors": [
        {
            "details": "string",
            "error_code": 0,
            "error_message": "string",
            "module_name": "string"
        }
    ]
}

500
Returns InternalServerError of type(s) application/json
This response body class contains all of the following: RelatedApiError , InlineApiError1
{
    "details": "string",
    "error_code": 0,
    "error_message": "string",
    "module_name": "string",
    "related_errors": [
        {
            "details": "string",
            "error_code": 0,
            "error_message": "string",
            "module_name": "string"
        }
    ]
}

503
Returns ServiceUnavailable of type(s) application/json
This response body class contains all of the following: RelatedApiError , InlineApiError1
{
    "details": "string",
    "error_code": 0,
    "error_message": "string",
    "module_name": "string",
    "related_errors": [
        {
            "details": "string",
            "error_code": 0,
            "error_message": "string",
            "module_name": "string"
        }
    ]
}