Get Network Of Network Pool

Get Network Of Network Pool

Get a Network that is part of a Network Pool

Request
URI
GET
https://{api_host}/v1/network-pools/{id}/networks/{networkId}
COPY
Path Parameters
string
id
Required

Id of the Network pool

string
networkId
Required

Id of the Network


Responses
200

Network for referenced network pool

Returns Network of type(s) application/json
{
    "id": "string",
    "type": "VSAN, VMOTION, VXLAN, NFS, ISCSI, VSAN_EXTERNAL",
    "vlanId": 0,
    "mtu": 0,
    "subnet": "string",
    "mask": "string",
    "gateway": "string",
    "ipPools": [
        {
            "start": "string",
            "end": "string"
        }
    ],
    "freeIps": [
        "string"
    ],
    "usedIps": [
        "string"
    ]
}
string
id
Optional

The ID of the network

string
type
Required

Network Type of the network

integer As int32 As int32
vlanId
Required

VLAN ID associated with the network

integer As int32 As int32
mtu
Required

MTU of the network

string
subnet
Required

Subnet associated with the network

string
mask
Required

Subnet mask for the subnet of the network

string
gateway
Required

Gateway for the network

array of object
ipPools
Optional

List of IP pool ranges to use

array of string
freeIps
Optional

List of free IPs to use

array of string
usedIps
Optional

List of used IPs


404

Networkpool not found

Returns Error of type(s) application/json
"Error Object"
string
errorCode
Optional

The minor error code

string
errorType
Optional

The error type

array of string
arguments
Optional

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

object
context
Optional

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

string
message
Optional

The localized error message

string
remediationMessage
Optional

The localized remediation error message

array of object
causes
Optional

The underlying cause exceptions.

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.


500

Unexpected error

Returns Error of type(s) application/json
"Error Object"
string
errorCode
Optional

The minor error code

string
errorType
Optional

The error type

array of string
arguments
Optional

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

object
context
Optional

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

string
message
Optional

The localized error message

string
remediationMessage
Optional

The localized remediation error message

array of object
causes
Optional

The underlying cause exceptions.

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.


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/v1/network-pools/{id}/networks/{networkId}