Get Ip Space Ip Allocation

Retrieves the specified IP Space IP Allocation.

Request

URI

GET

https://{api_host}/cloudapi/1.0.0/ipSpaces/{ipSpaceId}/allocations/{ipAllocationId}

COPY

Path Parameters

string

ipSpaceId

Required

ipSpaceId

string

ipAllocationId

Required

ipAllocationId

string

ipSpaceId

Required

ipSpaceId

string

ipAllocationId

Required

ipAllocationId

Authentication

This operation uses the following authentication methods.

ApiKeyAuth

Responses

200

Returns IpSpaceIpAllocation of type(s) application/json;version=38.1

{
    "id": "urn:vcloud:ipSpaceIpAllocation:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "type": "string",
    "value": "string",
    "allocationDate": "string",
    "orgRef": {
        "name": "string",
        "id": "string"
    },
    "usageState": "string",
    "description": "string",
    "reservedForUser": false,
    "reservedForUserName": "string",
    "usedByRef": {
        "name": "string",
        "id": "string"
    },
    "usageCategories": [
        "string"
    ]
}

string

Optional

The identifier of the IP Space IP allocation in URN format.

string

type

Optional

The type of the IP allocation. Possible values are:

FLOATING_IP - For allocation of floating IP addresses from defined IP Space ranges.
IP_PREFIX - For allocation of IP prefix sequences from defined IP Space prefixes.

string

value

Optional

An individual IP Address or an IP Prefix which is allocated.

string As date-time As date-time

allocationDate

Optional

Date when the IP address or IP prefix is allocated. This property is read-only.

EntityReference

orgRef

Optional

orgRef

string

usageState

Optional

Specifies current usage state of an allocated IP. Possible values are:

UNUSED - the allocated IP is current not being used in the system.
USED - the allocated IP is currently in use in the system. An allocated IP address or IP Prefix is considered used if it is being used in network services such as NAT rule or in Org VDC network definition.
USED_MANUAL - the allocated IP is marked for manual usage. Allocation description can be referenced to get information about the manual usage.

string

description

Optional

Description about usage of an IP if the usageState is USED_MANUAL.

boolean

reservedForUser

Optional

If the usage state transitions to or is in USED_MANUAL state, this property can be set to have the IP or IP Prefix be reserved for the user that is performing the update. Reserving the IP or IP prefix means that only that same user can use the IP for Edge services or use the IP Prefix during Org VDC network creation. If this property is unset or set to false, any user with access to the IP or IP Prefix can use it. When the usage state transitions from USED_MANUAL to UNUSED, this property will be false. By default, this property is set to false.

string

reservedForUserName

Optional

The user name that this IP Allocation is reserved for. This is set only if the property reservedForUser is set to true in USED_MANUAL state. This field is read-only.

EntityReference

usedByRef

Optional

usedByRef

array of string

usageCategories

Optional

The list of service categories where the IP address is being used. Typically this can be one of: SNAT, DNAT, REFLEXIVE_NAT, LOAD_BALANCER, IPSEC_VPN, SSL_VPN or L2_VPN. This property is read-only.

Availability

Added in 37.1

On This Page

Description

Request

Path Parameters

Authentication

Response

200 Response Body

Ip Spaces Operations

POST

Allocate