Skip to content
API Enriched

List CloudLink.

GET
/api/config/namespaces/{namespace}/cloud_links
curl --request GET \
  --url https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/config/namespaces/example/cloud_links \
  --header 'Authorization: <Authorization>'

List the set of cloud_link in a namespace.

Examples of this operation.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
namespace
required
string

Namespace Namespace to scope the listing of cloud_link.

Query Parameters

Section titled “Query Parameters”
label_filter
string

A LabelSelectorType expression that every item in list response will satisfy.

report_fields
Array<string>

X-example: "" Extra fields to return along with summary fields.

report_status_fields
Array<string>

X-example: "" Extra status fields to return along with summary fields.

Responses

Section titled “Responses”

200

Section titled “200”

A successful response.

Media typeapplication/json
ListResponse is the collection of cloud_link

This is the output message of ‘List’ RPC.

object
errors
errors

Errors(if any) while listing items from collection.

Array<object>
ErrorType

Information about a error in API operation.

object
code
string
default: EOK
Allowed values: EOK EPERMS EBADINPUT ENOTFOUND EEXISTS EUNKNOWN ESERIALIZE EINTERNAL EPARTIAL
error_obj
object
type_url

A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one ”/” character. The last segment of the URL’s path must represent the fully qualified name of the type (as in path/google.protobuf.duration). The name should be in a canonical form (e.g., leading ”.” is not accepted).

In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme HTTP, HTTPS, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:

  • If no scheme is provided, HTTPS is assumed.
  • An HTTP GET on the URL must yield a [google.protobuf.type][] value in binary format, or produce an error.
  • Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)

Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.

Schemes other than HTTP, HTTPS (or the empty scheme) might be used with implementation specific semantics.

string
<= 1024 characters
value

Must be a valid serialized protocol buffer of the above specified type.

string format: byte
>= 3 characters <= 1024 characters
message
message

A human readable string of the error.

string
<= 1024 characters
items
items

Items represents the collection in response.

Array<object>
ListResponseItem is an individual item in a collection of cloud_link

By default a summary of cloud_link is returned in ‘List’. By setting ‘report_fields’ in the ListRequest more details of each item can be got.

object
annotations
annotations

The set of annotations present on this cloud_link.

object
description
description

The description set for this cloud_link.

string
>= 21 characters <= 1024 characters
disabled
disabled

A value of true indicates cloud_link is administratively disabled.

boolean format: boolean
get_spec
object
aws
object
aws_cred
object
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. Required: YES.

string
>= 1 characters <= 128 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
>= 6 characters <= 64 characters
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
>= 6 characters <= 64 characters
byoc
object
connections
List of Bring You Own Connections

List of Bring You Own Connections. These AWS Direct Connect connections are not managed by F5XC but will be used for connecting sites and REs.

Required: YES.

Array<object>
>= 1 items <= 10 items
Bring You Own Connection

AWS Bring You Own Connection. F5XC supports Virtual interfaces from the same AWS cloud account.

object
auth_key
object
blindfold_secret_info
object
decryption_provider
Decryption Provider

Name of the Secret Management Access object that contains information about the backend Secret Management service.

string
<= 1024 characters
location
Location

Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location Required: YES.

string
>= 4 characters <= 1024 characters
store_provider
Store Provider

Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.

string
<= 1024 characters
clear_secret_info
object
provider
Provider

Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.

string
>= 3 characters <= 1024 characters
url
URL

URL of the secret. Currently supported URL schemes is string:///. For string:/// scheme, Secret needs to be encoded Base64 format. When asked for this secret, caller will GET Secret bytes after Base64 decoding. Required: YES.

string format: uri
<= 131072 characters
bgp_asn
BGP ASN

The Border Gateway Protocol (BGP) Autonomous System Number (ASN) of your on-premises router for the new virtual interface to be configured on AWS. Required: YES.

integer format: int64
connection_id
Direct Connect Connection Id

ID of the existing AWS Direct Connect Connection Required: YES.

string
<= 64 characters
ipv4
object
aws_router_peer_address
AWS Router Peer IP/Prefix

The BGP peer IP configured on the AWS endpoint Required: YES.

string
<= 1024 characters
router_peer_address
Customer Peer IP/Prefix

The BGP peer IP configured on your (customer) endpoint Required: YES.

string
<= 1024 characters
metadata
object
description
description

Human readable description.

string
>= 21 characters <= 256 characters
name
name

This is the name of the message. The value of name has to follow DNS-1035 format. Required: YES.

