NSX-T Data Center REST API

VPC IpAddressBloock Allocation State

Get allocation state of given IpAddressBlock for VPC.

Request:

Method:

GET

URI Path(s):

/policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/ip-blocks/allocation-state

Request Headers:

n/a

Query Parameters:

VpcAllocationStateQueryParams+

VpcAllocationStateQueryParams (schema)

Name	Description	Type	Notes
cidr	CIDR allocated from the IpAddressBlock	string
include_workload_details	Filter details by Workload VM If set to true, and if the allocated CIDR is being used by a VM, the API will return details about the VM.	boolean	Default: "False"
ip_address_block_path	Policy path of the IpAddressBlock	string

Request Body:

n/a

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

IpAddressBlockAllocationStateList+

IpAddressBlockAllocationStateList (schema)

Name	Description	Type	Notes
_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
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	Array of CIDR allocation states for all IpAddressBlocks	array of IpAddressBlockAllocationState
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

Required Permissions:

read

Feature:

policy_ipam

Additional Errors:

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