Static Route

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

List Static Route

List all visible static_routes.

Synchronous / Asynchronous

• Synchronous

Request

HTTP Request Method

• GET

HTTP Request Path

{endpoint}/v2.0/static_routes

HTTP Request Parameters

Parameter	Style	Type	Format	Enumeration	Description	Required
aws_gw_id	query	string	hyph-uuid-or-empty	-	AWS Gateway on which this static route will be set	no
azure_gw_id	query	string	hyph-uuid-or-empty	-	Azure Gateway on which this static route will be set	no
description	query	string	-	-	Description of the Static Route resource	no
destination	query	string	cidr-or-ipv4	-	CIDR this static route points to	no
fic_gw_id	query	string	hyph-uuid-or-empty	-	FIC Gateway on which this static route will be set	no
gcp_gw_id	query	string	hyph-uuid-or-empty	-	GCP Gateway on which this static route will be set	no
id	query	string	hyph-uuid	-	Unique ID of the Static Route resource	no
interdc_gw_id	query	string	hyph-uuid-or-empty	-	Inter DC Gateway on which this static route will be set	no
internet_gw_id	query	string	hyph-uuid-or-empty	-	Internet Gateway on which this static route will be set	no
name	query	string	-	-	Name of the Static Route resource	no
nexthop	query	string	ipv4	-	Next Hop address for specified CIDR	no
service_type	query	string	-	['aws', 'azure', 'fic', 'gcp', 'vpn', 'internet', 'interdc']	Service type for this route	no
status	query	string	-	-	Static Route status.	no
tenant_id	query	string	non-hyph-uuid	-	Tenant ID of the owner (UUID)	no
vpn_gw_id	query	string	hyph-uuid-or-empty	-	VPN Gateway on which this static route will be set	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
static_routes	array<object>	datatype_static_route	-
aws_gw_id	string	hyph-uuid-or-empty	AWS Gateway on which this static route will be set
azure_gw_id	string	hyph-uuid-or-empty	Azure Gateway on which this static route will be set
description	string	-	Description of the Static Route resource
destination	string	cidr-or-ipv4	CIDR this static route points to
fic_gw_id	string	hyph-uuid-or-empty	FIC Gateway on which this static route will be set
gcp_gw_id	string	hyph-uuid-or-empty	GCP Gateway on which this static route will be set
id	string	hyph-uuid	Unique ID of the Static Route resource
interdc_gw_id	string	hyph-uuid-or-empty	Inter DC Gateway on which this static route will be set
internet_gw_id	string	hyph-uuid-or-empty	Internet Gateway on which this static route will be set
name	string	-	Name of the Static Route resource
nexthop	string	ipv4	Next Hop address for specified CIDR
service_type	string	-	Service type for this route
status	string	-	Static Route status.
tenant_id	string	non-hyph-uuid	Tenant ID of the owner (UUID)
vpn_gw_id	string	hyph-uuid-or-empty	VPN Gateway on which this static route will be set

Examples

Sample Request Body

This operation does not send a request body.

Sample Response Body

{
  "static_routes": [
    {
      "aws_gw_id": null,
      "azure_gw_id": null,
      "description": "",
      "destination": "100.127.254.152/29",
      "fic_gw_id": null,
      "gcp_gw_id": null,
      "id": "93aaec0f-1546-4062-88c5-93c397b93c03",
      "interdc_gw_id": null,
      "internet_gw_id": "3c5703b7-e783-42fe-ba23-5b0fe872cccb",
      "name": "TEST-01",
      "nexthop": "100.127.254.153",
      "service_type": "internet",
      "status": "ACTIVE",
      "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8",
      "vpn_gw_id": null
    },
    {
      "aws_gw_id": null,
      "azure_gw_id": null,
      "description": "jbd test",
      "destination": "100.127.254.70/31",
      "fic_gw_id": null,
      "gcp_gw_id": null,
      "id": "a0caa2c8-5d30-49cd-a5f2-99517a4d848b",
      "interdc_gw_id": null,
      "internet_gw_id": "b684b775-63cc-40e6-b615-cc88c804df19",
      "name": "jbd_test_StaticRoute001",
      "nexthop": "192.168.1.0",
      "service_type": "internet",
      "status": "ACTIVE",
      "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8",
      "vpn_gw_id": null
    }
  ]
}

