NSX-T Data Center REST API

List IpAddressPools of VPC Subnet.

Paginated list of IpAddressPools of VPC Subnet.

Request:

Method:
GET
URI Path(s):
/policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/subnets/{subnet-id}/ip-pools
Request Headers:
n/a
Query Parameters:
PolicyListRequestParameters+
Request Body:
n/a

Example Request:

GET https://<policy-mgr>/policy/api/v1/orgs/org-1/projects/project-1/vpcs/vpc-1/subnets/subnet-1/ip-pools

Successful Response:

Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
IpAddressPoolListResult+

Example Response:

{ "sort_ascending": true, "sort_by": "display_name", "result_count": 1, "results": [{ "pool_usage": { "total_ips": 253, "requested_ip_allocations": 0, "allocated_ip_allocations": 0, "available_ips": 253 }, "resource_type": "IpAddressPool", "id": "default-ipv4", "display_name": "default-ipv4", "path": "/orgs/org-1/projects/project-1/vpcs/vpc-1/subnets/subnet-1/ip-pools/default-ipv4", "parent_path": "/orgs/org-1/projects/project-1/vpcs/vpc-1/subnets/subnet-1", "relative_path": "default-ipv4", "_create_user": "admin", "_create_time": 1516387911610, "_last_modified_user": "admin", "_last_modified_time": 1516387911610, "_system_owned": true, "_protection": "NOT_PROTECTED", "_revision": 0 }] }

Required Permissions:

read

Feature:

policy_ipam

Additional Errors: