Gateway Interface

This page describes operations you can perform on gw_interfaces. List, create, get details for, update, and delete.

List Gw Interface

List all visible gw_interfaces.

Synchronous / Asynchronous

• Synchronous

Request

HTTP Request Method

• GET

HTTP Request Path

{endpoint}/v2.0/gw_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 port is connected	no
azure_gw_id	query	string	hyph-uuid-or-empty	-	Azure Gateway to which this port is connected	no
description	query	string	-	-	Description of the Gateway Interface resource	no
fic_gw_id	query	string	hyph-uuid-or-empty	-	FIC Gateway to which this port is connected	no
gcp_gw_id	query	string	hyph-uuid-or-empty	-	GCP Gateway to which this port is connected	no
gw_vipv4	query	string	ipv4	-	IP version 4 address to be assigned virtual router on VRRP	no
gw_vipv6	query	string	ipv6	-	IP version 6 address to be assigned virtual router on VRRP	no
id	query	string	hyph-uuid	-	Unique ID of the Gateway Interface resource	no
interdc_gw_id	query	string	hyph-uuid-or-empty	-	Inter DC Gateway to which this port is connected	no
internet_gw_id	query	string	hyph-uuid-or-empty	-	Internet GW to which this port is connected	no
name	query	string	-	-	Name of the Gateway Interface resource	no
netmask	query	integer	-	-	Netmask for IPv4 addresses	no
network_id	query	string	hyph-uuid-or-empty	-	Network connected to this interface	no
primary_ipv4	query	string	ipv4	-	IP version 4 address to be assigned to primary device on VRRP	no
primary_ipv6	query	string	ipv6	-	IP version 6 address to be assigned to primary device on VRRP	no
secondary_ipv4	query	string	ipv4	-	IP version 4 address to be assigned to secondary device on VRRP	no
secondary_ipv6	query	string	ipv6	-	IP version 6 address to be assigned to secondary device on VRRP	no
service_type	query	string	-	['aws', 'azure', 'fic', 'gcp', 'vpn', 'internet', 'interdc']	Service type for this interface	no
status	query	string	-	-	The Gateway Interface status.	no
tenant_id	query	string	non-hyph-uuid-or-empty	-	Tenant ID of the owner (UUID)	no
vpn_gw_id	query	string	hyph-uuid-or-empty	-	VPN Gateway to which this port is connected	no
vrid	query	integer	-	-	VRRP Group ID for this GW Interface	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
gw_interfaces	array<object>	datatype_gw_interface	-
aws_gw_id	string	hyph-uuid-or-empty	AWS Gateway to which this port is connected
azure_gw_id	string	hyph-uuid-or-empty	Azure Gateway to which this port is connected
description	string	-	Description of the Gateway Interface resource
fic_gw_id	string	hyph-uuid-or-empty	FIC Gateway to which this port is connected
gcp_gw_id	string	hyph-uuid-or-empty	GCP Gateway to which this port is connected
gw_vipv4	string	ipv4	IP version 4 address to be assigned virtual router on VRRP
gw_vipv6	string	ipv6	IP version 6 address to be assigned virtual router on VRRP
id	string	hyph-uuid	Unique ID of the Gateway Interface resource
interdc_gw_id	string	hyph-uuid-or-empty	Inter DC Gateway to which this port is connected
internet_gw_id	string	hyph-uuid-or-empty	Internet GW to which this port is connected
name	string	-	Name of the Gateway Interface resource
netmask	integer	-	Netmask for IPv4 addresses
network_id	string	hyph-uuid-or-empty	Network connected to this interface
primary_ipv4	string	ipv4	IP version 4 address to be assigned to primary device on VRRP
primary_ipv6	string	ipv6	IP version 6 address to be assigned to primary device on VRRP
secondary_ipv4	string	ipv4	IP version 4 address to be assigned to secondary device on VRRP
secondary_ipv6	string	ipv6	IP version 6 address to be assigned to secondary device on VRRP
service_type	string	-	Service type for this interface
status	string	-	The Gateway Interface status.
tenant_id	string	non-hyph-uuid-or-empty	Tenant ID of the owner (UUID)
vpn_gw_id	string	hyph-uuid-or-empty	VPN Gateway to which this port is connected
vrid	integer	-	VRRP Group ID for this GW Interface

Examples

Sample Request Body

This operation does not send a request body.

Sample Response Body

