Get Segment Statistics

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.
Responses
200

OK

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

Tier 1s Operations
PUT
Create Or Replace Segment
PUT
Create Or Replace Static ARP Config
PUT
Create Or Replace Tier1 Segment Port
PUT
Create Or Update Port Security Profile Binding
PUT
Create Or Update Segment Security Profile Binding
DELETE
Delete Port Discovery Binding
DELETE
Delete Port Monitoring Binding
DELETE
Delete Port Qo S Binding
DELETE
Delete Port Security Profile Binding
DELETE
Delete Segment
DELETE
Delete Segment Discovery Binding
DELETE
Delete Segment Monitoring Binding
DELETE
Delete Segment Qo S Binding
DELETE
Delete Segment Security Profile Binding
DELETE
Delete Static ARP Config
DELETE
Delete Tier1 Segment Port
DELETE
Force Delete Segment True
GET
Get Port Discovery Binding
GET
Get Port Monitoring Binding
GET
Get Port Qo S Binding
GET
Get Port Security Profile Binding
GET
Get Segment Discovery Binding
GET
Get Segment Monitoring Binding
GET
Get Segment Port Statistics
GET
Get Segment Qo S Binding
GET
Get Segment Security Profile Binding
GET
Get Segment Statistics
GET
Get Tier1 Segment Port
GET
List Port Discovery Bindings
GET
List Port Monitoring Bindings
GET
List Port Qo S Bindings
GET
List Port Security Profile Bindings
GET
List Segment Discovery Bindings
GET
List Segment Monitoring Bindings
GET
List Segment Qo S Bindings
GET
List Segments
GET
List Segment Security Profile Bindings
GET
List Tier1 Segment Ports
PATCH
Patch Port Discovery Binding
PATCH
Patch Port Monitoring Binding
PATCH
Patch Port Qo S Binding
PATCH
Patch Port Security Profile Binding
PATCH
Patch Segment
PATCH
Patch Segment Discovery Binding
PATCH
Patch Segment Monitoring Binding
PATCH
Patch Segment Qo S Binding
PATCH
Patch Segment Security Profile Binding
PATCH
Patch Static ARP Config
PATCH
Patch Tier1 Segment Port
GET
Read Segment
GET
Read Static ARP Config
PUT
Update Port Discovery Binding
PUT
Update Port Monitoring Binding
PUT
Update Port Qo S Binding
PUT
Update Segment Discovery Binding
PUT
Update Segment Monitoring Binding
PUT
Update Segment Qo S Binding