Skip to content
API Enriched

GET Route Table.

GET
/api/data/namespaces/system/topology/route_table/{name}
curl --request GET \
  --url https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/data/namespaces/system/topology/route_table/example \
  --header 'Authorization: <Authorization>'

GET Route Table.

Examples of this operation.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
name
required
string

Name

x-required Route table name.

Responses

Section titled “Responses”

200

Section titled “200”

A successful response.

Media typeapplication/json
Route Table Response

Route table.

object
metadata
object
cloud_resource_id
Cloud Resource Id

Cloud Resource Identifier this route table.

string
<= 1024 characters
name
Name

Name of the route table.

string
>= 6 characters <= 1024 characters
tags
tags

Map of string keys and values that annotated in the topology node.

object
route_table
object
associations
Associations

List of associations.

Array<object>
AWSTGWAttachmentMetaData

AWS TGW AWSTGWAttachment MetaData.

object
id
Attachment ID

TGW Attachment ID.

string
>= 1 <= 4094 <= 1024 characters
resource_id
Resource ID

Resource ID.

string
<= 1024 characters
resource_name
Resource Name

Resource Name.

string
<= 1024 characters
resource_type
Resource Type

Resource Type.

string
<= 1024 characters
state
Association/Propagation State

Association/Propagation State.

string
<= 1024 characters
explicit_subnet
Explicit Subnet Association

Reference to the subnet explicitly accociated.

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
implicit_subnet
Implicit Subnet Association

Reference to the subnet implicitly accociated.

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
network
Network

Reference to the network.

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
propagations
Propagations

List of propagations.

Array<object>
AWSTGWAttachmentMetaData

AWS TGW AWSTGWAttachment MetaData.

object
id
Attachment ID

TGW Attachment ID.

string
>= 1 <= 4094 <= 1024 characters
resource_id
Resource ID

Resource ID.

string
<= 1024 characters
resource_name
Resource Name

Resource Name.

string
<= 1024 characters
resource_type
Resource Type

Resource Type.

string
<= 1024 characters
state
Association/Propagation State

Association/Propagation State.

string
<= 1024 characters
route_table_state
string
default: ROUTE_TABLE_STATE_NONE
Allowed values: ROUTE_TABLE_STATE_NONE ROUTE_TABLE_STATE_PENDING ROUTE_TABLE_STATE_AVAILABLE ROUTE_TABLE_STATE_DELETING ROUTE_TABLE_STATE_DELETED
route_table_type
string
default: ROUTE_TABLE_NETWORK
Allowed values: ROUTE_TABLE_NETWORK ROUTE_TABLE_TGW
routes
Routes

List of routes.

Array<object>
RouteType

A canonical form of the route.

object
aws
object
propagated
Propagated

Is route propagated.

boolean format: boolean
tgw
object
next_hop_attachment
Next Hop Attachment

Next Hop Attachment.

Array<object>
AWSTGWAttachmentMetaData

AWS TGW AWSTGWAttachment MetaData.

object
id
Attachment ID

TGW Attachment ID.

string
>= 1 <= 4094 <= 1024 characters
resource_id
Resource ID

Resource ID.

string
<= 1024 characters
resource_name
Resource Name

Resource Name.

string
<= 1024 characters
resource_type
Resource Type

Resource Type.

string
<= 1024 characters
state
Association/Propagation State

Association/Propagation State.

string
<= 1024 characters
route_type
Route Type

Route Type.

string
<= 1024 characters
destination
Destination

Destination.

string
<= 1024 characters
gcp
object
ip_version
IP version

Version of IP protocol.

string
<= 1024 characters
priority
Priority

Route Priority.

integer format: int64
route_name
GCP Route Name

GCP Route Name.

string
<= 1024 characters
route_type
string
default: GCP_ROUTE_TYPE_NONE
Allowed values: GCP_ROUTE_TYPE_NONE GCP_ROUTE_TYPE_TRANSIT GCP_ROUTE_TYPE_SUBNET GCP_ROUTE_TYPE_STATIC GCP_ROUTE_TYPE_BGP
scope_limits
Scope Limits

Limits on the scope of route like network tag.

Array<string>
next_hop_type
string
default: VIRTUAL_NETWORK_GATEWAY
Allowed values: VIRTUAL_NETWORK_GATEWAY VNET_LOCAL INTERNET VIRTUAL_APPLIANCE NONE VNET_PEERING VIRTUAL_NETWORK_SERVICE_ENDPOINT NEXT_HOP_TYPE_NOT_APPLICABLE LOADBALANCER VPC_NETWORK VPC_PEERING INTERNAL_LOAD_BALANCER INSTANCE INTERCONNECT INTERNET_GATEWAY IP VPN_TUNNEL TGW_ATTACHMENT
nexthop
Nexthop

Nexthop (IP subnet or gateway ID)

string
<= 1024 characters
source
string
default: INVALID_SOURCE
Allowed values: INVALID_SOURCE DEFAULT USER UNKNOWN VIRTUAL_NETWORK_GATEWAY_SOURCE SOURCE_NOT_APPLICABLE
state
string
default: ACTIVE_STATE
Allowed values: ACTIVE_STATE INVALID_STATE STATE_NOT_APPLICABLE STATE_BLACKHOLE STATE_UNAVAILABLE STATE_PENDING STATE_DELETING STATE_DELETED
user_defined_route_name
User Defined Route Name

User Defined Route Name.

string
<= 1024 characters
subnet
Subnet

Reference to the subnet.

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
transit_gateway
Transit Gateway

Reference to the transit gateway if a transit gateway owns this resource.

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
{
  "route_table": {
    "route_table_state": "ROUTE_TABLE_STATE_NONE",
    "route_table_type": "ROUTE_TABLE_NETWORK",
    "routes": [
      {
        "gcp": {
          "route_type": "GCP_ROUTE_TYPE_NONE"
        },
        "next_hop_type": "VIRTUAL_NETWORK_GATEWAY",
        "source": "INVALID_SOURCE",
        "state": "ACTIVE_STATE"
      }
    ]
  }
}

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