功能介绍
查询 企业路由器 列表
接口约束
-
分页查询使用的参数为marker、limit。marker和limit一起使用时才会生效，单独使用无效。
-
支持单字段排序，排序字段有[id,name,description,created_at,updated_at]，不支持多字段排序。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
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 |
企业路由器实例状态 |
|
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 |
企业路由器列表 |
|
|
page_info |
分页查询的信息 |
|
|
request_id |
String |
请求ID |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
企业路由器实例的ID |
|
name |
String |
企业路由器实例名称 |
|
description |
String |
企业路由器实例描述信息 |
|
state |
String |
运行状态 |
|
tags |
标签信息 |
|
|
charge_mode |
String |
计费模式 按需 缺省值：postPaid |
|
created_at |
String |
创建时间 |
|
updated_at |
String |
更新时间 |
|
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不开启 |
请求示例
-
分页查询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
}
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK |
错误码
请参见错误码。
