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

Querying Global DC Gateway Route Tables

Function

This API is used to query 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:listGdgwRouteTable

    List

    gdgw *

    • g:EnterpriseProjectId

    • g:ResourceTag/<tag-key>

    -

    -

URI

GET /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

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

fields

No

Array of strings

Definition

Specifies the list of fields to be displayed.

Constraints

The array length ranges from 1 to 5.

ext_fields

No

Array of strings

Definition

Specifies the extension fields.

Constraints

The array length ranges from 0 to 5.

limit

No

Integer

Definition

Specifies the number of records returned on each page.

Constraints

N/A

Range

1 to 2000

Default Value

2000

marker

No

String

Definition

Specifies the ID of the last resource record on the previous page. If this parameter is left blank, the first page is queried.

Constraints

This parameter must be used together with limit.

Range

The value can contain a maximum of 36 characters.

Default Value

N/A

nexthop

No

Array of strings

Definition

Specifies the next hop ID.

Constraints

N/A

destination

No

Array of strings

Definition

Specifies the destination.

Constraints

N/A

address_family

No

Array of strings

Definition

Specifies the address family.

Constraints

N/A

Request Parameters

Table 3 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

Response Parameters

Status code: 200

Table 4 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_routetables

Array of CommonRoutetable objects

Definition

Specifies the route tables of the global DC gateway.

total_count

Integer

Definition

Specifies the total number of records.

Range

N/A

page_info

PageInfo object

Definition

Specifies the pagination query information.

Table 5 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

Table 6 PageInfo

Parameter

Type

Description

previous_marker

String

Definition

Specifies the marker of the previous page. The value is the resource UUID.

Range

The value can contain a maximum of 36 characters.

current_count

Integer

Definition

Specifies the number of resources in the current list.

Range

0 to 2000

next_marker

String

Definition

Specifies the marker of the next page. The value is the resource UUID. This parameter does not exist if the page is the last one.

Range

The value can contain a maximum of 36 characters.

Example Requests

Querying the route tables for a global DC gateway

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

Example Responses

Status code: 200

Response body for querying global DC gateway route tables

{
  "request_id" : "409ed40b-7ccf-4514-8ca8-af2b994e4023",
  "gdgw_routetables" : [ {
    "id" : "14d55a22-9d08-46af-bc2e-f965f9558234",
    "description" : "Specifies the IPv4 subnet route.",
    "tenant_id" : "00000000000000000000000000000000",
    "gateway_id" : "5791e3c8-b43d-4751-bfeb-a643e40e6086",
    "destination" : "x.x.0.0/16",
    "nexthop" : "409ed40b-7ccf-4514-8ca8-af2b994e4023",
    "type" : "vif_peer",
    "obtain_mode" : "customized",
    "status" : "ACTIVE",
    "address_family" : "ipv4"
  } ],
  "total_count" : 1,
  "page_info" : {
    "previous_marker" : "54bf7a78-1a7d-4d42-ac07-abb2f903f2c1",
    "current_count" : 1
  }
}

SDK Sample Code

The SDK sample code is as follows.

 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
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.*;


public class ListGdgwRouteTablesSolution {

    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();
        ListGdgwRouteTablesRequest request = new ListGdgwRouteTablesRequest();
        request.withGdgwId("{gdgw_id}");
        try {
            ListGdgwRouteTablesResponse response = client.listGdgwRouteTables(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());
        }
    }
}
 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
# 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 = ListGdgwRouteTablesRequest()
        request.gdgw_id = "{gdgw_id}"
        response = client.list_gdgw_route_tables(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)
 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
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.ListGdgwRouteTablesRequest{}
	request.GdgwId = "{gdgw_id}"
	response, err := client.ListGdgwRouteTables(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.