Create Static Route

Create static_route.

Synchronous / Asynchronous

• Asynchronous

Request

HTTP Request Method

• POST

HTTP Request Path

{endpoint}/v2.0/static_routes

HTTP Request Parameters

Parameter	Style	Type	Format	Enumeration	Default	Description	Required
static_route	plain	object	datatype_static_route	-	-	-	yes
description	plain	string	-	-	""	Description of the Static Route resource	no
destination	plain	string	cidr-or-ipv4	-	-	CIDR this static route points to	yes
internet_gw_id	plain	string	hyph-uuid-or-empty	-	null	Internet Gateway on which this static route will be set	no
name	plain	string	-	-	""	Name of the Static Route resource	no
nexthop	plain	string	ipv4	-	-	Next Hop address for specified CIDR	yes
service_type	plain	string	-	['aws', 'azure', 'fic', 'gcp', 'vpn', 'internet', 'interdc']	-	Service type for this route	yes
tenant_id	plain	string	non-hyph-uuid	-	See notes.	Tenant ID of the owner (UUID)	no

注釈

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
static_route	object	datatype_static_route	-
description	string	-	Description of the Static Route resource
destination	string	cidr-or-ipv4	CIDR this static route points to
id	string	hyph-uuid	Unique ID of the Static Route resource
internet_gw_id	string	hyph-uuid-or-empty	Internet Gateway on which this static route will be set
name	string	-	Name of the Static Route resource
nexthop	string	ipv4	Next Hop address for specified CIDR
service_type	string	-	Service type for this route
status	string	-	Static Route status.
tenant_id	string	non-hyph-uuid	Tenant ID of the owner (UUID)

Examples

Sample Request Body

{
  "static_route": {
    "description": "",
    "destination": "100.127.254.152/29",
    "internet_gw_id": "3c5703b7-e783-42fe-ba23-5b0fe872cccb",
    "name": "TEST-01",
    "nexthop": "100.127.254.153",
    "service_type": "internet",
    "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8"
  }
}

Sample Response Body

{
  "static_route": {
    "description": "",
    "destination": "100.127.254.152/29",
    "id": "93aaec0f-1546-4062-88c5-93c397b93c03",
    "internet_gw_id": "3c5703b7-e783-42fe-ba23-5b0fe872cccb",
    "name": "TEST-01",
    "nexthop": "100.127.254.153",
    "service_type": "internet",
    "status": "PENDING_CREATE",
    "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8"
  }
}

Show Static Route

Show details for static_route.

Synchronous / Asynchronous

• Synchronous

Request

HTTP Request Method

• GET

HTTP Request Path

{endpoint}/v2.0/static_routes/{static_route_id}

HTTP Request Parameters

Parameter	Style	Type	Format	Enumeration	Description	Required
static_route_id	URI	string	hyph-uuid	-	Unique ID of the Static Route 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
static_route	object	datatype_static_route	-
aws_gw_id	string	hyph-uuid-or-empty	AWS Gateway on which this static route will be set
azure_gw_id	string	hyph-uuid-or-empty	Azure Gateway on which this static route will be set
description	string	-	Description of the Static Route resource
destination	string	cidr-or-ipv4	CIDR this static route points to
fic_gw_id	string	hyph-uuid-or-empty	FIC Gateway on which this static route will be set
gcp_gw_id	string	hyph-uuid-or-empty	GCP Gateway on which this static route will be set
id	string	hyph-uuid	Unique ID of the Static Route resource
interdc_gw_id	string	hyph-uuid-or-empty	Inter DC Gateway on which this static route will be set
internet_gw_id	string	hyph-uuid-or-empty	Internet Gateway on which this static route will be set
name	string	-	Name of the Static Route resource
nexthop	string	ipv4	Next Hop address for specified CIDR
service_type	string	-	Service type for this route
status	string	-	Static Route status.
tenant_id	string	non-hyph-uuid	Tenant ID of the owner (UUID)
vpn_gw_id	string	hyph-uuid-or-empty	VPN Gateway on which this static route will be set

