Help Center/Direct Connect/API Reference/API/Global DC Gateway Route Tables/Querying Global DC Gateway Route Tables
Updated on 2025-10-27 GMT+08:00
View PDF

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.

URI

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

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

fields

No

Array of strings

Specifies the list of fields to be displayed.

Array Length: 1 - 5

ext_fields

No

Array of strings

show response ext-fields

Array Length: 0 - 5

nexthop

No

Array of strings

Specifies the next hop ID.

destination

No

Array of strings

Specifies the destination.

address_family

No

Array of strings

Specifies the address family.

Request Parameters

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

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

request_id

String

Specifies the request ID.

Minimum: 0

Maximum: 36

gdgw_routetables

Array of CommonRoutetable objects

Specifies the route table for the global DC gateway.

Array Length: 0 - 2000

total_count

Integer

Total number of records.

page_info

PageInfo object

Specifies the pagination query information.

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

Table 6 PageInfo

Parameter

Type

Description

previous_marker

String

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

Minimum: 0

Maximum: 36

current_count

Integer

Specifies the number of resources in the current list.

Minimum: 0

Maximum: 2000

next_marker

String

Specifies the marker of the next page. The value is the resource UUID. If the value is empty, the resource is on the last page.

Minimum: 0

Maximum: 36

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

OK

  • 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
  }
}

Status Codes

Status Code

Description

200

OK

Error Codes

See Error Codes.

Parent Topic: Global DC Gateway Route Tables