Skip to content
API Enriched

GET BGP Status for view.

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

Returned from list of BGP status objects for a given view.

Examples of this operation.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
namespace
required
string

Namespace Namespace for the label to be retrieved.

view_name
required
string

Name of view Name of the view for which BGP status objects are requested.

Query Parameters

Section titled “Query Parameters”
view_kind
string

Kind of view of which BGP status objects are requested e.g. Aws_tgw_site.

Responses

Section titled “Responses”

200

Section titled “200”

A successful response.

Media typeapplication/json
GetStatusResponse

Response for GetStatus API.

object
status
status

The status reported by different services for this configuration object.

Array<object>
>= 17 characters <= 17 characters
BGP Status

Most recently observed status of object.

object
bgp_status
object
local_asn
Local ASN

Autonomous System Number (ASN) of the VER.

integer format: int64
local_router_id
Local Router ID

Router ID of the VER.

string
<= 1024 characters
peer_status_list
BGP Peer Status

Status of the BGP Peer.

Array<object>
BGP Peer Status

Most recently observed status of the BGP Peering session.

object
advertised_prefix_count
Advertised Prefix Count

Number of prefixes advertised to the peer.

integer format: int64
connection_flap_count
Connection Flap Count

Number of times the connection moved from Established state to a non Established state.

integer format: int64
interface_name
Interface Name

Name of the interface through which peering is being done.

string
<= 1024 characters
local_address
Local Address

Local address used by the VER to connect to the peer.

string
<= 1024 characters
peer_address
object
ipv4
object
addr
IPv4 Address

IPv4 Address in string form with dot-decimal notation.

string
<= 1024 characters
ipv6
object
addr
IPv6 Address

IPv6 Address in form of string. IPv6 address must be specified as hexadecimal numbers separated by ’:’ The address can be compacted by suppressing zeros e.g. ‘2001:db8:0:0:0:0:2:1’ becomes ‘2001:db8::2:1’ or ‘2001:db8:0:0:0:2:0:0’ becomes ‘2001:db8::2::’

string
<= 1024 characters
peer_asn
Peer ASN

Autonomous System Number (ASN) of the Peer.

integer format: int64
peer_port
Peer Port

Port used by the Peer.

integer format: int64
peer_router_id
Peer Router ID

Router ID of the peer.

string
<= 1024 characters
protocol_status
string
default: Unknown
Allowed values: Unknown Idle Connect Active OpenSent OpenConfirm Established Clearing Deleted
received_prefix_count
Received Prefix Count

Number of prefixes received from the peer.

integer format: int64
up_down
string
default: BGP_PEER_DOWN
Allowed values: BGP_PEER_DOWN BGP_PEER_UP
up_down_timestamp
State Change Timestamp

Timestamp at which last state change to Established state or to not Established state happened.

string format: date-time
<= 1024 characters
bfd_status
object
state
string
default: BFD_PEER_UNKNOWN
Allowed values: BFD_PEER_UNKNOWN BFD_PEER_DOWN BFD_PEER_UP BFD_PEER_ADMIN_DOWN BFD_PEER_INIT
state_change_timestamp
State Change Timestamp

Timestamp at which last BFD state change happened.

string format: date-time
<= 1024 characters
tunnel
External Connector Object

Internal reference to tunnel object corresponding to this BGP.

Array<object>
<= 1 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
>= 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
conditions
conditions

Conditions reported by various components 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

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” Validation has succeeded. 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
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
Example
{
  "status": [
    {
      "bgp_status": {
        "peer_status_list": [
          {
            "protocol_status": "Unknown",
            "up_down": "BGP_PEER_DOWN",
            "bfd_status": {
              "state": "BFD_PEER_UNKNOWN"
            }
          }
        ]
      },
      "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