Help Center/ Enterprise Router/ API Reference/ APIs/ Routes/ Querying Effective Routes
Updated on 2024-04-19 GMT+08:00

Querying Effective Routes

Function

This API is used to query effective routes. Pagination query is supported. Effective routes are preferred routes.

Calling Method

For details, see Calling APIs.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID

route_table_id

Yes

String

Route table ID

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

limit

No

Integer

Number of records on each page. Value range: 0 to 2000

Minimum: 0

Maximum: 2000

marker

No

String

ID of the last route on the previous page. If this parameter is left blank, the first page is queried. This parameter must be used together with limit.

Minimum: 1

Maximum: 128

destination

No

Array

Destination address of the route

resource_type

No

Array

Attachment type.

  • vpc: VPC attachment

  • vpn: VPN gateway attachment

  • vgw: virtual gateway attachment

  • peering: peering connection attachment. A cloud connection is used to connect two enterprise routers from different regions.

  • ecn: ECN attachment

  • cfw: CFW instance attachment

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

routes

Array of EffectiveRoute objects

Routes

request_id

String

Request ID

page_info

PageInfo object

Pagination query information

Table 4 EffectiveRoute

Parameter

Type

Description

route_id

String

Route ID

destination

String

Destination address of the route

next_hops

Array of RouteAttachment objects

Next hops of the routes

is_blackhole

Boolean

Whether the route is a blackhole route

route_type

String

Route type. Value options: static and propagation

Table 5 RouteAttachment

Parameter

Type

Description

resource_id

String

Attached resource ID

resource_type

String

Attachment type.

  • vpc: VPC attachment

  • vpn: VPN gateway attachment

  • vgw: virtual gateway attachment

  • peering: peering connection attachment. A cloud connection is used to connect two enterprise routers from different regions.

  • cfw: CFW instance attachment

  • ecn: ECN attachment

attachment_id

String

Attachment ID

Table 6 PageInfo

Parameter

Type

Description

next_marker

String

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

current_count

Integer

Number of resources in the list

Example Requests

Querying effective routes

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

Example Responses

Status code: 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 Sample Code

The SDK sample code is as follows.

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

More

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.