string
>= 1 characters <= 1024 characters
region
Region

Region where the connection is setup Required: YES.

string
<= 1024 characters
system_generated_name
object
tags
AWS Tags

AWS Tags is a label consisting of a user-defined key and value. It helps to manage, identify, organize, search for, and filter resources in AWS console. Specified tags will be added to Virtual interface along with any F5XC specific tags.

object
user_assigned_name
User Assigned

Exclusive with [system_generated_name] User is managing the AWS resource name.

string
<= 256 characters
virtual_interface_type
string
default: PRIVATE
Allowed values: PRIVATE
vlan
Virtual Local Area Network (VLAN)

Virtual Local Area Network number for the new virtual interface to be configured on the AWS. This tag is required for any traffic traversing the AWS Direct Connect connection Required: YES.

integer format: int64
custom_asn
Custom ASN

Exclusive with [] F5XC will use custom ASN to create a Direct Connect Gateway.

integer format: int64
cloud_link_state
string
default: UP
Allowed values: UP DOWN DEGRADED NOT_APPLICABLE
disabled
object
enabled
object
cloudlink_network_name
Private ADN Network

Establish private connectivity with the F5 Distributed Cloud Global Network using a Private ADN network. To provision a Private ADN network, please contact F5 Distributed Cloud support. Required: YES.

string
<= 64 characters
gcp
object
byoc
object
connections
List of Bring You Own Connections

Each ‘Bring Your Own Connection’ represents a virtual connection that the customer has provisioned in the Cloud (example: AWS Direct Connect). F5XC will orchestrate networking resources in the cloud to facilitate seamless private connectivity.

Required: YES.

Array<object>
>= 1 items <= 10 items
Bring You Own Connection

GCP Bring You Own Connection.

object
interconnect_attachment_name
Interconnect Attachment Name

Name of already-existing GCP Cloud Interconnect Attachment

Required: YES.

string
>= 1 characters <= 63 characters
metadata
object
description
description

Human readable description.

string
>= 21 characters <= 256 characters
name
name

This is the name of the message. The value of name has to follow DNS-1035 format. Required: YES.

string
>= 1 characters <= 1024 characters
project
Project ID

Exclusive with [same_as_credential] Specify a GCP Project for the interconnect attachment.

string
>= 4 characters <= 30 characters
region
Region

GCP Region in which the GCP Cloud Interconnect attachment is configured

Required: YES.

string
<= 1024 characters
same_as_credential
object
gcp_cred
object
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. Required: YES.

string
>= 1 characters <= 128 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
>= 6 characters <= 64 characters
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
>= 6 characters <= 64 characters
sites

This field indicates the number of Sites connected to this CloudLink object.

integer format: int32
status
string
default: IN_PROGRESS
Allowed values: IN_PROGRESS ERROR READY DELETING CUSTOMER_DEPLOYED NOT_APPLICABLE
labels
labels

The set of labels present on this cloud_link.

object
metadata
object
annotations
annotations

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects.

object
description
description

Human readable description for the object.

string
>= 21 characters <= 1200 characters
disable
disable

A value of true will administratively disable the object.

boolean format: boolean
labels
labels

Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the user. Values specified here will be used by selector expression.

object
name
name

This is the name of configuration object. It has to be unique within the namespace. It can only be specified during create API and cannot be changed during replace API. The value of name has to follow DNS-1035 format. Required: YES.

string
>= 6 characters <= 1024 characters
namespace
namespace

This defines the workspace within which each the configuration object is to be created. Must be a DNS_LABEL format. For a namespace object itself, namespace value will be ""

string
>= 6 characters <= 1024 characters
name
name

The name of this cloud_link.

string
>= 6 characters <= 1024 characters
namespace
namespace

The namespace this item belongs to.

string
>= 6 characters <= 1024 characters
owner_view
object
kind
kind

Kind of the view object.

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
>= 6 characters <= 1024 characters
uid
uid

UID of the view object.

string format: uuid
>= 36 characters <= 1024 characters
status_set
status

The status reported by different services for this configuration object.

Array<object>
Status for Cloud Link

Most recently observed status of object.

object
aws_status
object
cloud_link_state
string
default: UP
Allowed values: UP DOWN DEGRADED NOT_APPLICABLE
connection_status
CloudLink Direct Connect Connection Status

Status reported by Amazon Web Services (AWS) CloudLink Connection.

Array<object>
CloudLink Direct Connect Connection Status

