NSX-T Data Center REST API

EdgeClusterListRequestParameters (type)

{
  "additionalProperties": false,
  "extends": {
    "$ref": "ListRequestParameters"
  },
  "id": "EdgeClusterListRequestParameters",
  "module_id": "EdgeClusters",
  "properties": {
    "cursor": {
      "readonly": false,
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
      "type": "string"
    },
    "include_vna_clusters": {
      "description": "When include_vna_clusters query parameter is set to true then virtual network appliance clusters will be included in the listing along with edge clusters. When set to false then only edge clusters will be displayed in listing. When include_vna_clusters query parameter is not used then by default edge clusters will be displayed in listing.",
      "nsx_feature": "ServiceVmVpcSupportForDTGW",
      "required": false,
      "title": "Edge Service Clusters will be included in the edge-cluster listing",
      "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": {
      "title": "If true, results are sorted in ascending order",
      "type": "boolean"
    },
    "sort_by": {
      "title": "Field by which records are sorted",
      "type": "string"
    }
  },
  "title": "Edge cluster listing parameters",
  "type": "object"
}