查询企业路由器列表
功能介绍
查询企业路由器列表
接口约束
-
分页查询使用的参数为marker、limit。marker和limit一起使用时才会生效,单独使用无效。
-
支持单字段排序,排序字段有[id,name,description,created_at,updated_at],不支持多字段排序。
调用方法
请参见如何调用API。
URI
GET /v3/{project_id}/enterprise-router/instances
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
limit |
否 |
Integer |
每页返回的个数。 取值范围:0~2000。 最小值:0 最大值:2000 |
marker |
否 |
String |
查询的页码id,为空时为查询第一页。 使用说明:必须与limit一起使用。 最小长度:1 最大长度:128 |
enterprise_project_id |
否 |
Array |
企业项目ID |
state |
否 |
Array |
资源状态:pending|available|modifying|deleting|deleted|failed|freezed |
id |
否 |
Array |
根据资源ID查询,可同时查询多个。 |
resource_id |
否 |
Array |
连接对应的资源ID列表 |
owned_by_self |
否 |
Boolean |
过滤资源是否属于当前租户;取值为true时,只查属于当前租户的资源,不包括共享资源;为false时,查询当前租户及共享给该租户的资源; |
sort_key |
否 |
Array |
按关键字排序,默认按照id排序,可选值:id|name|state |
sort_dir |
否 |
Array |
返回结果按照升序或降序排列,默认为asc,降序为desc |
请求参数
无
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
instances |
Array of EnterpriseRouter objects |
企业路由器列表 |
page_info |
PageInfo object |
分页查询的信息 |
request_id |
String |
请求ID |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
企业路由器实例的ID |
name |
String |
企业路由器实例名称 |
description |
String |
企业路由器实例描述信息 |
state |
String |
运行状态:pending|available|modifying|deleting|deleted|failed |
tags |
Array of Tag objects |
标签信息 |
charge_mode |
String |
计费模式 按需 缺省值:postPaid |
created_at |
String |
创建时间,格式:YYYY-MM-DDTHH:mm:ss.sssZ |
updated_at |
String |
更新时间,格式:YYYY-MM-DDTHH:mm:ss.sssZ |
enterprise_project_id |
String |
企业项目ID |
project_id |
String |
项目ID |
asn |
Long |
企业路由器实例的BGP AS号 |
enable_default_propagation |
Boolean |
是否开启默认路由表传播,默认false不开启 |
enable_default_association |
Boolean |
是否开启默认路由表关联,默认false不开启 |
default_propagation_route_table_id |
String |
默认传播路由表id |
default_association_route_table_id |
String |
默认关联路由表id |
availability_zone_ids |
Array of strings |
企业路由器所在可用区信息 |
auto_accept_shared_attachments |
Boolean |
是否自动接受共享连接创建,默认false不开启 |
参数 |
参数类型 |
描述 |
---|---|---|
key |
String |
标签键,规则:
最小长度:1 最大长度:128 |
value |
String |
标签值,规则:
最小长度:0 最大长度:255 |
请求示例
-
分页查询2两条记录
GET https://{erouter_endpoint}/v3/08d5a9564a704afda6039ae2babbef3c/enterprise-router/instances?limit=2&marker=1
-
全量查询
GET https://{erouter_endpoint}/v3/08d5a9564a704afda6039ae2babbef3c/enterprise-router/instances
响应示例
状态码: 200
OK
{ "instances" : [ { "id" : "94c2b814-99dc-939a-e811-ae84c61ea3ff", "name" : "my_er", "description" : "this is my first enterprise router", "asn" : 64512, "project_id" : "08d5a9564a704afda6039ae2babbef3c", "enable_default_association" : true, "enable_default_propagation" : true, "default_association_route_table_id" : "7f7f738f-453c-40b1-be26-28e7b9e390c1", "default_propagation_route_table_id" : "7f7f738f-453c-40b1-be26-28e7b9e390c1", "auto_accept_shared_attachments" : false, "created_at" : "2019-09-06 02:11:13Z", "updated_at" : "2019-09-06 02:11:13Z", "tags" : [ { "key" : "key", "value" : "value" } ], "enterprise_project_id" : 0, "availability_zone_ids" : [ "az1", "az2" ] } ], "request_id" : "915a14a6-867b-4af7-83d1-70efceb146f9", "page_info" : { "next_marker" : "2", "current_count" : 1 } }
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 49 50 51 52 53 54 55 56 |
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 ListEnterpriseRoutersSolution { 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(); ListEnterpriseRoutersRequest request = new ListEnterpriseRoutersRequest(); request.withLimit(<limit>); request.withMarker("<marker>"); request.withEnterpriseProjectId(); request.withState(); request.withId(); request.withResourceId(); request.withOwnedBySelf(<owned_by_self>); request.withSortKey(); request.withSortDir(); try { ListEnterpriseRoutersResponse response = client.listEnterpriseRouters(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 33 34 35 36 37 38 |
# 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 = ListEnterpriseRoutersRequest() request.limit = <limit> request.marker = "<marker>" request.enterprise_project_id = request.state = request.id = request.resource_id = request.owned_by_self = <OwnedBySelf> request.sort_key = request.sort_dir = response = client.list_enterprise_routers(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 39 40 41 |
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.ListEnterpriseRoutersRequest{} limitRequest:= int32(<limit>) request.Limit = &limitRequest markerRequest:= "<marker>" request.Marker = &markerRequest ownedBySelfRequest:= <owned_by_self> request.OwnedBySelf = &ownedBySelfRequest response, err := client.ListEnterpriseRouters(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
OK |
错误码
请参见错误码。