AWS Interface¶

This page describes operations you can perform on aws_interfaces. List, and get details for.

List Aws Interface¶

List all visible aws_interfaces.

Synchronous / Asynchronous¶

Synchronous

Request¶

HTTP Request Method¶

GET

HTTP Request Path¶

{endpoint}/v2.0/aws_interfaces

HTTP Request Parameters¶

Parameter	Style	Type	Format	Enumeration	Description	Required
aws_gw_id	query	string	hyph-uuid-or-empty	-	AWS Gateway to which this interface is connected	no
description	query	string	-	-	Description of the AWS Interface resource	no
id	query	string	-	-	Unique ID of the AWS Interface resource	no
name	query	string	-	-	Name of the AWS Interface resource	no
status	query	string	-	-	The AWS Interface status.	no
tenant_id	query	string	non-hyph-uuid	-	Tenant ID of the owner (UUID)	no

Response¶

HTTP Response Code List¶

Response Code	Description
200	OK
400	Bad Request
401	UnAuthorized
404	Not Found
500	Internal Server Error

HTTP Response Parameters¶

Parameter	Type	Format	Description
aws_interfaces	array<object>	AWS Interface	-
aws_gw_id	string	hyph-uuid-or-empty	AWS Gateway to which this interface is connected
description	string	-	Description of the AWS Interface resource
id	string	-	Unique ID of the AWS Interface resource
name	string	-	Name of the AWS Interface resource
primary	object	-	Primary router uplink ip configuration
bgp_peer_ip	string	ipv4	Address of the eBGP peer
bgp_router_id	string	ipv4	Router id used in virtual-router config (defaults to ip_address)
ip_address	string	cidr	Address of the uplink interface
secondary	object	-	Secondary router uplink ip configuration
bgp_peer_ip	string	ipv4	Address of the eBGP peer
bgp_router_id	string	ipv4	Router id used in virtual-router config (defaults to ip_address)
ip_address	string	cidr	Address of the uplink interface
status	string	-	The AWS Interface status.
tenant_id	string	non-hyph-uuid	Tenant ID of the owner (UUID)

Examples¶

Sample Request Body¶

This operation does not send a request body.

Sample Response Body¶

{
  "aws_interfaces": [
    {
      "aws_gw_id": "b6d96194-f74a-4beb-97cd-727f02b0e070",
      "description": "aws-interface-1-tenantA",
      "id": "278dfbe4-f8cc-4ce4-aa17-561401c01661",
      "name": "aws-interface-1",
      "primary": {
        "bgp_peer_ip": "10.2.121.1",
        "bgp_router_id": "10.2.121.10",
        "ip_address": "10.2.121.10/25"
      },
      "secondary": {
        "bgp_peer_ip": "10.2.121.129",
        "bgp_router_id": "10.2.121.130",
        "ip_address": "10.2.121.130/25"
      },
      "status": "DOWN",
      "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8"
    },
    {
      "aws_gw_id": "07f97269-e616-4dff-a73f-ca80bc5682dc",
      "description": "aws-interface-2-tenantB",
      "id": "82098893-b394-4d52-9d24-3df57e63d750",
      "name": "aws-interface-2",
      "primary": {
        "bgp_peer_ip": "10.2.121.1",
        "bgp_router_id": "10.2.121.10",
        "ip_address": "10.2.121.10/25"
      },
      "secondary": {
        "bgp_peer_ip": "10.2.121.129",
        "bgp_router_id": "10.2.121.130",
        "ip_address": "10.2.121.130/25"
      },
      "status": "DOWN",
      "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8"
    }
  ]
}

Show Aws Interface¶

Show details for aws_interface.