Examples

Sample Request Body

This operation does not send a request body.

Sample Response Body

{
  "static_route": {
    "aws_gw_id": null,
    "azure_gw_id": null,
    "description": "",
    "destination": "100.127.254.152/29",
    "fic_gw_id": null,
    "gcp_gw_id": null,
    "id": "93aaec0f-1546-4062-88c5-93c397b93c03",
    "interdc_gw_id": null,
    "internet_gw_id": "3c5703b7-e783-42fe-ba23-5b0fe872cccb",
    "name": "TEST-01",
    "nexthop": "100.127.254.153",
    "service_type": "internet",
    "status": "ACTIVE",
    "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8",
    "vpn_gw_id": null
  }
}

Update Static Route

Update static_route.

Synchronous / Asynchronous

• Asynchronous

Request

HTTP Request Method

• PUT

HTTP Request Path

{endpoint}/v2.0/static_routes/{static_route_id}

HTTP Request Parameters

Parameter	Style	Type	Format	Enumeration	Description	Required
static_route_id	URI	string	hyph-uuid	-	Unique ID of the Static Route resource	yes
static_route	plain	object	datatype_static_route	-	-	yes
description	plain	string	-	-	Description of the Static Route resource	no
name	plain	string	-	-	Name of the Static Route 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
static_route	object	datatype_static_route	-
aws_gw_id	string	hyph-uuid-or-empty	AWS Gateway on which this static route will be set
azure_gw_id	string	hyph-uuid-or-empty	Azure Gateway on which this static route will be set
description	string	-	Description of the Static Route resource
destination	string	cidr-or-ipv4	CIDR this static route points to
fic_gw_id	string	hyph-uuid-or-empty	FIC Gateway on which this static route will be set
gcp_gw_id	string	hyph-uuid-or-empty	GCP Gateway on which this static route will be set
id	string	hyph-uuid	Unique ID of the Static Route resource
interdc_gw_id	string	hyph-uuid-or-empty	Inter DC Gateway on which this static route will be set
internet_gw_id	string	hyph-uuid-or-empty	Internet Gateway on which this static route will be set
name	string	-	Name of the Static Route resource
nexthop	string	ipv4	Next Hop address for specified CIDR
service_type	string	-	Service type for this route
status	string	-	Static Route status.
tenant_id	string	non-hyph-uuid	Tenant ID of the owner (UUID)
vpn_gw_id	string	hyph-uuid-or-empty	VPN Gateway on which this static route will be set

Examples

Sample Request Body

{
  "static_route": {
    "description": "",
    "name": "TEST-01"
  }
}

Sample Response Body

{
  "static_route": {
    "aws_gw_id": null,
    "azure_gw_id": null,
    "description": "",
    "destination": "100.127.254.152/29",
    "fic_gw_id": null,
    "gcp_gw_id": null,
    "id": "93aaec0f-1546-4062-88c5-93c397b93c03",
    "interdc_gw_id": null,
    "internet_gw_id": "3c5703b7-e783-42fe-ba23-5b0fe872cccb",
    "name": "TEST-01",
    "nexthop": "100.127.254.153",
    "service_type": "internet",
    "status": "PENDING_UPDATE",
    "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8",
    "vpn_gw_id": null
  }
}

Delete Static Route

Delete static_route.

Synchronous / Asynchronous

• Asynchronous

Request

HTTP Request Method

• DELETE

HTTP Request Path

{endpoint}/v2.0/static_routes/{static_route_id}

HTTP Request Parameters

Parameter	Style	Type	Format	Enumeration	Description	Required
static_route_id	URI	string	hyph-uuid	-	Unique ID of the Static Route 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.

目次

• Internet Gateway Service
  • Internet Service
  • Internet Gateway
  • Public IPs
  • Gateway Interface
  • Static Route
  • QoS Options

• Revision History

---

Gateway Interface

QoS Options