Skip to content
OtterScale

ListNetworks

POST
/otterscale.network.v1.NetworkService/ListNetworks

Parameters

Section titled “ Parameters ”

Header Parameters

Section titled “Header Parameters ”
Connect-Protocol-Version
required
Connect-Protocol-Version

Define the version of the Connect protocol

number
Allowed values: 1
Connect-Timeout-Ms
Connect-Timeout-Ms

Define the timeout, in ms

number

Request Body required

Section titled “Request Body required ”
ListNetworksRequest
object

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Success

ListNetworksResponse
object
networks
networks
Array<object>
Network
object
fabric
fabric
object
id
id
integer | string format: int64
name
name
string
vlan
vlan
object
id
id
integer | string format: int64
vid
vid
integer | string format: int64
name
name
string
mtu
mtu
integer | string format: int64
description
description
string
dhcpOn
dhcp_on
boolean
subnet
subnet
object
id
id
integer | string format: int64
name
name
string
cidr
cidr
string
gatewayIp
gateway_ip
string
dnsServers
dns_servers
Array<string>
description
description
string
managedAllocation
managed_allocation
boolean
activeDiscovery
active_discovery
boolean
allowProxyAccess
allow_proxy_access
boolean
allowDnsResolution
allow_dns_resolution
boolean
ipAddresses
ip_addresses
Array<object>
IPAddress
object
type
type
string
ip
ip
string
user
user
string
machineId
machine_id
string
nodeType
node_type
string
hostname
hostname
string
ipRanges
ip_ranges
Array<object>
IPRange
object
id
id
integer | string format: int64
type
type
string
startIp
start_ip
string
endIp
end_ip
string
comment
comment
string
statistics
statistics
object
available
available
integer | string format: int64
total
total
integer | string format: int64
usagePercent
usage_percent
string
availablePercent
available_percent
string

default

Section titled “default ”

Error

Connect Error
object
code

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

string
Allowed values: canceled unknown invalid_argument deadline_exceeded not_found already_exists permission_denied resource_exhausted failed_precondition aborted out_of_range unimplemented internal unavailable data_loss unauthenticated
message

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

string
details

A list of messages that carry the error details. There is no limit on the number of messages.

Array<object>

Contains an arbitrary serialized message along with a @type that describes the type of the serialized message, with an additional debug field for ConnectRPC error details.

object
type

A URL that acts as a globally unique identifier for the type of the serialized message. For example: type.googleapis.com/google.rpc.ErrorInfo. This is used to determine the schema of the data in the value field and is the discriminator for the debug field.

string
value

The Protobuf message, serialized as bytes and base64-encoded. The specific message type is identified by the type field.

string format: binary
debug
One of: discriminator: type
Any

Detailed error information.

object
key
additional properties
any
key
additional properties
any
key
additional properties
any