NSX-T Data Center REST API

TransportNodeHealthParameters (type)

{
  "extends": {
    "$ref": "ListWithDataSourceParameters"
  },
  "id": "TransportNodeHealthParameters",
  "module_id": "SystemHealth",
  "properties": {
    "compact_mode": {
      "description": "This parameter is used to decide whether the caller needs more compact response body. If it is absent or the value is false, the response will contain full information. Otherwise, it means the response just provides necessary runtime information and avoid duplicating description information which is already provided by corresponding metadata API.",
      "title": "Enable compact response mode",
      "type": "boolean"
    },
    "cursor": {
      "readonly": false,
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
      "type": "string"
    },
    "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"
    },
    "node_id": {
      "description": "This parameter is to filter the specific transport node. If not provide any node_id, it means query all transport node.",
      "title": "The UUID of transport node",
      "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": {
      "title": "If true, results are sorted in ascending order",
      "type": "boolean"
    },
    "sort_by": {
      "title": "Field by which records are sorted",
      "type": "string"
    },
    "source": {
      "$ref": "DataSourceType",
      "required": false,
      "title": "The data source, either realtime or cached. If not provided, cached data is returned."
    }
  },
  "type": "object"
}