List Ip Address Pool Allocations
Returns information about which addresses have been allocated from a specified IP address pool in policy.
Request
URI
GET
https://nsxmanager.your.domain/policy/api/v1/infra/ip-pools/{ip-pool-id}/ip-allocations
COPY
Path Parameters
string
ip-pool-id
Required
ip-pool-id
Query Parameters
string
cursor
Optional
Opaque cursor to be used for getting next page of records (supplied by current result page)
boolean
include_mark_for_delete_objects
Optional
Include objects that are marked for deletion in results
string
included_fields
Optional
Comma separated list of fields that should be included in query result
integer
page_size
Optional
Maximum number of results to return in this page (server may return fewer)
boolean
sort_ascending
Optional
sort_ascending
string
sort_by
Optional
Field by which records are sorted
Responses
200
OK
Returns
IpAddressAllocationListResult
of type(s)
application/json
This response body class contains all of the following:
ListResult ,
InlineIpAddressAllocationListResult1
{
"_links": [
{
"action": "string",
"href": "string",
"rel": "string"
}
],
"_schema": "string",
"_self": {
"action": "string",
"href": "string",
"rel": "string"
},
"cursor": "string",
"result_count": 0,
"sort_ascending": false,
"sort_by": "string",
"results": [
{
"_links": [
{
"action": "string",
"href": "string",
"rel": "string"
}
],
"_schema": "string",
"_self": {
"action": "string",
"href": "string",
"rel": "string"
},
"_revision": 0,
"_create_time": 0,
"_create_user": "string",
"_last_modified_time": 0,
"_last_modified_user": "string",
"_protection": "string",
"_system_owned": false,
"description": "string",
"display_name": "string",
"id": "string",
"resource_type": "string",
"tags": [
{
"scope": "string",
"tag": "string"
}
],
"parent_path": "string",
"path": "string",
"relative_path": "string",
"children": [
{
"_links": [
{
"action": "string",
"href": "string",
"rel": "string"
}
],
"_schema": "string",
"_self": {
"action": "string",
"href": "string",
"rel": "string"
},
"_revision": 0,
"_create_time": 0,
"_create_user": "string",
"_last_modified_time": 0,
"_last_modified_user": "string",
"_protection": "string",
"_system_owned": false,
"description": "string",
"display_name": "string",
"id": "string",
"resource_type": "string",
"tags": [
{
"scope": "string",
"tag": "string"
}
],
"marked_for_delete": false
}
],
"marked_for_delete": false,
"allocation_ip": "string"
}
]
}
400
Returns
BadRequest
of type(s)
application/json
This response body class contains all of the following:
RelatedApiError ,
InlineApiError1
{
"details": "string",
"error_code": 0,
"error_message": "string",
"module_name": "string",
"related_errors": [
{
"details": "string",
"error_code": 0,
"error_message": "string",
"module_name": "string"
}
]
}
403
Returns
Forbidden
of type(s)
application/json
This response body class contains all of the following:
RelatedApiError ,
InlineApiError1
{
"details": "string",
"error_code": 0,
"error_message": "string",
"module_name": "string",
"related_errors": [
{
"details": "string",
"error_code": 0,
"error_message": "string",
"module_name": "string"
}
]
}
404
Returns
NotFound
of type(s)
application/json
This response body class contains all of the following:
RelatedApiError ,
InlineApiError1
{
"details": "string",
"error_code": 0,
"error_message": "string",
"module_name": "string",
"related_errors": [
{
"details": "string",
"error_code": 0,
"error_message": "string",
"module_name": "string"
}
]
}
412
Returns
PreconditionFailed
of type(s)
application/json
This response body class contains all of the following:
RelatedApiError ,
InlineApiError1
{
"details": "string",
"error_code": 0,
"error_message": "string",
"module_name": "string",
"related_errors": [
{
"details": "string",
"error_code": 0,
"error_message": "string",
"module_name": "string"
}
]
}
500
Returns
InternalServerError
of type(s)
application/json
This response body class contains all of the following:
RelatedApiError ,
InlineApiError1
{
"details": "string",
"error_code": 0,
"error_message": "string",
"module_name": "string",
"related_errors": [
{
"details": "string",
"error_code": 0,
"error_message": "string",
"module_name": "string"
}
]
}
503
Returns
ServiceUnavailable
of type(s)
application/json
This response body class contains all of the following:
RelatedApiError ,
InlineApiError1
{
"details": "string",
"error_code": 0,
"error_message": "string",
"module_name": "string",
"related_errors": [
{
"details": "string",
"error_code": 0,
"error_message": "string",
"module_name": "string"
}
]
}On This Page
Infrastructure Infra Operations
PATCH
Create Or Patch Ip Address Pool
PATCH
Create Or Patch Ip Address Pool Allocation
PATCH
Create Or Patch Ip Address Pool Subnet
PUT
Create Or Replace Ip Address Pool
PUT
Create Or Replace Ip Address Pool Allocation
PUT
Create Or Replace Ip Address Pool Subnet
DELETE
Delete Ip Address Pool
DELETE
Delete Ip Address Pool Allocation
DELETE
Delete Ip Address Pool Subnet
GET
List Ip Address Pool Allocations
GET
List Ip Address Pools
GET
List Ip Address Pool Subnets
GET
Read Ip Address Pool
GET
Read Ip Address Pool Allocation
GET
Read Ip Address Pool Subnet