查询转发策略
功能介绍
查询转发策略。支持过滤查询和分页查询。如未特殊说明，匹配规则为精确匹配。
接口约束
分页查询使用的参数为marker、limit、page_reverse。marker和page_reverse只有和limit一起使用时才会生效，单独使用无效。
URI
GET /v2.0/lbaas/l7policies
请求消息
|
参数 |
是否必选 |
参数类型 |
描述 |
|
|---|---|---|---|---|
|
marker |
否 |
String |
分页查询的起始的资源ID，表示上一页最后一条查询记录的转发策略的ID。 必须与limit一起使用。 |
|
|
limit |
否 |
Integer |
分页查询每页的转发策略个数。如果不设置，则默认不分页查询所有。 |
|
|
page_reverse |
否 |
Boolean |
分页的顺序，true表示从后往前分页，false表示从前往后分页，默认为false。 必须与limit一起使用。 |
|
|
id |
否 |
String |
转发策略ID。 |
|
|
tenant_id |
否 |
String |
转发策略所在的项目ID。 支持的最大字符长度：255 获取方法详见获取项目ID。 |
|
|
project_id |
否 |
String |
此参数和tenant_id参数含义一样，均指转发策略所在的项目ID。 获取方法详见获取项目ID。 |
|
|
name |
否 |
String |
转发策略名称。 支持的最大字符长度：255 |
|
|
admin_state_up |
否 |
Boolean |
转发策略的管理状态； 该字段为预留字段，暂未启用。默认为true。 |
|
|
description |
否 |
String |
转发策略的描述信息。 支持的最大字符长度：255 |
|
|
listener_id |
否 |
String |
转发策略所在的监听器ID。 |
|
|
action |
否 |
String |
转发策略的匹配动作。 取值范围：
|
|
|
redirect_pool_id |
否 |
String |
流量匹配后转发到后端云服务器组的ID。 |
|
|
redirect_listener_id |
否 |
String |
流量匹配后转发到的监听器的ID。 |
|
|
redirect_url |
否 |
String |
转发策略重定向到的url。 该字段为预留字段，暂未启用。 支持的最大字符长度：255 |
|
|
position |
否 |
Integer |
转发优先级，从1递增，最高100。默认值：100； 该字段为预留字段，暂未启用。 |
|
|
provisioning_status |
否 |
String |
该字段为预留字段，暂未启用。 转发策略的配置状态，可以为ACTIVE。 |
|
|
display_all_rules |
否 |
Boolean |
是否显示所有的rule信息。 取值范围： false表示不显示（跟以前一样只显示ID）； true表示显示。 |
|
响应消息
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
l7policies |
Array |
转发策略对象列表。详见表3。 |
|
l7policies_links |
Array |
转发策略的分页查询中上下页的链接信息。 仅当分页查询时响应体中有该字段。 详见表5。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
转发策略ID。 |
|
tenant_id |
String |
转发策略所在的项目ID。 |
|
project_id |
String |
此参数和tenant_id参数含义一样，均指转发策略所在的项目ID。 |
|
name |
String |
转发策略名称。 |
|
admin_state_up |
Boolean |
转发策略的管理状态； 该字段为预留字段，暂未启用。取值范围：true/false。
|
|
description |
String |
转发策略的描述信息。 |
|
listener_id |
String |
转发策略所在的监听器ID。 |
|
action |
String |
转发策略的匹配动作。 取值范围：
|
|
redirect_pool_id |
String |
流量匹配后转发到后端云服务器组的ID。 |
|
redirect_listener_id |
String |
流量匹配后转发到的监听器的ID。 |
|
redirect_url |
String |
转发策略重定向到的url。 该字段为预留字段，暂未启用。 |
|
rules |
Array |
转发策略关联的转发规则的ID列表。详见表6 |
|
position |
Integer |
转发优先级，从1递增，最高100。默认值：100； 该字段为预留字段，暂未启用。 |
|
provisioning_status |
String |
该字段为预留字段，暂未启用。 转发策略的配置状态，可以为ACTIVE。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
转发策略关联的转发规则ID |
请求示例
- 请求样例1 全量查询转发策略
GET https://{Endpoint}/v2.0/lbaas/l7policies - 请求样例2 过滤查询转发类型为REDIRECT_TO_POOL的转发策略
GET https://{Endpoint}/v2.0/lbaas/l7policies?action=REDIRECT_TO_POOL
响应示例
- 响应样例1
{ "l7policies": [ { "redirect_pool_id": "431a03eb-81bb-408e-ae37-7ce19023692b", "redirect_listener_id": null, "description": "", "admin_state_up": true, "rules": [ { "id": "67d8a8fa-b0dd-4bd4-a85b-671db19b2ef3" }, { "id": "f02b3bca-69d2-4335-a3fa-a8054e996213" } ], "tenant_id": "a31d2bdcf7604c0faaddb058e1e08819", "project_id": "a31d2bdcf7604c0faaddb058e1e08819", "listener_id": "26058b64-6185-4e06-874e-4bd68b7633d0", "redirect_url": null, "action": "REDIRECT_TO_POOL", "position": 2, "provisioning_status": "ACTIVE", "id": "5ae0e1e7-5f0f-47a1-b39f-5d4c428a1586", "name": "" }, { "redirect_pool_id": "59eebd7b-c68f-4f8a-aa7f-e062e84c0690", "redirect_listener_id": null, "description": "", "admin_state_up": true, "rules": [ { "id": "f4499f48-de3d-4efe-926d-926aa4d6aaf5" } ], "tenant_id": "a31d2bdcf7604c0faaddb058e1e08819", "project_id": "a31d2bdcf7604c0faaddb058e1e08819", "listener_id": "e1310063-00de-4867-ab55-ccac4d9db364", "redirect_url": null, "action": "REDIRECT_TO_POOL", "position": 1, "provisioning_status": "ACTIVE", "id": "6cfd9d89-1d7e-4d84-ae1f-a8c5ff126f72", "name": "" } ], "l7policies_links": [ { "href": "https://{Endpoint}/v2.0/lbaas/l7policies/061f461c-c7cf-47ab-9583-09be5076cd09/rules?marker=167c1a31-bc12-4c3d-9ad1-c9bf450df4ce&page_reverse=True", "rel": "previous" } ] } - 响应样例2
{ "l7policies": [ { "redirect_pool_id": "431a03eb-81bb-408e-ae37-7ce19023692b", "redirect_listener_id": null, "description": "", "admin_state_up": true, "rules": [ { "id": "67d8a8fa-b0dd-4bd4-a85b-671db19b2ef3" }, { "id": "f02b3bca-69d2-4335-a3fa-a8054e996213" } ], "tenant_id": "a31d2bdcf7604c0faaddb058e1e08819", "project_id": "a31d2bdcf7604c0faaddb058e1e08819", "listener_id": "26058b64-6185-4e06-874e-4bd68b7633d0", "redirect_url": null, "action": "REDIRECT_TO_POOL", "position": 2, "provisioning_status": "ACTIVE", "id": "5ae0e1e7-5f0f-47a1-b39f-5d4c428a1586", "name": "" }, { "redirect_pool_id": "59eebd7b-c68f-4f8a-aa7f-e062e84c0690", "redirect_listener_id": null, "description": "", "admin_state_up": true, "rules": [ { "id": "f4499f48-de3d-4efe-926d-926aa4d6aaf5" } ], "tenant_id": "a31d2bdcf7604c0faaddb058e1e08819", "project_id": "a31d2bdcf7604c0faaddb058e1e08819", "listener_id": "e1310063-00de-4867-ab55-ccac4d9db364", "redirect_url": null, "action": "REDIRECT_TO_POOL", "position": 1, "provisioning_status": "ACTIVE", "id": "6cfd9d89-1d7e-4d84-ae1f-a8c5ff126f72", "name": "" } ], "l7policies_links": [ { "href": "https://{Endpoint}/v2.0/lbaas/l7policies/061f461c-c7cf-47ab-9583-09be5076cd09/rules?marker=167c1a31-bc12-4c3d-9ad1-c9bf450df4ce&page_reverse=True", "rel": "previous" } ] }
返回码
请参见状态码。