{
  "gw_interfaces": [
    {
      "aws_gw_id": null,
      "azure_gw_id": null,
      "description": "",
      "fic_gw_id": "9c5c6441-e174-4b9a-9d16-4ed38cc95dd5",
      "gcp_gw_id": null,
      "gw_vipv4": "10.25.25.1",
      "gw_vipv6": null,
      "id": "f0a7fe6b-2656-48d1-a0c4-4ba386768996",
      "interdc_gw_id": null,
      "internet_gw_id": null,
      "name": "",
      "netmask": 24,
      "network_id": "3ffabe34-3a05-4da6-b1a5-18550acfc216",
      "primary_ipv4": "10.25.25.101",
      "primary_ipv6": null,
      "secondary_ipv4": "10.25.25.102",
      "secondary_ipv6": null,
      "service_type": "fic",
      "status": "ACTIVE",
      "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8",
      "vpn_gw_id": null,
      "vrid": 10
    },
    {
      "aws_gw_id": null,
      "azure_gw_id": null,
      "description": "",
      "fic_gw_id": "dd04adc4-459f-4fc4-83a5-47436c6aece5",
      "gcp_gw_id": null,
      "gw_vipv4": "192.168.1.254",
      "gw_vipv6": null,
      "id": "f5f305b0-482a-4bb9-ac80-abf860d69c54",
      "interdc_gw_id": null,
      "internet_gw_id": null,
      "name": "GW-uchigawa",
      "netmask": 24,
      "network_id": "a9859e74-4514-4409-8d5d-11c8f85fc8f8",
      "primary_ipv4": "192.168.1.24",
      "primary_ipv6": null,
      "secondary_ipv4": "192.168.1.25",
      "secondary_ipv6": null,
      "service_type": "fic",
      "status": "ACTIVE",
      "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8",
      "vpn_gw_id": null,
      "vrid": 8
    }
  ]
}

Create Gw Interface

Create gw_interface.

Synchronous / Asynchronous

• Asynchronous

Request

HTTP Request Method

• POST

HTTP Request Path

{endpoint}/v2.0/gw_interfaces

HTTP Request Parameters

Parameter	Style	Type	Format	Enumeration	Default	Description	Required
gw_interface	plain	object	datatype_gw_interface	-	-	-	yes
description	plain	string	-	-	""	Description of the Gateway Interface resource	no
fic_gw_id	plain	string	hyph-uuid-or-empty	-	null	FIC Gateway to which this port is connected	no
gw_vipv4	plain	string	ipv4	-	-	IP version 4 address to be assigned virtual router on VRRP	yes
name	plain	string	-	-	""	Name of the Gateway Interface resource	no
netmask	plain	integer	-	-	-	Netmask for IPv4 addresses	yes
network_id	plain	string	hyph-uuid-or-empty	-	-	Network connected to this interface	yes
primary_ipv4	plain	string	ipv4	-	-	IP version 4 address to be assigned to primary device on VRRP	yes
secondary_ipv4	plain	string	ipv4	-	-	IP version 4 address to be assigned to secondary device on VRRP	yes
service_type	plain	string	-	['aws', 'azure', 'fic', 'gcp', 'vpn', 'internet', 'interdc']	-	Service type for this interface	yes
tenant_id	plain	string	non-hyph-uuid-or-empty	-	See notes.	Tenant ID of the owner (UUID)	no
vrid	plain	integer	-	-	-	VRRP Group ID for this GW Interface	yes

注釈

tenant_id: The ID of default tenant to which user belongs.

Response

HTTP Response Code List

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

HTTP Response Parameters

Parameter	Type	Format	Description
gw_interface	object	datatype_gw_interface	-
description	string	-	Description of the Gateway Interface resource
fic_gw_id	string	hyph-uuid-or-empty	FIC Gateway to which this port is connected
gw_vipv4	string	ipv4	IP version 4 address to be assigned virtual router on VRRP
id	string	hyph-uuid	Unique ID of the Gateway Interface resource
name	string	-	Name of the Gateway Interface resource
netmask	integer	-	Netmask for IPv4 addresses
network_id	string	hyph-uuid-or-empty	Network connected to this interface
primary_ipv4	string	ipv4	IP version 4 address to be assigned to primary device on VRRP
secondary_ipv4	string	ipv4	IP version 4 address to be assigned to secondary device on VRRP
service_type	string	-	Service type for this interface
status	string	-	The Gateway Interface status.
tenant_id	string	non-hyph-uuid-or-empty	Tenant ID of the owner (UUID)
vrid	integer	-	VRRP Group ID for this GW Interface

Examples

