GET Onboarded Cloud Networks.

GET

/api/cloud-data/namespaces/system/cloud_user_accounts/{cloud_user_account_name}/onboarded_networks

curl --request GET \
  --url https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/cloud-data/namespaces/system/cloud_user_accounts/example/onboarded_networks \
  --header 'Authorization: <Authorization>'

• F5 Distributed Cloud Console

API to GET onboarded cloud networks for given cloud user account.

Examples of this operation.

Authorizations

• ApiToken

Parameters

Path Parameters

cloud_user_account_name

required

string

Cloud User Account Name

x-required Cloud User Account name.

Responses

200

A successful response.

Media typeapplication/json

GetOnboardedCloudNetworksResponse

Response to GET onboarded cloud networks for given cloud user account.

object

onboarded_network

Onboarded Networks

Onboarded networks.

Array<object>

Network Info Type

Network Info type.

object

network_id

Network ID

Network ID.

string

<= 1024 characters

network_management_type

string

default: NETWORK_MANAGEMENT_TYPE_NONE

Allowed values: NETWORK_MANAGEMENT_TYPE_NONE CUSTOMER_MANAGED F5_MANAGED

network_name

Network Name

Network Name.

string

<= 1024 characters

region

Network Region

Network Region.

string

<= 1024 characters

used_for_cloud_connects

Used For Cloud Connects

Refers list of cloud connects using this network.

Array<object>

<= 10 items

ObjectRefType

This type establishes a ‘direct reference’ from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name for public API and Uid for private API This type of reference is called direct because the relation is explicit and concrete (as opposed to selector reference which builds a group based on labels of selectee objects)

object

kind

kind

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object’s kind (e.g. “route”)

string

>= 12 characters <= 1024 characters

name

name

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name.

string

>= 6 characters <= 1024 characters

namespace

namespace

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.

string

>= 1 characters <= 63 characters /^[a-z]([-a-z0-9]*[a-z0-9])?$/

tenant

tenant

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.

string

>= 12 characters <= 1024 characters

uid

uid

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object’s(e.g. Route’s) uid.

string format: uuid

>= 36 characters <= 1024 characters

used_for_securemesh_sites

Used For Securemesh Sites

Refers list of securemesh sites using this network.

Array<object>

<= 10 items

ObjectRefType

This type establishes a ‘direct reference’ from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name for public API and Uid for private API This type of reference is called direct because the relation is explicit and concrete (as opposed to selector reference which builds a group based on labels of selectee objects)

object

kind

kind

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object’s kind (e.g. “route”)

string

>= 12 characters <= 1024 characters

name

name

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name.

string

>= 6 characters <= 1024 characters

namespace

namespace

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.

string

>= 1 characters <= 63 characters /^[a-z]([-a-z0-9]*[a-z0-9])?$/

tenant

tenant

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.

string

>= 12 characters <= 1024 characters

uid

uid

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object’s(e.g. Route’s) uid.

string format: uuid

>= 36 characters <= 1024 characters

Example

{
  "onboarded_network": [
    {
      "network_management_type": "NETWORK_MANAGEMENT_TYPE_NONE"
    }
  ]
}

401

Returned when operation is not authorized.

Media typeapplication/json

string format: string

Example^generated

example

403

Returned when there is no permission to access resource.

Media typeapplication/json

string format: string

Example^generated

example

404

Returned when resource is not found.

Media typeapplication/json

string format: string

Example^generated

example

409

Returned when operation on resource is conflicting with current value.

Media typeapplication/json

string format: string

Example^generated

example

429

Returned when operation has been rejected as it is happening too frequently.

Media typeapplication/json

string format: string

Example^generated

example

500

Returned when server encountered an error in processing API.

Media typeapplication/json

string format: string

Example^generated

example

503

Returned when service is unavailable temporarily.

Media typeapplication/json

string format: string

Example^generated

example

504

Returned when server timed out processing request.

Media typeapplication/json

string format: string

Example^generated

example