Get Segment Statistics

Get tier1 segment statistics information.

Request

URI

GET

https://nsxmanager.your.domain/policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segments-id}/statistics

COPY

Path Parameters

string

tier-1-id

Required

tier-1-id

string

segments-id

Required

segments-id

Query Parameters

string

cursor

Optional

Opaque cursor to be used for getting next page of records (supplied by current result page)

string

edge_path

Optional

Policy path of edge node

string

enforcement_point_path

Optional

String Path of the enforcement point

boolean

include_mark_for_delete_objects

Optional

Include objects that are marked for deletion in results

string

included_fields

Optional

Comma separated list of fields that should be included in query result

integer

page_size

Optional

Maximum number of results to return in this page (server may return fewer)

boolean

sort_ascending

Optional

sort_ascending

string

sort_by

Optional

Field by which records are sorted

Authentication

This operation uses the following authentication methods.

BasicAuth

Responses

200

Returns SegmentStatistics of type(s) application/json

This response body class contains all of the following: LogicalSwitchStatistics

{
    "rx_bytes": {
        "dropped": 0,
        "multicast_broadcast": 0,
        "total": 0
    },
    "rx_packets": {
        "dropped": 0,
        "multicast_broadcast": 0,
        "total": 0
    },
    "tx_bytes": {
        "dropped": 0,
        "multicast_broadcast": 0,
        "total": 0
    },
    "tx_packets": {
        "dropped": 0,
        "multicast_broadcast": 0,
        "total": 0
    },
    "dropped_by_security_packets": {
        "bpdu_filter_dropped": 0,
        "dhcp_client_dropped_ipv4": 0,
        "dhcp_client_dropped_ipv6": 0,
        "dhcp_server_dropped_ipv4": 0,
        "dhcp_server_dropped_ipv6": 0,
        "spoof_guard_dropped": [
            {
                "counter": 0,
                "packet_type": "string"
            }
        ]
    },
    "mac_learning": {
        "mac_not_learned_packets_allowed": 0,
        "mac_not_learned_packets_dropped": 0,
        "macs_learned": 0
    },
    "last_update_timestamp": 0,
    "logical_switch_id": "string"
}

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"
        }
    ]
}

On This Page

Description

Request

Path Parameters

Query Parameters

Authentication

Response

200 Response Body

Errors

Tier 1s Operations

PUT

Create Or Replace Segment