功能介绍
查询提交请求的租户有权限操作的所有路由器信息，单次查询最多返回2000条数据，超过2000后会返回分页标记。分页查询请参考分页查询。
调试
您可以在API Explorer中调试该接口。
URI
GET /v2.0/routers
样例：
GET https://{Endpoint}/v2.0/routers?id={id}&name={name}&admin_state_up={admin_state_up}&tenant_id={tenant_id}&status={status}
分页查询样例：
GET https://{Endpoint}/v2.0/routers?limit=2&marker=01ab4be1-4447-45fb-94be-3ee787ed4ebe&page_reverse=False
|
名称 |
是否必选 |
参数类型 |
说明 |
|---|---|---|---|
|
id |
否 |
String |
按照路由器的ID过滤查询 |
|
admin_state_up |
否 |
Boolean |
按照路由器的管理状态过滤查询 取值范围：true or false |
|
status |
否 |
String |
按照路由器的状态过滤查询 取值范围：ACTIVE， DOWN，ERROR |
|
tenant_id |
否 |
String |
按照路由器所属的项目ID过滤查询 |
|
marker |
否 |
String |
分页查询的起始资源ID，表示从指定资源的下一条记录开始查询。 marker需要和limit配合使用：
|
|
limit |
否 |
Integer |
分页查询每页返回的记录个数，取值范围为0~intmax（2^31-1），默认值2000。 limit需要和marker配合使用，详细规则请见marker的参数说明。 |
请求参数
无。
请求示例
GET https://{Endpoint}/v2.0/routers?limit=1
响应参数
|
参数名称 |
类型 |
说明 |
|---|---|---|
|
routers |
||
|
routers_links |
只有在使用limit过滤，并且资源个数超过limit或者资源个数超过2000时（limit默认值），该参数的rel和href取值才会显示为next和其对应的link。 |
|
属性 |
类型 |
说明 |
|---|---|---|
|
id |
String |
路由器的id 【使用说明】在查询路由器列表时非必选 |
|
name |
String |
路由器的名称。 仅支持数字、字母、_(下划线)、-（中划线）、.（点）。 |
|
admin_state_up |
Boolean |
管理状态。 只支持true。 |
|
status |
String |
状态，可以为ACTIVE， DOWN，ERROR。 |
|
tenant_id |
String |
项目ID |
|
external_gateway_info |
扩展属性：外部网关信息，参见external_gateway_info对象 |
|
|
routes |
||
|
project_id |
String |
项目ID，请参见获取项目ID。 |
|
created_at |
String |
资源创建时间，UTC时间 格式：yyyy-MM-ddTHH:mm:ss |
|
updated_at |
String |
资源更新时间，UTC时间 格式：yyyy-MM-ddTHH:mm:ss |
响应示例
{
"routers": [
{
"id": "01ab4be1-4447-45fb-94be-3ee787ed4ebe",
"name": "xiaoleizi-tag",
"status": "ACTIVE",
"tenant_id": "bbfe8c41dd034a07bebd592bf03b4b0c",
"project_id": "bbfe8c41dd034a07bebd592bf03b4b0c",
"admin_state_up": true,
"external_gateway_info": {
"network_id": "0a2228f2-7f8a-45f1-8e09-9039e1d09975",
"enable_snat": false
},
"routes": [
{
"destination": "0.0.0.0/0",
"nexthop": "172.16.0.124"
}
],
"created_at": "2018-03-23T09:26:08",
"updated_at": "2018-08-24T08:49:53"
}
],
"routers_links": [
{
"rel": "next",
"href": "https://{Endpoint}/v2.0/routers?limit=1&marker=01ab4be1-4447-45fb-94be-3ee787ed4ebe"
},
{ "rel": "previous",
"href": "https://{Endpoint}/v2.0/routers?limit=1&marker=01ab4be1-4447-45fb-94be-3ee787ed4ebe&page_reverse=True"
}
]
}
状态码
请参见状态码。
错误码
请参见错误码。
