NSX-T Data Center REST API

Get ip address usage for vpc

Retrieves the usage information for IP addresses within a specific VPC. This information provides insights into the allocation
and utilization of ipaddress by the VPC and its subnets.

Request:

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

Example Request:

GET https://<policy-mgr>/policy/api/v1/orgs/default/projects/project-1/vpcs/vpc-1/ip-address-usage

Successful Response:

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

Example Response:

{ "ip_blocks": [ { "path": "/infra/ip-blocks/block-1", "cidr": "172.16.20.0/24", "total": 256, "available": 160, "percentage_used": "37.5", "visibility": "PRIVATE", "allocated_by_vpc": { "access_mode": "Private_TGW", "count": 16, "percentage_used": "6.25", "ip_addresses": [ { "address": "172.16.20.16/28", "path": "/orgs/default/projects/default/vpcs/vpc-1/subnets/private-tgw-subnet-1" } ] } }, { "path": "/infra/ip-blocks/block-2", "cidr": "11.11.20.0/24", "total": 256, "available": 207, "percentage_used": "19.14", "visibility": "EXTERNAL", "allocated_by_vpc": { "access_mode": "Public", "count": 32, "percentage_used": "12.5", "ip_addresses": [ { "address": "11.11.20.48/28", "path": "/orgs/default/projects/default/vpcs/vpc-1/subnets/public-subnet-2" }, { "address": "11.11.20.32/28", "path": "/orgs/default/projects/default/vpcs/vpc-1/subnets/public-subnet-1" } ] } }, { "path": "/infra/ip-blocks/block-3", "cidr": "10.1.0.0/24", "total": 256, "available": 192, "percentage_used": "25", "visibility": "PRIVATE", "allocated_by_vpc": { "access_mode": "Private", "count": 64, "percentage_used": "25", "ip_addresses": [ { "address": "10.1.0.32/27", "path": "/orgs/default/projects/default/vpcs/vpc-1/subnets/private-subnet-3" }, { "address": "10.1.0.16/28", "path": "/orgs/default/projects/default/vpcs/vpc-1/subnets/private-subnet-2" }, { "address": "10.1.0.0/28", "path": "/orgs/default/projects/default/vpcs/vpc-1/subnets/private-subnet-1" } ] } } ] }

Required Permissions:

read

Feature:

policy_vpc

Additional Errors: