Help Center/ Direct Connect/ API Reference/ API/ Global DC Gateway Route Tables/ Modifying Global DC Gateway Route Tables
Updated on 2026-11-11 GMT+08:00

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.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    dcaas:gdgw:updateGdgwRouteTable

    Write

    gdgw *

    • g:EnterpriseProjectId

    • g:ResourceTag/<tag-key>

    -

    -

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Specifies the project ID.

Constraints

N/A

Range

N/A

Default Value

N/A

gdgw_id

Yes

String

Definition

Specifies the global DC gateway ID.

Constraints

N/A

Range

The value is in UUID format and is connected by hyphens (-).

Default Value

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

Specifies the user token. To obtain the token, see section "Obtaining the User Token" in the Identity and Access Management API Reference. After the request is processed, the value of X-Subject-Token in the header is the token value.

Constraints

N/A

Range

N/A

Default Value

N/A

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

dry_run

No

Boolean

Definition

Specifies whether dry run is used.

Constraints

N/A

Range

  • true: The dry run mode is used.

  • false: The dry run mode is not used.

Default Value

N/A

gdgw_routetable

No

GdgwRouteTableRequest object

Definition

Specifies the input parameters for modifying the routes of a global DC gateway route table.

Constraints

N/A

Table 4 GdgwRouteTableRequest

Parameter

Mandatory

Type

Description

add_routes

No

Array of objects

Definition

Specifies the routes to be added.

Constraints

The array length ranges from 0 to 100.

del_routes

No

Array of objects

Definition

Specifies the routes to be deleted.

Constraints

The array length ranges from 0 to 100.

update_routes

No

Array of objects

Definition

Specifies the routes to be updated.

Only the additional information about the routes is updated. The routes will not be updated for the switch. Currently, the route description can be updated.

Constraints

The array length ranges from 0 to 100.

Table 5 add_routes

Parameter

Mandatory

Type

Description

type

Yes

String

Definition

Specifies the next hop type.

  • vif_peer: virtual interface peer

  • gdgw: global DC gateway

Constraints

N/A

Range

  • vif_peer: virtual interface peer

  • gdgw: global DC gateway

Default Value

N/A

destination

Yes

String

Definition

Specifies the subnet the route is destined for.

Constraints

N/A

Range

N/A

Default Value

N/A

nexthop

Yes

String

Definition

Specifies the next hop ID.

Constraints

N/A

Range

The value can contain a maximum of 255 characters.

Default Value

N/A

description

No

String

Definition

Describes the route.

Constraints

N/A

Range

The value can contain a maximum of 255 characters except angle brackets (< and >) and backquotes (`).

Default Value

N/A

Table 6 del_routes

Parameter

Mandatory

Type

Description

type

Yes

String

Definition

Specifies the next hop type.

  • vif_peer: virtual interface peer

  • gdgw: global DC gateway

Constraints

N/A

Range

  • vif_peer: virtual interface peer

  • gdgw: global DC gateway

Default Value

N/A

destination

Yes

String

Definition

Specifies the subnet the route is destined for.

Constraints

N/A

Range

N/A

Default Value

N/A

nexthop

Yes

String

Definition

Specifies the next hop ID.

Constraints

N/A

Range

The value can contain a maximum of 255 characters.

Default Value

N/A

Table 7 update_routes

Parameter

Mandatory

Type

Description

destination

Yes

String

Definition

Specifies the subnet the route is destined for.

Constraints

N/A

Range

N/A

Default Value

N/A

nexthop

Yes

String

Definition

Specifies the next hop ID.

Constraints

N/A

Range

The value can contain a maximum of 255 characters.

Default Value

N/A

description

No

String

Definition

Describes the route.

Constraints

N/A

Range

The value can contain a maximum of 255 characters except angle brackets (< and >) and backquotes (`).

Default Value

N/A

Response Parameters

Status code: 200

Table 8 Response body parameters

Parameter

Type

Description

request_id

String

Definition

Specifies the request ID.

Range

The value can contain a maximum of 36 characters.

gdgw_routetable

Array of CommonRoutetable objects

Definition

Specifies the route tables of the global DC gateway.

Table 9 CommonRoutetable

Parameter

Type

Description

id

String

Definition

Specifies the route ID.

Range

The value can contain a maximum of 36 characters.

tenant_id

String

Definition

Specifies the tenant ID.

Range

N/A

gateway_id

String

Definition

Specifies the gateway ID.

Range

The value can contain a maximum of 36 characters.

destination

String

Definition

Specifies the subnet the route is destined for.

Range

N/A

nexthop

String

Definition

Specifies the next hop ID.

Range

The value can contain a maximum of 36 characters.

obtain_mode

String

Definition

Specifies the route type.

  • customized: default route

  • specific: custom route

  • bgp: dynamic route

