NSX-T Data Center REST API

L2L3RuntimeRequestParameters (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "PolicyListRequestParameters
  }, 
  "id": "L2L3RuntimeRequestParameters", 
  "module_id": "PolicyConnectivityStatistics", 
  "properties": {
    "bgp_neighbor_type": {
      "description": "Bgp neighbor type that can be used as filter for T0 bgp neighbor status filter.", 
      "enum": [
        "INTER_SR", 
        "USER"
      ], 
      "required": false, 
      "title": "Bgp neighbor type", 
      "type": "string"
    }, 
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "edge_path": {
      "description": "Policy path of edge node. Edge should be member of enforcement point.", 
      "title": "Policy path of edge node", 
      "type": "string"
    }, 
    "enforcement_point_path": {
      "description": "Enforcement point path.", 
      "title": "String Path of the enforcement point", 
      "type": "string"
    }, 
    "include_mark_for_delete_objects": {
      "default": false, 
      "description": "If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.", 
      "required": false, 
      "title": "Include objects that are marked for deletion in results", 
      "type": "boolean"
    }, 
    "included_fields": {
      "description": "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.", 
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }, 
    "source": {
      "$ref": "DataSourceType, 
      "description": "The data source can be either realtime or cached. If not provided, cached data is returned.", 
      "experimental": true, 
      "required": false, 
      "title": "Source of statistics data"
    }, 
    "stats_type": {
      "description": "This indicates the type of statistics being requested. We support statistics from the data plane.", 
      "enum": [
        "DATAPATH_STATS"
      ], 
      "experimental": true, 
      "required": false, 
      "title": "Segment statistics type", 
      "type": "string"
    }, 
    "transport_node_id": {
      "description": "Identifer of the transport node. This is a UUID.", 
      "experimental": true, 
      "required": false, 
      "title": "Transport Node Id", 
      "type": "string"
    }
  }, 
  "title": "L2 L3 connectivity runtime status request parameters", 
  "type": "object"
}