Get Network Pool

Get Network Pool

Get a Network Pool by ID, if it exists

Request
URI
GET
https://sfo-vcf01.rainpole.io/v1/network-pools/{id}
COPY
Path Parameters
string
id
Required

ID of the network pool to fetch


Responses
200

Referenced network pool

Returns NetworkPool of type(s) application/json
{
    "id": "string",
    "name": "string",
    "networks": [
        {
            "freeIps": [
                "string"
            ],
            "gateway": "string",
            "id": "string",
            "ipPools": [
                {
                    "end": "string",
                    "start": "string"
                }
            ],
            "mask": "string",
            "mtu": 0,
            "subnet": "string",
            "type": "string",
            "usedIps": [
                "string"
            ],
            "vlanId": 0
        }
    ]
}
string
id
Optional

The ID of the network pool

string
name
Optional

User specified name of the network pool

array of Network
networks
Optional

Representing the networks associated with the network pool


404

Referenced network pool not found

Returns Error of type(s) application/json
{
    "arguments": [
        "string"
    ],
    "causes": [
        {
            "message": "string",
            "type": "string"
        }
    ],
    "context": {
        "context": "string"
    },
    "errorCode": "string",
    "errorType": "string",
    "message": "string",
    "nestedErrors": [
        "Error Object"
    ],
    "referenceToken": "string",
    "remediationMessage": "string"
}
array of string
arguments
Optional

The arguments used to localize the message, Can be used by scripts to automate the error processing.

array of ErrorCause
causes
Optional

The underlying cause exceptions.

object
context
Optional

The error context (e.g. the component where it occurred).

string
errorCode
Optional

The minor error code

string
errorType
Optional

The error type

string
message
Optional

The localized error message

array of Error
nestedErrors
Optional

The nested errors when the error is a composite one

string
referenceToken
Optional

A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.

string
remediationMessage
Optional

The localized remediation error message


500

Unexpected error

Returns Error of type(s) application/json
{
    "arguments": [
        "string"
    ],
    "causes": [
        {
            "message": "string",
            "type": "string"
        }
    ],
    "context": {
        "context": "string"
    },
    "errorCode": "string",
    "errorType": "string",
    "message": "string",
    "nestedErrors": [
        "Error Object"
    ],
    "referenceToken": "string",
    "remediationMessage": "string"
}
array of string
arguments
Optional

The arguments used to localize the message, Can be used by scripts to automate the error processing.

array of ErrorCause
causes
Optional

The underlying cause exceptions.

object
context
Optional

The error context (e.g. the component where it occurred).

string
errorCode
Optional

The minor error code

string
errorType
Optional

The error type

string
message
Optional

The localized error message

array of Error
nestedErrors
Optional

The nested errors when the error is a composite one

string
referenceToken
Optional

A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.

string
remediationMessage
Optional

The localized remediation error message