Range

  • customized: default route

  • specific: custom route

  • bgp: dynamic route

status

String

Definition

Specifies the route status.

  • ACTIVE: The route has been delivered.

  • ERROR: Failed to deliver the route.

  • PENDING_CREATE: The route is to be delivered.

Range

  • ACTIVE: The route has been delivered.

  • ERROR: Failed to deliver the route.

  • PENDING_CREATE: The route is to be delivered.

address_family

String

Definition

Specifies the address family type.

  • ipv4: IPv4 addresses

  • ipv6: IPv6 addresses

Range

  • ipv4: IPv4 addresses

  • ipv6: IPv6 addresses

description

String

Definition

Describes the route.

Range

The value can contain a maximum of 1,024 characters.

type

String

Definition

Specifies the next hop type.

  • vif_peer: virtual interface peer

  • gdgw: global DC gateway

Range

  • vif_peer: virtual interface peer

  • gdgw: global DC gateway

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"
  } ]
}

SDK Sample Code

The SDK sample code is as follows.

Updating the route tables for a global DC gateway

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.dc.v3.region.DcRegion;
import com.huaweicloud.sdk.dc.v3.*;
import com.huaweicloud.sdk.dc.v3.model.*;

import java.util.List;
import java.util.ArrayList;

public class UpdateGdgwRouteTableSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        DcClient client = DcClient.newBuilder()
                .withCredential(auth)
                .withRegion(DcRegion.valueOf("<YOUR REGION>"))
                .build();
        UpdateGdgwRouteTableRequest request = new UpdateGdgwRouteTableRequest();
        request.withGdgwId("{gdgw_id}");
        UpdateGdgwRoutetableRequestBody body = new UpdateGdgwRoutetableRequestBody();
        List<AddGdgwRouteAction> listGdgwRoutetableAddRoutes = new ArrayList<>();
        listGdgwRoutetableAddRoutes.add(
            new AddRoutes()
                .withDestination("1.1.1.0/24")
                .withDescription("")
                .withType(AddRoutes.TypeEnum.fromValue("vif_peer"))
                .withNexthop("b9060822-06bf-4c48-995d-29a3fb04a3c3")
        );
        GdgwRouteTableRequest gdgwRoutetablebody = new GdgwRouteTableRequest();
        gdgwRoutetablebody.withAddRoutes(listGdgwRoutetableAddRoutes);
        body.withGdgwRoutetable(gdgwRoutetablebody);
        request.withBody(body);
        try {
            UpdateGdgwRouteTableResponse response = client.updateGdgwRouteTable(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

Updating the route tables for a global DC gateway

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkdc.v3.region.dc_region import DcRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkdc.v3 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = DcClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(DcRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = UpdateGdgwRouteTableRequest()
        request.gdgw_id = "{gdgw_id}"
        listAddRoutesGdgwRoutetable = [
            AddRoutes(
                destination="1.1.1.0/24",
                description="",
                type="vif_peer",
                nexthop="b9060822-06bf-4c48-995d-29a3fb04a3c3"
            )
        ]
        gdgwRoutetablebody = GdgwRouteTableRequest(
            add_routes=listAddRoutesGdgwRoutetable
        )
        request.body = UpdateGdgwRoutetableRequestBody(
            gdgw_routetable=gdgwRoutetablebody
        )
        response = client.update_gdgw_route_table(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Updating the route tables for a global DC gateway

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    dc "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dc/v3"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dc/v3/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dc/v3/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    projectId := "{project_id}"

    auth, err := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        SafeBuild()

    if err != nil {
        fmt.Println(err)
        return
    }

    hcClient, err := dc.DcClientBuilder().
         WithRegion(region.ValueOf("<YOUR REGION>")).
         WithCredential(auth).
         SafeBuild()


    if err != nil {
        fmt.Println(err)
        return
    }

    client := dc.NewDcClient(hcClient)

    request := &model.UpdateGdgwRouteTableRequest{}
	request.GdgwId = "{gdgw_id}"
	descriptionAddRoutes:= ""
	typeAddRoutes:= model.GetAddRoutesTypeEnum().VIF_PEER
	var listAddRoutesGdgwRoutetable = []model.AddRoutes{
        {
            Destination: "1.1.1.0/24",
            Description: &descriptionAddRoutes,
            Type: &typeAddRoutes,
            Nexthop: "b9060822-06bf-4c48-995d-29a3fb04a3c3",
        },
    }
	gdgwRoutetablebody := &model.GdgwRouteTableRequest{
		AddRoutes: &listAddRoutesGdgwRoutetable,
	}
	request.Body = &model.UpdateGdgwRoutetableRequestBody{
		GdgwRoutetable: gdgwRoutetablebody,
	}
	response, err := client.UpdateGdgwRouteTable(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

200

OK

Error Codes

See Error Codes.