GCP Interface

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

List Gcp Interface

List all visible gcp_interfaces.

Synchronous / Asynchronous

  • Synchronous

Request

HTTP Request Method

  • GET

HTTP Request Path

{endpoint}/v2.0/gcp_interfaces

HTTP Request Parameters

Parameter Style Type Format Enumeration Description Required
description query string - - Description of the GCP Interface resource no
gcp_gw_id query string hyph-uuid-or-empty - GCP Gateway to which this interface is connected no
id query string - - Unique ID of the GCP Interface resource no
name query string - - Name of the GCP Interface resource no
status query string - - The GCP 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
gcp_interfaces array<object> GCP Interface -
description string - Description of the GCP Interface resource
gcp_gw_id string hyph-uuid-or-empty GCP Gateway to which this interface is connected
id string - Unique ID of the GCP Interface resource
name string - Name of the GCP 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 GCP 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

{
  "gcp_interfaces": [
    {
      "description": "gcp-interface-1-tenantA",
      "gcp_gw_id": "b6d96194-f74a-4beb-97cd-727f02b0e070",
      "id": "278dfbe4-f8cc-4ce4-aa17-561401c01661",
      "name": "gcp-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"
    },
    {
      "description": "gcp-interface-2-tenantB",
      "gcp_gw_id": "07f97269-e616-4dff-a73f-ca80bc5682dc",
      "id": "82098893-b394-4d52-9d24-3df57e63d750",
      "name": "gcp-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 Gcp Interface

Show details for gcp_interface.

Synchronous / Asynchronous

  • Synchronous

Request

HTTP Request Method

  • GET

HTTP Request Path

{endpoint}/v2.0/gcp_interfaces/{gcp_interface_id}

HTTP Request Parameters

Parameter Style Type Format Enumeration Description Required
gcp_interface_id URI string hyph-uuid - Unique ID of the GCP Interface resource yes

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
gcp_interface object GCP Interface -
description string - Description of the GCP Interface resource
gcp_gw_id string hyph-uuid-or-empty GCP Gateway to which this interface is connected
id string - Unique ID of the GCP Interface resource
name string - Name of the GCP 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 GCP 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

{
  "gcp_interface": {
    "description": "gcp-interface-1-tenantA",
    "gcp_gw_id": "b6d96194-f74a-4beb-97cd-727f02b0e070",
    "id": "278dfbe4-f8cc-4ce4-aa17-561401c01661",
    "name": "gcp-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"
  }
}