NSX-T Data Center REST API

Returns an container gateway

Returns information about a specific container gateway.

Request:

Method:

GET

URI Path(s):

/api/v1/fabric/container-gateway/{gateway-id}

Request Headers:

n/a

Query Parameters:

n/a

Request Body:

n/a

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

ContainerGateway+

ContainerGateway (schema)

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

Example Response:

{ "external_id": "a241768e-6026-11e9-980c-dca9048e157d", "container_cluster_id": "a19ad270-6026-11e9-980c-dca9048e157d", "container_project_id": "a19ad270-6026-11e9-980c-dca9048e157e", "spec": "!!python/unicode 'podSelector':\n !!python/unicode 'matchLabels': {!!python/unicode 'app': !!python/unicode 'mgmtapp'}\n!!python/unicode 'policyTypes': [!!python/unicode 'gateway']\n", "origin_properties": [ { "key": "prop0", "value": "val0" } ], "resource_type": "ContainerGateway", "display_name": "gateway-1", "_last_sync_time": 1555405484377 }

Required Permissions:

read

Feature:

containers_inventory

Additional Errors:

• 404 Not Found
• 301 Moved Permanently
• 307 Temporary Redirect
• 400 Bad Request
• 403 Forbidden
• 409 Conflict
• 412 Precondition Failed
• 500 Internal Server Error
• 503 Service Unavailable