NSX-T Data Center REST API

ContainerGateway (type)

{
  "description": "A Gateway describes how traffic can be translated to Services within the container cluster.", 
  "extends": {
    "$ref": "DiscoveredResource
  }, 
  "id": "ContainerGateway", 
  "module_id": "InventoryContainerObj", 
  "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"
    }, 
    "addresses": {
      "description": "Specifies addresses which lists the IP addresses that have actually been bound to the gateway.", 
      "items": {
        "$ref": "ContainerGatewayAddress
      }, 
      "readonly": false, 
      "required": false, 
      "title": "List of addresses bound to gateway", 
      "type": "array"
    }, 
    "container_cluster_id": {
      "description": "Specifies identifier of the container cluster of this container gateway.", 
      "readonly": false, 
      "required": false, 
      "title": "Identifier of the container cluster", 
      "type": "string"
    }, 
    "container_project_id": {
      "description": "Specifies identifier of the container project of this container gateway.", 
      "readonly": false, 
      "required": false, 
      "title": "Identifier of the container project", 
      "type": "string"
    }, 
    "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": "Specifies identifier of the container gateway.", 
      "readonly": false, 
      "required": true, 
      "title": "External identifier of the container gateway", 
      "type": "string"
    }, 
    "listeners": {
      "description": "Specifies list of listeners which defines logical endpoints that are bound on this Gateway's addresses.", 
      "items": {
        "$ref": "ContainerGatewayListener
      }, 
      "readonly": false, 
      "required": false, 
      "title": "List of listener", 
      "type": "array"
    }, 
    "origin_properties": {
      "description": "Array of additional specific properties of container ip pool in key-value format.", 
      "items": {
        "$ref": "KeyValuePair
      }, 
      "readonly": false, 
      "required": false, 
      "title": "Origin properties", 
      "type": "array"
    }, 
    "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"
    }, 
    "spec": {
      "description": "This specifies yaml definition of ContainerGateway resource.", 
      "readonly": false, 
      "required": false, 
      "title": "Container gateway specification", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Container gateway", 
  "type": "object"
}