NSX-T Data Center REST API
ContainerGateway (schema)
Container gateway
A Gateway describes how traffic can be translated to Services
within the container cluster.
| Name | Description | Type | Notes |
|---|---|---|---|
| _last_sync_time | Timestamp of last modification | EpochMsTimestamp | Readonly Sortable |
| _links | References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST. |
array of ResourceLink | Readonly |
| _schema | Schema for this resource | string | Readonly |
| _self | Link to this resource | SelfResourceLink | Readonly |
| addresses | List of addresses bound to gateway Specifies addresses which lists the IP addresses that have actually been bound to the gateway. |
array of ContainerGatewayAddress | |
| container_cluster_id | Identifier of the container cluster Specifies identifier of the container cluster of this container gateway. |
string | |
| container_project_id | Identifier of the container project Specifies identifier of the container project of this container gateway. |
string | |
| description | Description of this resource | string | Maximum length: 1024 Sortable |
| display_name | Identifier to use when displaying entity in logs or GUI Defaults to ID if not set |
string | Maximum length: 255 Sortable |
| external_id | External identifier of the container gateway Specifies identifier of the container gateway. |
string | Required |
| listeners | List of listener Specifies list of listeners which defines logical endpoints that are bound on this Gateway's addresses. |
array of ContainerGatewayListener | |
| origin_properties | Origin properties Array of additional specific properties of container ip pool in key-value format. |
array of KeyValuePair | |
| resource_type | Must be set to the value ContainerGateway | string | Required |
| scope | List of scopes for discovered resource 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. |
array of DiscoveredResourceScope | |
| spec | Container gateway specification This specifies yaml definition of ContainerGateway resource. |
string | |
| tags | Opaque identifiers meaningful to the API user | array of Tag | Maximum items: 30 |