文档首页> 企业路由器 ER> API参考> API> 路由> 查询有效路由列表
更新时间:2024-04-19 GMT+08:00

查询有效路由列表

功能介绍

查询有效的路由列表,支持分页查询能力。有效路由为优选后的路由。

调用方法

请参见如何调用API

URI

GET /v3/{project_id}/enterprise-router/route-tables/{route_table_id}/routes

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID

route_table_id

String

路由表ID

表2 Query参数

参数

是否必选

参数类型

描述

limit

Integer

每页返回的个数。 取值范围:0~2000。

最小值:0

最大值:2000

marker

String

上一页最后一条记录的路由id,为空时为查询第一页。 使用说明:必须与limit一起使用。

最小长度:1

最大长度:128

destination

Array

路由目的地址

resource_type

Array

  • vpc:虚拟私有云

  • vpn:vpn网关

  • vgw:云专线的虚拟网关

  • peering:对等连接,通过云连接CC加载不同区域的企业路由器来创建“对等连接(Peering)”连接

  • ecn:企业连接网

  • cfw:云防火墙

请求参数

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

routes

Array of EffectiveRoute objects

路由列表

request_id

String

请求ID

page_info

PageInfo object

分页查询的信息

表4 EffectiveRoute

参数

参数类型

描述

route_id

String

路由ID

destination

String

路由目的地

next_hops

Array of RouteAttachment objects

路由下一跳列表

is_blackhole

Boolean

是否黑洞路由

route_type

String

路由类型:static,propagation

表5 RouteAttachment

参数

参数类型

描述

resource_id

String

连接关联的资源ID

resource_type

String

连接关联的资源类型:

  • vpc:虚拟私有云

  • vpn:vpn网关

  • vgw:云专线的虚拟网关

  • peering:对等连接,通过云连接CC加载不同区域的企业路由器来创建“对等连接(Peering)”连接

  • cfw:云防火墙

  • ecn:企业连接网

attachment_id

String

连接ID

表6 PageInfo

参数

参数类型

描述

next_marker

String

下一个marker标识,为空时表示最后一页

current_count

Integer

当前列表中资源数量

请求示例

查询有效路由列表

GET https://{erouter_endpoint}/v3/08d5a9564a704afda6039ae2babbef3c/enterprise-router/route-tables/915a14a6-867b-4af7-83d1-70efceb146f9/routes

响应示例

状态码: 200

OK

{
  "routes" : [ {
    "route_id" : "9b3b38a9-1c9d-4f01-9429-81af6b545289",
    "destination" : "192.168.0.0/16",
    "next_hops" : [ {
      "resource_id" : "9c4ab06a-0ab4-4fad-93a8-f733f3a4433d",
      "resource_type" : "vpc",
      "attachment_id" : "9b3b38a9-1c9d-4f01-9429-81af6b545289"
    } ],
    "is_blackhole" : false,
    "route_type" : "static"
  } ],
  "page_info" : {
    "next_marker" : "1",
    "current_count" : 1
  },
  "request_id" : "915a14a6-867b-4af7-83d1-70efceb146f9"
}

SDK代码示例

SDK代码示例如下。

Java

 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
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.er.v3.region.ErRegion;
import com.huaweicloud.sdk.er.v3.*;
import com.huaweicloud.sdk.er.v3.model.*;

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

public class ListEffectiveRoutesSolution {

    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");

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

        ErClient client = ErClient.newBuilder()
                .withCredential(auth)
                .withRegion(ErRegion.valueOf("<YOUR REGION>"))
                .build();
        ListEffectiveRoutesRequest request = new ListEffectiveRoutesRequest();
        request.withLimit(<limit>);
        request.withMarker("<marker>");
        request.withDestination();
        request.withResourceType();
        try {
            ListEffectiveRoutesResponse response = client.listEffectiveRoutes(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());
        }
    }
}

Python

 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
# coding: utf-8

from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdker.v3.region.er_region import ErRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdker.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 = __import__('os').getenv("CLOUD_SDK_AK")
    sk = __import__('os').getenv("CLOUD_SDK_SK")

    credentials = BasicCredentials(ak, sk) \

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

    try:
        request = ListEffectiveRoutesRequest()
        request.limit = <limit>
        request.marker = "<marker>"
        request.destination = 
        request.resource_type = 
        response = client.list_effective_routes(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Go

 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
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    er "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/er/v3"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/er/v3/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/er/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")

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := er.NewErClient(
        er.ErClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ListEffectiveRoutesRequest{}
	limitRequest:= int32(<limit>)
	request.Limit = &limitRequest
	markerRequest:= "<marker>"
	request.Marker = &markerRequest
	response, err := client.ListEffectiveRoutes(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多

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

状态码

状态码

描述

200

OK

错误码

请参见错误码