Get Network Pool

Get Network Pool

Retrieves a specific Network Pool.

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

networkPoolId

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns NetworkPool of type(s) application/json;version=39.1
This response body class contains all of the following: InlineNetworkPool1 
{
    "status": {},
    "id": "string",
    "name": "string",
    "description": "string",
    "poolType": {},
    "promiscuousMode": false,
    "totalBackingsCount": 0,
    "usedBackingsCount": 0,
    "managingOwnerRef": {
        "name": "string",
        "id": "string"
    },
    "networkProviderScope": "string",
    "backing": {
        "vlanIdRanges": {
            "values": [
                {
                    "startId": 0,
                    "endId": 0
                }
            ]
        },
        "vdsRefs": [
            {
                "id": "string",
                "name": "string"
            }
        ],
        "portGroupRefs": [
            {
                "id": "string",
                "name": "string"
            }
        ],
        "transportZoneRef": {
            "id": "string",
            "name": "string"
        },
        "providerRef": {
            "name": "string",
            "id": "string"
        }
    }
}

404

The specified resource was not found

Returns Error of type(s) application/json;version=39.1 
"Error Object"
string
minorErrorCode
Required

minorErrorCode

string
message
Required

message

string
stackTrace
Optional

stackTrace


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/cloudapi/1.0.0/networkPools/{networkPoolId}
Availability
Added in 33.0
On This Page
Network Pool Operations
GET
Get Network Pool
PUT
Update Network Pool
DELETE
Delete Network Pool
POST
Sync Network Pool