Sample Request Body

{
  "gw_interface": {
    "description": "",
    "fic_gw_id": "9c5c6441-e174-4b9a-9d16-4ed38cc95dd5",
    "gw_vipv4": "10.25.25.1",
    "name": "",
    "netmask": 24,
    "network_id": "3ffabe34-3a05-4da6-b1a5-18550acfc216",
    "primary_ipv4": "10.25.25.101",
    "secondary_ipv4": "10.25.25.102",
    "service_type": "fic",
    "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8",
    "vrid": 10
  }
}

Sample Response Body

{
  "gw_interface": {
    "description": "",
    "fic_gw_id": "9c5c6441-e174-4b9a-9d16-4ed38cc95dd5",
    "gw_vipv4": "10.25.25.1",
    "id": "f0a7fe6b-2656-48d1-a0c4-4ba386768996",
    "name": "",
    "netmask": 24,
    "network_id": "3ffabe34-3a05-4da6-b1a5-18550acfc216",
    "primary_ipv4": "10.25.25.101",
    "secondary_ipv4": "10.25.25.102",
    "service_type": "fic",
    "status": "PENDING_CREATE",
    "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8",
    "vrid": 10
  }
}

Show Gw Interface

Show details for gw_interface.

Synchronous / Asynchronous

• Synchronous

Request

HTTP Request Method

• GET

HTTP Request Path

{endpoint}/v2.0/gw_interfaces/{gw_interface_id}

HTTP Request Parameters

Parameter	Style	Type	Format	Enumeration	Description	Required
gw_interface_id	URI	string	hyph-uuid	-	Unique ID of the Gateway 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
gw_interface	object	datatype_gw_interface	-
aws_gw_id	string	hyph-uuid-or-empty	AWS Gateway to which this port is connected
azure_gw_id	string	hyph-uuid-or-empty	Azure Gateway to which this port is connected
description	string	-	Description of the Gateway Interface resource
fic_gw_id	string	hyph-uuid-or-empty	FIC Gateway to which this port is connected
gcp_gw_id	string	hyph-uuid-or-empty	GCP Gateway to which this port is connected
gw_vipv4	string	ipv4	IP version 4 address to be assigned virtual router on VRRP
gw_vipv6	string	ipv6	IP version 6 address to be assigned virtual router on VRRP
id	string	hyph-uuid	Unique ID of the Gateway Interface resource
interdc_gw_id	string	hyph-uuid-or-empty	Inter DC Gateway to which this port is connected
internet_gw_id	string	hyph-uuid-or-empty	Internet GW to which this port is connected
name	string	-	Name of the Gateway Interface resource
netmask	integer	-	Netmask for IPv4 addresses
network_id	string	hyph-uuid-or-empty	Network connected to this interface
primary_ipv4	string	ipv4	IP version 4 address to be assigned to primary device on VRRP
primary_ipv6	string	ipv6	IP version 6 address to be assigned to primary device on VRRP
secondary_ipv4	string	ipv4	IP version 4 address to be assigned to secondary device on VRRP
secondary_ipv6	string	ipv6	IP version 6 address to be assigned to secondary device on VRRP
service_type	string	-	Service type for this interface
status	string	-	The Gateway Interface status.
tenant_id	string	non-hyph-uuid-or-empty	Tenant ID of the owner (UUID)
vpn_gw_id	string	hyph-uuid-or-empty	VPN Gateway to which this port is connected
vrid	integer	-	VRRP Group ID for this GW Interface

Examples

Sample Request Body

This operation does not send a request body.

Sample Response Body

{
  "gw_interface": {
    "aws_gw_id": null,
    "azure_gw_id": null,
    "description": "",
    "fic_gw_id": "9c5c6441-e174-4b9a-9d16-4ed38cc95dd5",
    "gcp_gw_id": null,
    "gw_vipv4": "10.25.25.1",
    "gw_vipv6": null,
    "id": "f0a7fe6b-2656-48d1-a0c4-4ba386768996",
    "interdc_gw_id": null,
    "internet_gw_id": null,
    "name": "",
    "netmask": 24,
    "network_id": "3ffabe34-3a05-4da6-b1a5-18550acfc216",
    "primary_ipv4": "10.25.25.101",
    "primary_ipv6": null,
    "secondary_ipv4": "10.25.25.102",
    "secondary_ipv6": null,
    "service_type": "fic",
    "status": "ACTIVE",
    "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8",
    "vpn_gw_id": null,
    "vrid": 10
  }
}