Status reported by Amazon Web Services (AWS) Direct Connect Connection related to this Cloud Link.

object
aws_path
AWS Object Link

Link to Amazon Web Services (AWS) object.

string
<= 1024 characters
bandwidth
Bandwidth

The bandwidth of the connection.

string
<= 1024 characters
connection_id
Connection Id

The ID of the direct connect connection.

string
<= 1024 characters
connection_name
Connection Name

The Name of the connection.

string
<= 1024 characters
connection_state
Connection State

The state of the Direct Connect Connection.

string
<= 1024 characters
gateway_status
object
amazon_asn
Amazon Web Services (AWS) ASN

The autonomous system number (ASN) for the Amazon side of the connection.

string format: uint64
<= 1024 characters
aws_path
AWS Object Link

Link to Amazon Web Services (AWS) object.

string
<= 1024 characters
direct_connect_gateway_id
Gateway Id

The ID of the direct connect gateway.

string
<= 1024 characters
direct_connect_gateway_name
Gateway Name

The Name of the direct connect gateway.

string
<= 1024 characters
direct_connect_gateway_state
Direct Connect Gateway State

The state of the Direct Connect gateway.

string
<= 1024 characters
owner_account
Owner Account

The ID of the AWS account that owns the connection.

string
<= 1024 characters
state_change_error
Direct Connect Gateway Error

The error message if the state of an object failed to advance.

string
<= 1024 characters
has_logical_redundancy
Logical Redundancy Status

Whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6)

string
<= 1024 characters
jumbo_frame_capable
Jumbo Frame Capable

Indicates whether jumbo frames (9001 MTU) are supported.

boolean format: boolean
location
Location

Location of the connection.

string
>= 4 characters <= 1024 characters
owner_account
Owner Account

The ID of the AWS account that owns the connection.

string
<= 1024 characters
partner_name
Connection Partner

The name of the AWS Direct Connect service provider associated with the connection.

string
<= 1024 characters
provider_name
Connection Provider

The name of the service provider associated with the connection.

string
<= 1024 characters
region
Region

Region where the connection is located.

string
<= 1024 characters
tags
AWS Tags

AWS Tags is a label consisting of a user-defined key and value which are assocaited with this coonnection. It helps to manage, identify, organize, search for, and filter resources in AWS console.

object
vif_status
object
address_family
Address Family

The address family setup for the BGP peer.

string
<= 1024 characters
amazon_address
AWS Router Peer IP

The BGP peer IP configured on the AWS endpoint.

string
<= 1024 characters
amazon_asn
Amazon Web Services (AWS) ASN

The autonomous system number (ASN) for the Amazon side of the connection.

string format: uint64
<= 1024 characters
attachment_state_change_error
Gateway Attachment State Error

The error message if the state of an object failed to advance.

string
<= 1024 characters
aws_path
AWS Object Link

Link to Amazon Web Services (AWS) object.

string
<= 1024 characters
bgp_asn
Border Gateway Protocol (BGP) ASN

The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

integer format: int64
bgp_peers
BGP Peers

The BGP peers configured on this virtual interface.

Array<object>
BGP Peer

The BGP peer object.

object
address_family
Address Family

The address family setup for the BGP peer.

string
<= 1024 characters
asn
Cloud Provider ASN

The autonomous system number (ASN) for the cloud provider side of the connection.

integer format: int64
bgp_peer_id
BGP Peer IP

The ID of the BGP peer.

string
<= 1024 characters
bgp_peer_state
BGP Peer State

The state of the BGP peer.

string
<= 1024 characters
bgp_status
BGP Peer Status

The status of the BGP peer.

string
<= 1024 characters
cloud_provider_address
Cloud Provider Router Peer IP

The BGP peer IP configured on the cloud provider endpoint.

string
<= 1024 characters
customer_address
Customer Peer IP

The BGP peer IP configured on the Customer endpoint.

string
<= 1024 characters
connection_id
Connection Id

The ID of the direct connect connection.

string
<= 1024 characters
direct_connect_attachment_state
Direct Connect Attachment State

The state of the Attachment.

string
<= 1024 characters
direct_connect_gateway_id
Gateway Id

The ID of the direct connect gateway.

string
<= 1024 characters
direct_connect_gateway_name
Gateway Name

The Name of the direct connect gateway.

string
<= 1024 characters
jumbo_frame_capable
Jumbo Frame Capable

Indicates whether jumbo frames (9001 MTU) are supported.

