NSX-T Data Center REST API

ZoneListRequestParameters (type)

{
  "additionalProperties": false,
  "extends": {
    "$ref": "ListRequestParameters"
  },
  "id": "ZoneListRequestParameters",
  "module_id": "InventoryCmObj",
  "nsx_feature": "VpcTgwSpan",
  "properties": {
    "cm_local_id": {
      "description": "The zone id/ name as is received from the compute manager, e.g. \"california-zone\"",
      "required": false,
      "title": "Zone local id",
      "type": "string"
    },
    "compute_collection_external_id": {
      "description": "External id of the compute collection (cluster), that is associated with a zone",
      "required": false,
      "title": "Compute collection external id",
      "type": "string"
    },
    "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"
    },
    "origin_id": {
      "description": "Id of the compute manager from where the zone was discovered, e.g. \"ecd5d517-db8d-46cf-bf52-f7e3663b7232\"",
      "required": false,
      "title": "Zone origin id",
      "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": "Zone list parameters",
  "type": "object"
}