文档首页/ 云专线 DC/ API参考/ API/ 全域接入网关路由表/ 查询全域接入网关路由表
更新时间:2024-12-27 GMT+08:00

查询全域接入网关路由表

功能介绍

查询全域接入网关路由表

调用方法

请参见如何调用API

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

租户项目ID

最小长度:0

最大长度:36

gdgw_id

String

全域接入网关ID

表2 Query参数

参数

是否必选

参数类型

描述

fields

Array of strings

显示字段列表

数组长度:1 - 5

ext_fields

Array of strings

show response ext-fields

数组长度:0 - 5

nexthop

Array of strings

下一条ID

destination

Array of strings

目的地址

address_family

Array of strings

地址簇

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。 获取Token,请参考《统一身份认证服务API参考》的“获取用户Token”章节。请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

最小长度:0

最大长度:10240

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

request_id

String

请求id

最小长度:0

最大长度:36

gdgw_routetable

Array of CommonRoutetable objects

全域接入网关路由表

数组长度:0 - 2000

表5 CommonRoutetable

参数

参数类型

描述

id

String

路由id

最小长度:36

最大长度:36

tenant_id

String

租户id

最小长度:64

最大长度:64

gateway_id

String

网关id

最小长度:36

最大长度:36

destination

String

路由子网

最小长度:64

最大长度:64

nexthop

String

下一跳id

最小长度:36

最大长度:36

obtain_mode

String

路由类型:

  • customized: 默认路由

  • specific: 自定义路由

  • bgp: 动态路由

status

String

路由状态:

  • ACTIVE: 下发正常

  • ERROR: 下发失败

  • PENDING_CREATE: 待下发

address_family

String

地址族类型:

  • ipv4: ipv4

  • ipv6: ipv6

description

String

路由描述

最小长度:0

最大长度:1024

type

String

下一跳类型:

  • vif_peer: 虚拟接口对等体

  • gdgw: 全域接入网关

最小长度:0

最大长度:255

请求示例

查询全域接入网关路由表

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

响应示例

状态码: 200

OK

  • 查询全域接入网关路由表响应体

    {
      "request_id" : "409ed40b-7ccf-4514-8ca8-af2b994e4023",
      "gdgw_routetable" : [ {
        "id" : "14d55a22-9d08-46af-bc2e-f965f9558234",
        "description" : "v4子网路由",
        "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"
      } ]
    }

SDK代码示例

SDK代码示例如下。

 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
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 := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := dc.NewDcClient(
        dc.DcClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ListGdgwRouteTablesRequest{}
	request.GdgwId = "{gdgw_id}"
	response, err := client.ListGdgwRouteTables(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

OK

错误码

请参见错误码