boolean format: boolean
location
Location

Location where the virtual interface is located.

string
>= 4 characters <= 1024 characters
mtu
Maximum Transmission Unit (MTU)

The maximum transmission unit (MTU), in bytes.

integer format: int64
owner_account
Owner Account

The ID of the AWS account that owns the connection.

string
<= 1024 characters
region
Region

Region where the virtual interface is located.

string
<= 1024 characters
tags
AWS Tags

AWS Tags is a label consisting of a user-defined key and value which are assocaited with this coonnection. It helps to manage, identify, organize, search for, and filter resources in AWS console.

object
virtual_interface_id
Virtual Interface Id

ID of the virtual interface.

string
<= 1024 characters
virtual_interface_name
Virtual Interface Name

Name of the virtual interface.

string
<= 1024 characters
virtual_interface_state
Virtual Interface State

The state of the virtual interface.

string
<= 1024 characters
virtual_interface_type
Virtual Interface Type

Type of the virtual interface.

string
<= 1024 characters
vlan
Virtual Local Area Network (VLAN)

Virtual Local Area Network number for the new virtual interface to be configured on the AWS.

integer format: int64
vlan
Virtual Local Area Network (VLAN)

Virtual Local Area Network number for the new virtual interface to be configured on the AWS.

integer format: int64
deployment_status
string
default: IN_PROGRESS
Allowed values: IN_PROGRESS ERROR READY DELETING CUSTOMER_DEPLOYED NOT_APPLICABLE
error_description
Error Description

Description of error on site.

string
<= 1024 characters
suggested_action
Suggested Action

Suggested action for customer on error.

string
<= 1024 characters
azure_status
object
conditions
conditions

Conditions reported by various component of the system.

Array<object>
ConditionType

Conditions are used in the object status to describe the current state of the object, e.g. Ready, Succeeded, etc.

object
hostname
hostname

Hostname of the instance of the site that sent the status.

string
<= 1024 characters
last_update_time
last_update_time

Last time the condition was updated.

string format: date-time
<= 1024 characters
reason
reason

X-reason: “Insufficient memory in data plane” A human readable string explaining the reason for reaching this condition.

string
>= 27 characters <= 1024 characters
service_name
service name

Name of the service that sent the status.

string
<= 1024 characters
status
status

Status of the condition “Success” Validtion has succeded. Requested operation was successful. “Failed” Validation has failed. “Incomplete” Validation of configuration has failed due to missing configuration. “Installed” Validation has passed and configuration has been installed in data path or K8s “Down” Configuration is operationally down. E.g. Down interface “Disabled” Configuration is administratively disabled i.e. objectmetatype.disable = true. “NotApplicable” Configuration is not applicable e.g. Tenant service_policy_set(s) in system namespace are not applicable on REs.

string
>= 17 characters <= 1024 characters
type
type

Type of the condition “Validation” represents validation user given configuration object “Operational” represents operational status of a given configuration object.

string
<= 1024 characters
gcp_status
object
cloud_link_state
string
default: UP
Allowed values: UP DOWN DEGRADED NOT_APPLICABLE
connection_status
CloudLink GCP Cloud Interconnect Status

Status reported by Google Cloud Platform (GCP) CloudLink Connection.

Array<object>
CloudLink GCP Cloud Interconnect Connection Status

Status reported by Google Cloud Platform (GCP) Cloud Interconnect attachment related to this Cloud Link.

object
admin_enabled
Admin Enabled

Whether the GCP Cloud Interconnect attachment is administratively enabled.

boolean format: boolean
attachment_state
GCP Cloud Interconnect Attachment State

The state of the GCP Cloud Interconnect Attachment.

string
<= 1024 characters
availability_domain
Availability Domain

Desired availability domain this attachment. Defaults to AVAILABILITY_DOMAIN_ANY.

string
<= 1024 characters
bandwidth
Bandwidth

Provisioned bandwidth capacity for this GCP Cloud Interconnect attachment.

string
<= 1024 characters
bgp_peers
BGP Peers

BGP peer status for this GCP Cloud Interconnect.

Array<object>
BGP Peer

The BGP peer object.

object
address_family
Address Family

The address family setup for the BGP peer.

string
<= 1024 characters
asn
Cloud Provider ASN

The autonomous system number (ASN) for the cloud provider side of the connection.

integer format: int64
bgp_peer_id
BGP Peer IP

The ID of the BGP peer.

