Modifying Global DC Gateway Route Tables

Function

This API is used to modify the route tables for a global DC gateway.

Calling Method

For details, see Calling APIs.

URI

PUT /v3/{project_id}/dcaas/gdgw/{gdgw_id}/routetables

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Specifies the project ID. Minimum: 0 Maximum: 36
gdgw_id	Yes	String	Specifies the global DC gateway ID.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Specifies the user token. To obtain the token, see section "Obtaining the User Token" in the Identity and Access Management API Reference. The token is the value of X-Subject-Token in the response header. Minimum: 0 Maximum: 10240

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
dry_run	No	Boolean	Specifies whether dry run is allowed.
gdgw_routetable	No	GdgwRouteTableRequest object	Specifies the global DC gateway route table whose routes are to be modified.

**Table 4** GdgwRouteTableRequest
Parameter	Mandatory	Type	Description
add_routes	No	Array of objects	Specifies the routes to be added. Array Length: 0 - 100
del_routes	No	Array of objects	Specifies the routes to be deleted. Array Length: 0 - 100
update_routes	No	Array of objects	Route to be updated Only the additional information about the route is updated. The route update operation of the switch is not performed. Currently, the route description can be updated. Array Length: 0 - 100

**Table 5** add_routes
Parameter	Mandatory	Type	Description
type	Yes	String	Specifies the next hop type. vif_peer: virtual interface peer gdgw: global DC gateway
destination	Yes	String	Specifies the subnet the route is destined for.
nexthop	Yes	String	Specifies the next hop ID.
description	No	String	Provides supplementary information about the route.

**Table 6** del_routes
Parameter	Mandatory	Type	Description
type	Yes	String	Specifies the next hop type. vif_peer: virtual interface peer gdgw: global DC gateway
destination	Yes	String	Specifies the subnet the route is destined for.
nexthop	Yes	String	Specifies the next hop ID.

**Table 7** update_routes
Parameter	Mandatory	Type	Description
destination	Yes	String	Specifies the subnet the route is destined for.
nexthop	Yes	String	Specifies the next hop ID.
description	No	String	Provides supplementary information about the route.

Response Parameters

Status code: 200

**Table 8** Response body parameters
Parameter	Type	Description
request_id	String	Specifies the request ID. Minimum: 0 Maximum: 36
gdgw_routetable	Array of CommonRoutetable objects	Specifies the ID of the route table for the global DC gateway. Array Length: 0 - 2000

**Table 9** CommonRoutetable
Parameter	Type	Description
id	String	Specifies the route ID. Minimum: 36 Maximum: 36
tenant_id	String	Specifies the tenant ID. Minimum: 64 Maximum: 64
gateway_id	String	Specifies the gateway ID. Minimum: 36 Maximum: 36
destination	String	Specifies the subnet the route is destined for. Minimum: 64 Maximum: 64
nexthop	String	Specifies the next hop ID. Minimum: 36 Maximum: 36
obtain_mode	String	Specifies the route type. customized: default route specific: custom route bgp: BGP route
status	String	Specifies the route status. ACTIVE: The route has been delivered. ERROR: Failed to deliver the route. PENDING_CREATE: The route is to be delivered.
address_family	String	Specifies the address family. ipv4: IPv4 addresses ipv6: IPv6 addresses
description	String	Describes the route. Minimum: 0 Maximum: 1024
type	String	Specifies the next hop type. vif_peer: virtual interface peer gdgw: global DC gateway Minimum: 0 Maximum: 255

Example Requests

Updating the route tables for a global DC gateway

PUT https://{dc_endpoint}/v3/4bd6efdb0fb747b39aa2c0162c112226/dcaas/gdgw/0851a5e0-6623-42c2-bb02-b8956e313dd8/routetables

{
  "gdgw_routetable" : {
    "add_routes" : [ {
      "destination" : "1.1.1.0/24",
      "nexthop" : "b9060822-06bf-4c48-995d-29a3fb04a3c3",
      "type" : "vif_peer",
      "description" : ""
    } ]
  }
}

Example Responses

Status code: 200

Response body for updating the route tables for a global DC gateway

{
  "request_id" : "d365091f89df06c8737bd81a72efc8b2",
  "gdgw_routetable" : [ {
    "id" : "94912503-0a97-48ee-909b-6676129a565e",
    "description" : "",
    "tenant_id" : "4bd6efdb0fb747b39aa2c0162c112226",
    "gateway_id" : "0851a5e0-6623-42c2-bb02-b8956e313dd8",
    "destination" : "1.1.1.0/24",
    "nexthop" : "b9060822-06bf-4c48-995d-29a3fb04a3c3",
    "type" : "vif_peer",
    "obtain_mode" : "specific",
    "status" : "PENDING_CREATE",
    "address_family" : "ipv4"
  } ]
}