Update Gw Interface

Update gw_interface.

Synchronous / Asynchronous

• Asynchronous

Request

HTTP Request Method

• PUT

HTTP Request Path

{endpoint}/v2.0/gw_interfaces/{gw_interface_id}

HTTP Request Parameters

Parameter	Style	Type	Format	Enumeration	Description	Required
gw_interface_id	URI	string	hyph-uuid	-	Unique ID of the Gateway Interface resource	yes
gw_interface	plain	object	datatype_gw_interface	-	-	yes
description	plain	string	-	-	Description of the Gateway Interface resource	no
name	plain	string	-	-	Name of the Gateway Interface resource	no

Response

HTTP Response Code List

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

HTTP Response Parameters

Parameter	Type	Format	Description
gw_interface	object	datatype_gw_interface	-
aws_gw_id	string	hyph-uuid-or-empty	AWS Gateway to which this port is connected
azure_gw_id	string	hyph-uuid-or-empty	Azure Gateway to which this port is connected
description	string	-	Description of the Gateway Interface resource
fic_gw_id	string	hyph-uuid-or-empty	FIC Gateway to which this port is connected
gcp_gw_id	string	hyph-uuid-or-empty	GCP Gateway to which this port is connected
gw_vipv4	string	ipv4	IP version 4 address to be assigned virtual router on VRRP
gw_vipv6	string	ipv6	IP version 6 address to be assigned virtual router on VRRP
id	string	hyph-uuid	Unique ID of the Gateway Interface resource
interdc_gw_id	string	hyph-uuid-or-empty	Inter DC Gateway to which this port is connected
internet_gw_id	string	hyph-uuid-or-empty	Internet GW to which this port is connected
name	string	-	Name of the Gateway Interface resource
netmask	integer	-	Netmask for IPv4 addresses
network_id	string	hyph-uuid-or-empty	Network connected to this interface
primary_ipv4	string	ipv4	IP version 4 address to be assigned to primary device on VRRP
primary_ipv6	string	ipv6	IP version 6 address to be assigned to primary device on VRRP
secondary_ipv4	string	ipv4	IP version 4 address to be assigned to secondary device on VRRP
secondary_ipv6	string	ipv6	IP version 6 address to be assigned to secondary device on VRRP
service_type	string	-	Service type for this interface
status	string	-	The Gateway Interface status.
tenant_id	string	non-hyph-uuid-or-empty	Tenant ID of the owner (UUID)
vpn_gw_id	string	hyph-uuid-or-empty	VPN Gateway to which this port is connected
vrid	integer	-	VRRP Group ID for this GW Interface

Examples

Sample Request Body

{
  "gw_interface": {
    "description": "",
    "name": ""
  }
}

Sample Response Body

{
  "gw_interface": {
    "aws_gw_id": null,
    "azure_gw_id": null,
    "description": "",
    "fic_gw_id": "9c5c6441-e174-4b9a-9d16-4ed38cc95dd5",
    "gcp_gw_id": null,
    "gw_vipv4": "10.25.25.1",
    "gw_vipv6": null,
    "id": "f0a7fe6b-2656-48d1-a0c4-4ba386768996",
    "interdc_gw_id": null,
    "internet_gw_id": null,
    "name": "",
    "netmask": 24,
    "network_id": "3ffabe34-3a05-4da6-b1a5-18550acfc216",
    "primary_ipv4": "10.25.25.101",
    "primary_ipv6": null,
    "secondary_ipv4": "10.25.25.102",
    "secondary_ipv6": null,
    "service_type": "fic",
    "status": "PENDING_UPDATE",
    "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8",
    "vpn_gw_id": null,
    "vrid": 10
  }
}

Delete Gw Interface

Delete gw_interface.

Synchronous / Asynchronous

• Asynchronous

Request

HTTP Request Method

• DELETE

HTTP Request Path

{endpoint}/v2.0/gw_interfaces/{gw_interface_id}

HTTP Request Parameters

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

Response

HTTP Response Code List

Response Code	Description
204	No Content
400	Bad Request
401	UnAuthorized
404	Not Found
409	Conflict
500	Internal Server Error

HTTP Response Parameters

This operation does not receive a response body.

Examples

Sample Request Body

This operation does not send a request body.

Sample Response Body

This operation does not receive a response body.

目次

• FIC Service
  • FIC Service
  • FIC Gateway
  • Gateway Interface
  • FIC Interface
  • Static Route
  • QoS Options

• Revision History

---

FIC Gateway

FIC Interface