string
<= 1024 characters
bgp_peer_state
BGP Peer State

The state of the BGP peer.

string
<= 1024 characters
bgp_status
BGP Peer Status

The status of the BGP peer.

string
<= 1024 characters
cloud_provider_address
Cloud Provider Router Peer IP

The BGP peer IP configured on the cloud provider endpoint.

string
<= 1024 characters
customer_address
Customer Peer IP

The BGP peer IP configured on the Customer endpoint.

string
<= 1024 characters
cloud_router_ip
Cloud Router IP Address

IP address of this interconnect attachment on the GCP Cloud Router.

string
<= 1024 characters
customer_router_ip
Customer Router IP Address

IP address of this interconnect attachment on the customer side.

string
<= 1024 characters
dataplane_version
Dataplane Version

The dataplane version of the GCP Cloud Interconnect Attachment.

integer format: int32
encryption
Encryption

Encryption type for this GCP Cloud Interconnect attachment.

string
<= 1024 characters
gcp_path
GCP Object Link

Link to this interconnect’s Cloud Router object in Google Cloud Platform.

string
<= 1024 characters
interconnect
GCP Cloud Interconnect

Name of the underlying GCP Cloud Interconnect that this attachment is attached to.

string
<= 1024 characters
labels
Labels

Labels are user-defined keys and values associated with this GCP Cloud Interconnect attachment.

object
mtu
Maximum Transmission Unit (MTU)

Maximum Transmission Unit (MTU) for the GCP Cloud Interconnect attachment.

integer format: int64
name
GCP Cloud Interconnect Attachment Name

The name of the GCP Cloud Interconnect Attachment.

string
>= 6 characters <= 1024 characters
operational_status
Operational Status

Provisioning status of this GCP Cloud Interconnect attachment.

string
<= 1024 characters
partner_asn
Partner ASN

Partner Autonomous System Number (ASN) for this GCP Cloud Interconnect attachment.

integer format: int64
partner_metadata
object
interconnect
Interconnect Name

Name of partner interconnect associated with a GCP Cloud Interconnect attachment.

string
<= 1024 characters
name
Name

Name of partner associated with a GCP Cloud Interconnect attachment.

string
>= 6 characters <= 1024 characters
portal_url
Portal URL

URL to the partner portal for the interconnect associated with this GCP Cloud Interconnect attachment.

string
<= 1024 characters
project
Cloud Router Project ID

GCP Project ID of this interconnect’s Cloud Router.

string
<= 1024 characters
region
Cloud Router Region

Region of this interconnect’s Cloud Router.

string
<= 1024 characters
router
Router

Name of the GCP Cloud Router to which this GCP Cloud Interconnect is connected.

string
<= 1024 characters
stack_type
Stack Type

TCP/IP Stack Type of the GCP Cloud Interconnect attachment. Defaults to IPV4_ONLY.

string
<= 1024 characters
type
Type

Type of GCP Cloud Interconnect attachment

Required: YES.

string
<= 1024 characters
vlan
Virtual Local Area Network (VLAN)

Virtual Local Area Network number for the GCP Cloud Interconnect attachment. This tag is required for any traffic traversing the GCP Cloud Router via this connection.

integer format: int64
vpc_network
Cloud Router VPC Network

VPC Network of this interconnect’s Cloud Router.

string
<= 1024 characters
metadata
object
creation_timestamp
creation_timestamp

Creation_timestamp is when the status object was created. It is used to find/tie-break for latest status object from same origin.

string format: date-time
<= 1024 characters
creator_class
creator_class

Class of creator which created this StatusObject. This will be service’s DNS FQDN. This will be set by the system based on client certificate information.

string
<= 1024 characters
creator_id
creator_id

ID of creator which created this StatusObject. This will be a concrete identifier for service (e.g. Identifying the environment also). This will be set by the system based on client certificate information.

string
<= 1024 characters
publish
string
default: STATUS_DO_NOT_PUBLISH
Allowed values: STATUS_DO_NOT_PUBLISH STATUS_PUBLISH
status_id
status_id

Status_id is a field used by the generator to distinguish (if necessary) between two status objects for the same config object from the same site and same service and potentially same daemon(creator-ID)

string
<= 1024 characters
uid
uid

Uid is the unique in time and space value for a StatusObject.

string format: uuid
>= 36 characters <= 1024 characters
vtrp_id
vtrp_id

Origin of this status exchanged by VTRP.

string
<= 1024 characters
vtrp_stale
vtrp_stale

