查询路由表列表
功能介绍
查询路由表列表。
接口约束
-
支持分页查询, 支持过滤查询:state, is_default_propagation_route_table, is_default_association_route_table。
-
支持单字段排序,排序字段有[id,name,description,created_at,updated_at],不支持多字段排序。
调用方法
请参见如何调用API。
URI
GET /v3/{project_id}/enterprise-router/{er_id}/route-tables
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID |
er_id |
是 |
String |
企业路由器实例ID |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
limit |
否 |
Integer |
每页返回的个数。 取值范围:0~2000。 最小值:0 最大值:2000 |
marker |
否 |
String |
查询的页码id,为空时为查询第一页。 使用说明:必须与limit一起使用。 最小长度:1 最大长度:128 |
state |
否 |
Array |
状态 |
is_default_propagation_table |
否 |
Boolean |
是否为默认传播路由表 |
is_default_association_table |
否 |
Boolean |
是否为默认关联路由表 |
sort_key |
否 |
Array |
按关键字排序,默认按照id排序,可选值:id|name|state |
sort_dir |
否 |
Array |
返回结果按照升序或降序排列,默认为asc,降序为desc |
请求参数
无
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
route_tables |
Array of RouteTable objects |
路由表列表 |
request_id |
String |
请求ID |
page_info |
PageInfo object |
分页查询的信息 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
路由表的id |
name |
String |
路由表名字 |
description |
String |
描述信息 |
is_default_association |
Boolean |
是否为默认关联的路由表 缺省值:false |
is_default_propagation |
Boolean |
是否为默认传递路由表 |
state |
String |
路由表状态,支持的状态有pending | available | deleting | deleted | failed |
tags |
Array of Tag objects |
标签 |
created_at |
String |
创建时间,格式:YYYY-MM-DDTHH:mm:ss.sssZ |
updated_at |
String |
更新时间,格式:YYYY-MM-DDTHH:mm:ss.sssZ |
参数 |
参数类型 |
描述 |
---|---|---|
key |
String |
标签键,规则:
最小长度:1 最大长度:128 |
value |
String |
标签值,规则:
最小长度:0 最大长度:255 |
请求示例
GET https://{erouter_endpoint}/v3/08d5a9564a704afda6039ae2babbef3c/enterprise-router/915a14a6-867b-4af7-83d1-70efceb146f5/route-tables
响应示例
状态码: 200
OK
{ "route_tables" : [ { "id" : "4ab54142-7c92-48ad-8288-77727a231052", "is_default_association" : false, "is_default_propagation" : false, "name" : "my-router-table1", "description" : "rtb-for-a", "state" : "available", "tags" : [ { "key" : "key", "value" : "value" } ] }, { "id" : "4ab54142-7c92-48ad-8288-77727a231053", "is_default_association" : false, "is_default_propagation" : false, "name" : "my-router-table2", "description" : "rtb-for-b", "state" : "available", "tags" : [ { "key" : "key", "value" : "value" } ] } ], "page_info" : { "next_marker" : "1", "current_count" : 2 }, "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 52 53 54 |
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 ListRouteTablesSolution { 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(); ListRouteTablesRequest request = new ListRouteTablesRequest(); request.withState(); request.withIsDefaultPropagationTable(<is_default_propagation_table>); request.withIsDefaultAssociationTable(<is_default_association_table>); request.withLimit(<limit>); request.withMarker("<marker>"); request.withSortKey(); request.withSortDir(); try { ListRouteTablesResponse response = client.listRouteTables(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 34 35 36 |
# 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 = ListRouteTablesRequest() request.state = request.is_default_propagation_table = <IsDefaultPropagationTable> request.is_default_association_table = <IsDefaultAssociationTable> request.limit = <limit> request.marker = "<marker>" request.sort_key = request.sort_dir = response = client.list_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) |
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 40 41 42 43 |
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.ListRouteTablesRequest{} isDefaultPropagationTableRequest:= <is_default_propagation_table> request.IsDefaultPropagationTable = &isDefaultPropagationTableRequest isDefaultAssociationTableRequest:= <is_default_association_table> request.IsDefaultAssociationTable = &isDefaultAssociationTableRequest limitRequest:= int32(<limit>) request.Limit = &limitRequest markerRequest:= "<marker>" request.Marker = &markerRequest response, err := client.ListRouteTables(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
OK |
错误码
请参见错误码。