NSX-T Data Center REST API

Returns an container ip pool

Returns information about a specific container ip pool.

Request:

Method:

GET

URI Path(s):

/api/v1/fabric/container-ip-pool/{ip-pool-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:

ContainerIpPool+

ContainerIpPool (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
container_cluster_id	Identifier of the container cluster Specifies identifier of the container cluster this container ip pool belongs to.	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 ip pool Specifies identifier of the container ip pool.	string	Required
ip_ranges	List of IP ranges with subnet details Specifies list of SubnetIpRange, which is a set of contiguous IP addresses, represented by a CIDR or a pair of start and end IPs, along with subnet definition.	array of SubnetIpRange
ip_version	IP version of ContainerIpPool Specifies IP version of container IP pool.	integer	Enum: 4, 6
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 ContainerIpPool	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 ip pool specification This specifies yaml definition of ContainerIpPool 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", "spec": "!!python/unicode 'podSelector':\n !!python/unicode 'matchLabels': {!!python/unicode 'app': !!python/unicode 'mgmtapp'}\n!!python/unicode 'policyTypes': [!!python/unicode 'ip-pool']\n", "origin_properties": [ { "key": "prop0", "value": "val0" } ], "resource_type": "ContainerIpPool", "display_name": "ippool-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