Indicate whether mars deems this object to be stale via graceful restart timer information.

boolean format: boolean
object_refs
object_refs

Reference to object for current status.

Array<object>
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
>= 6 characters <= 1024 characters
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
>= 6 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
system_metadata
object
creation_timestamp
creation_timestamp

CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.

string format: date-time
<= 1024 characters
creator_class
creator_class

A value identifying the class of the user or service which created this configuration object.

string
<= 1024 characters
creator_id
creator_id

A value identifying the exact user or service that created this configuration object.

string
<= 1024 characters
deletion_timestamp
deletion_timestamp

DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.

Populated by the system when a graceful deletion is requested. Read-only.

string format: date-time
<= 1024 characters
finalizers
finalizers

Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed.

Array<string>
initializers
object
pending
pending

Pending is a list of initializers that must execute in order before this object is initialized. When the last pending initializer is removed, and no failing result is set, the initializers struct will be set to nil and the object is considered as initialized and visible to all clients.

Array<object>
InitializerType

Initializer is information about an initializer that has not yet completed.

object
name
name

Name of the service that is responsible for initializing this object.

string
>= 6 characters <= 1024 characters
result
object
code
code

Suggested HTTP return code for this status, 0 if not set.

integer format: int32
reason
reason

A human-readable description of why this operation is in the “Failure” status. If this value is empty there is no information available.

string
>= 27 characters <= 1024 characters
status
status

Status of the operation. One of: “Success” or “Failure”.

string
>= 17 characters <= 1024 characters
labels
labels

Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the operator or software. Values here can be interpreted by software(backend or frontend) to enable certain behavior e.g. Things marked as soft-deleted(restorable).

object
modification_timestamp
modification_timestamp

ModificationTimestamp is a timestamp representing the server time when this object was last modified.

string format: date-time
<= 1024 characters
object_index
object_index

Unique index for the object. Some objects need a unique integer index to be allocated for each object type. This field will be populated for all objects that need it and will be zero otherwise.

integer format: int64
owner_view
object
kind
kind

Kind of the view object.

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
>= 6 characters <= 1024 characters
uid
uid

UID of the view object.

string format: uuid
>= 36 characters <= 1024 characters
tenant
tenant

Tenant to which this configuration object belongs to. The value for this is found from presented credentials.

string
>= 6 characters <= 1024 characters
uid
uid

Uid is the unique in time and space value for this object. It is generated by the server on successful creation of an object and is not allowed to change on Replace API. The value of is taken from uid field of ObjectMetaType, if provided.

string format: uuid
>= 36 characters <= 1024 characters
tenant
tenant

The tenant this item belongs to.

string
>= 6 characters <= 1024 characters
uid
uid

The unique uid of this cloud_link.

string format: uuid
>= 36 characters <= 1024 characters
Example
{
  "errors": [
    {
      "code": "EOK"
    }
  ],
  "items": [
    {
      "get_spec": {
        "aws": {
          "byoc": {
            "connections": [
              {
                "virtual_interface_type": "PRIVATE"
              }
            ]
          }
        },
        "cloud_link_state": "UP",
        "status": "IN_PROGRESS"
      },
      "status_set": [
        {
          "aws_status": {
            "cloud_link_state": "UP",
            "deployment_status": "IN_PROGRESS"
          },
          "gcp_status": {
            "cloud_link_state": "UP"
          },
          "metadata": {
            "publish": "STATUS_DO_NOT_PUBLISH"
          }
        }
      ]
    }
  ]
}

401

Section titled “401”

Returned when operation is not authorized.

Media typeapplication/json
string format: string
Examplegenerated
example

403

Section titled “403”

Returned when there is no permission to access resource.

Media typeapplication/json
string format: string
Examplegenerated
example

404

Section titled “404”

Returned when resource is not found.

Media typeapplication/json
string format: string
Examplegenerated
example

409

Section titled “409”

Returned when operation on resource is conflicting with current value.

Media typeapplication/json
string format: string
Examplegenerated
example

429

Section titled “429”

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

Media typeapplication/json
string format: string
Examplegenerated
example

500

Section titled “500”

Returned when server encountered an error in processing API.

Media typeapplication/json
string format: string
Examplegenerated
example

503

Section titled “503”

Returned when service is unavailable temporarily.

Media typeapplication/json
string format: string
Examplegenerated
example

504

Section titled “504”

Returned when server timed out processing request.

Media typeapplication/json
string format: string
Examplegenerated
example