Get Ip Space

Get Ip Space

Retrieves the specified IP Space.

Request
URI
GET
https://{api_host}/cloudapi/1.0.0/ipSpaces/{ipSpaceId}
COPY
Path Parameters
string
ipSpaceId
Required

ipSpaceId

string
ipSpaceId
Required

ipSpaceId

Authentication
This operation uses the following authentication methods.
Responses
200
Returns IpSpace of type(s) application/json;version=38.0
This response body class contains all of the following: IpSpaceSummary , InlineIpSpace1 
{
    "id": "urn:vcloud:ipSpace:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "name": "string",
    "description": "string",
    "type": "string",
    "orgRef": {
        "name": "string",
        "id": "string"
    },
    "utilization": {
        "floatingIPs": {
            "totalCount": "string",
            "allocatedCount": "string",
            "usedCount": "string",
            "unusedCount": "string",
            "allocatedPercentage": "number",
            "usedPercentage": "number"
        },
        "ipPrefixes": {
            "prefixLengthUtilizations": [
                {
                    "prefixLength": 0,
                    "totalCount": 0,
                    "allocatedCount": 0
                }
            ]
        }
    },
    "ipSpaceRanges": {
        "ipRanges": [
            {
                "id": "string",
                "startIpAddress": "string",
                "endIpAddress": "string",
                "totalIpCount": "string",
                "allocatedIpCount": "string",
                "allocatedIpPercentage": "number"
            }
        ],
        "defaultFloatingIpQuota": 0
    },
    "ipSpacePrefixes": [
        {
            "ipPrefixSequence": [
                {
                    "id": "string",
                    "startingPrefixIpAddress": "string",
                    "prefixLength": 0,
                    "totalPrefixCount": 0,
                    "allocatedPrefixCount": 0,
                    "allocatedPrefixPercentage": "number"
                }
            ],
            "defaultQuotaForPrefixLength": 0
        }
    ],
    "ipSpaceInternalScope": [
        "string"
    ],
    "ipSpaceExternalScope": "string",
    "routeAdvertisementEnabled": false,
    "defaultGatewayServiceConfig": {
        "enableDefaultSnatRuleCreation": false,
        "enableDefaultNoSnatRuleCreation": false,
        "enableDefaultFirewallRuleCreation": false
    }
}

Availability
Added in 37.1
On This Page
Ip Spaces Operations
POST
Allocate
POST
Apply Ip Space Default Edge Gateway Services
POST
Apply Ip Space Default Provider Gateway Services
POST
Create Ip Space
DELETE
Delete Ip Space
DELETE
Delete Ip Space Ip Allocation
GET
Get Floating Ip Suggestions
GET
Get Ip Prefix Sequences
GET
Get Ip Prefix Suggestions
GET
Get Ip Space
GET
Get Ip Space Ip Allocation
GET
Get Ip Space Ip Allocations
GET
Get Ip Space Summaries
PUT
Update Ip Space
PUT
Update Ip Space Ip Allocation