NSX-T Data Center REST API

Zone (type)

{
  "additionalProperties": false,
  "extends": {
    "$ref": "DiscoveredResource"
  },
  "id": "Zone",
  "module_id": "InventoryCmObj",
  "nsx_feature": "VpcTgwSpan",
  "properties": {
    "_last_sync_time": {
      "$ref": "EpochMsTimestamp",
      "can_sort": true,
      "description": "Timestamp of last modification",
      "readonly": true
    },
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.",
      "items": {
        "$ref": "ResourceLink"
      },
      "readonly": true,
      "title": "References related to this resource",
      "type": "array"
    },
    "_schema": {
      "readonly": true,
      "title": "Schema for this resource",
      "type": "string"
    },
    "_self": {
      "$ref": "SelfResourceLink",
      "readonly": true,
      "title": "Link to this resource"
    },
    "cm_local_id": {
      "description": "This is the zone id as is received from the compute manager, e.g. \"california-zone\"",
      "readonly": true,
      "required": true,
      "title": "Zone local id",
      "type": "string"
    },
    "compute_collection_external_ids": {
      "description": "Collection of external ids of the compute collections (clusters), that are associated with this zone",
      "items": {
        "type": "string"
      },
      "readonly": false,
      "required": true,
      "title": "Compute collection external ids",
      "type": "array"
    },
    "description": {
      "can_sort": true,
      "maxLength": 1024,
      "title": "Description of this resource",
      "type": "string"
    },
    "display_name": {
      "can_sort": true,
      "description": "Defaults to ID if not set",
      "maxLength": 255,
      "title": "Identifier to use when displaying entity in logs or GUI",
      "type": "string"
    },
    "external_id": {
      "description": "Combination of zone's compute manager id and the zone id, e.g. \"ecd5d517-db8d-46cf-bf52-f7e3663b7232:california-zone\"",
      "readonly": true,
      "required": true,
      "title": "External id of the zone",
      "type": "string"
    },
    "origin_id": {
      "description": "Id of the compute manager from where this zone was discovered, e.g. \"ecd5d517-db8d-46cf-bf52-f7e3663b7232\"",
      "readonly": true,
      "required": true,
      "title": "Zone origin id",
      "type": "string"
    },
    "resource_type": {
      "description": "The type of this resource.",
      "readonly": false,
      "required": true,
      "type": "string"
    },
    "scope": {
      "description": "Specifies list of scope of discovered resource. e.g. if VHC path is associated with principal identity, who owns the discovered resource, then scope id will be VHC path and scope type will be VHC.",
      "items": {
        "$ref": "DiscoveredResourceScope"
      },
      "readonly": false,
      "required": false,
      "title": "List of scopes for discovered resource",
      "type": "array"
    },
    "tags": {
      "items": {
        "$ref": "Tag"
      },
      "maxItems": 30,
      "title": "Opaque identifiers meaningful to the API user",
      "type": "array"
    }
  },
  "type": "object"
}