查询转发策略列表
功能介绍
查询七层转发策略列表。
接口约束
-
分页查询使用的参数为marker、limit、page_reverse。
-
marker和page_reverse只有和limit一起使用时才会生效,单独使用无效。
调用方法
请参见如何调用API。
URI
GET /v3/{project_id}/elb/l7policies
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释:项目ID。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
marker |
否 |
String |
参数解释:上一页最后一条记录的ID。 约束限制:
|
limit |
否 |
Integer |
参数解释:每页返回的个数。 取值范围:0-2000 默认取值:2000 |
page_reverse |
否 |
Boolean |
参数解释:是否反向查询。 约束限制:
取值范围:
默认取值:false |
enterprise_project_id |
否 |
Array of strings |
参数解释:所属的企业项目ID。 如果enterprise_project_id不传值,默认查询所有企业项目下的资源,鉴权按照细粒度权限鉴权,必须在用户组下分配elb:l7policies:list权限。 如果enterprise_project_id传值,鉴权按照企业项目权限鉴权,分为传入具体eps_id和all_granted_eps两种场景,前者查询指定eps_id的eps下的资源,后者查询的是所有有list权限的eps下的资源。 支持多值查询,查询条件格式: enterprise_project_id=xxx&enterprise_project_id=xxx。 |
id |
否 |
Array of strings |
参数解释:转发策略ID。 支持多值查询,查询条件格式:id=xxx&id=xxx。 |
name |
否 |
Array of strings |
参数解释:转发策略名称。 支持多值查询,查询条件格式:name=xxx&name=xxx。 |
description |
否 |
Array of strings |
参数解释:转发策略额描述信息。 支持多值查询,查询条件格式:description=xxx&description=xxx。 |
admin_state_up |
否 |
Boolean |
参数解释:转发策略的管理状态。 |
listener_id |
否 |
Array of strings |
参数解释:转发策略所属的监听器ID。 支持多值查询,查询条件格式:listener_id=xxx&listener_id=xxx。 |
position |
否 |
Array of integers |
参数解释:转发策略的优先级。 支持多值查询,查询条件格式:position=xxx&position=xxx。 不支持该字段,请勿使用。 |
action |
否 |
Array of strings |
参数解释:转发策略的转发动作。 取值范围:
支持多值查询,查询条件格式:action=xxx&action=xxx。 |
redirect_url |
否 |
Array of strings |
参数解释:转发到的url。 支持多值查询,查询条件格式:redirect_url=xxx&redirect_url=xxx。 不支持该字段,请勿使用。 |
redirect_pool_id |
否 |
Array of strings |
参数解释:转发到pool的ID。 支持多值查询,查询条件格式:redirect_pool_id=xxx&redirect_pool_id=xxx。 |
redirect_listener_id |
否 |
Array of strings |
参数解释:转发到的listener的ID。 支持多值查询,查询条件格式:redirect_listener_id=xxx&redirect_listener_id=xxx。 |
provisioning_status |
否 |
Array of strings |
参数解释:转发策略的配置状态。 取值范围:
支持多值查询,查询条件格式:provisioning_status=xxx&provisioning_status=xxx。 |
display_all_rules |
否 |
Boolean |
参数解释:是否显示转发策略下的rule详细信息。 取值范围:
|
priority |
否 |
Array of integers |
参数解释:转发策略的优先级。数值越小,优先级越高。 支持多值查询,查询条件格式:priority=xxx&priority=xxx。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释:IAM鉴权Token |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
request_id |
String |
参数解释:请求ID。 注:自动生成 。 |
page_info |
PageInfo object |
参数解释:分页信息。 |
l7policies |
Array of L7Policy objects |
参数解释:转发策略对象列表。 |
参数 |
参数类型 |
描述 |
---|---|---|
previous_marker |
String |
参数解释:分页查询结果中第一条记录的ID。通常用于配合page_reverse=true查询上一页。 |
next_marker |
String |
参数解释:分页查询结果中最后一条记录的ID。通常用于查询下一页。 |
current_count |
Integer |
参数解释:当前的记录数。 |
参数 |
参数类型 |
描述 |
---|---|---|
action |
String |
参数解释:转发策略的转发动作。 约束限制:
取值范围:
|
admin_state_up |
Boolean |
参数解释:转发策略的管理状态。 约束限制:只支持设置为true。 |
description |
String |
参数解释:转发策略描述信息。 |
id |
String |
参数解释:转发策略ID。 |
listener_id |
String |
参数解释:转发策略所属的监听器ID。 |
name |
String |
参数解释:转发策略名称 |
position |
Integer |
参数解释:转发策略的优先级,不支持更新。 不支持该字段,请勿使用。 |
priority |
Integer |
参数解释:转发策略的优先级。数字越小表示优先级越高。 约束限制:
取值范围:
默认取值:
|
project_id |
String |
参数解释:转发策略所在的项目ID。 |
provisioning_status |
String |
参数解释:转发策略的配置状态。 取值范围:
|
redirect_pool_id |
String |
参数解释:转发到pool的ID。 约束限制:当action为REDIRECT_TO_POOL时生效。 |
redirect_listener_id |
String |
参数解释:转发到的listener的ID。 约束限制:
|
redirect_url |
String |
参数解释:转发到的url。 取值范围:必须满足格式: protocol://host:port/path?query。 不支持该字段,请勿使用。 |
rules |
Array of RuleRef objects |
参数解释:转发策略关联的转发规则列表。 |
redirect_url_config |
RedirectUrlConfig object |
参数解释:转发到的url配置。 约束限制:
取值范围:格式:protocol://host:port/path?query protocol、host、port、path不允许同时不传或同时传${xxx} (${xxx}表示原值,如${host}表示被转发的请求URL的host部分)。 protocol和port传入的值不能与l7policy关联的监听器一致且host、path同时不传或同时传${xxx}。 |
redirect_pools_extend_config |
RedirectPoolsExtendConfig object |
参数解释:转发到的后端主机组的配置。 约束限制:当action为REDIRECT_TO_POOL时生效。 |
fixed_response_config |
FixtedResponseConfig object |
参数解释:固定返回页面的配置。 约束限制:
|
created_at |
String |
参数解释:创建时间。 取值范围:格式:yyyy-MM-dd'T'HH:mm:ss'Z',UTC时区。 注意:独享型实例的历史数据以及共享型实例下的资源,不返回该字段。 |
updated_at |
String |
参数解释:更新时间。 取值范围:格式:yyyy-MM-dd'T'HH:mm:ss'Z',UTC时区。 注意:独享型实例的历史数据以及共享型实例下的资源,不返回该字段。 |
enterprise_project_id |
String |
参数解释:企业项目ID。 |
参数 |
参数类型 |
描述 |
---|---|---|
protocol |
String |
参数解释:重定向的协议。 取值范围:
|
host |
String |
参数解释:重定向的主机名。 取值范围:只能包含英文字母、数字、“-”、“.”。且必须以字母、数字开头。 默认取值:${host} 表示继承原值(即与被转发请求保持一致)。 |
port |
String |
参数解释:重定向到的端口。 默认取值:默认值${port}表示继承原值(即与被转发请求保持一致)。 |
path |
String |
参数解释:重定向的路径。 取值范围:支持英文字母、数字、_~';@^-%#&$.*+?,=!:|\/()[]{},且必须以"/"开头。 默认取值:${path} 表示继承原值(即与被转发请求保持一致)。 |
query |
String |
参数解释:重定向的查询字符串。举例如下: 将query设置为:${query}&name=my_name,则在转发符合条件的URL (如https://www.example.com:8080/elb?type=loadbalancer)时,将会重定向到 https://www.example.com:8080/elb?type=loadbalancer&name=my_name。在例子中${query}表示type=loadbalancer。 取值范围:只能包含英文字母、数字和特殊字符:!$&'()*+,-./:;=?@^_`。字母区分大小写。其中$1,$2会匹配请求url通配符星号(*) 默认取值:${query}表示继承原值(即与被转发请求保持一致) |
status_code |
String |
参数解释:重定向后的返回码。 取值范围:
|
参数 |
参数类型 |
描述 |
---|---|---|
rewrite_url_enable |
Boolean |
参数解释:是否开启url重定向。 |
rewrite_url_config |
RewriteUrlConfig object |
参数解释:URL重定向配置。 约束限制:当action为REDIRECT_TO_POOL的时候生效。 |
参数 |
参数类型 |
描述 |
---|---|---|
host |
String |
参数解释:重定向的域名。 取值范围:英文字母、数字、“-”、“.”,必须以字母、数字开头。 默认取值:${host},表示继承原值(即与被重写请求host保持一致)。 |
path |
String |
参数解释:重定向的请求路径。其中$1-$9会匹配请求url通配符星号(*),当正则匹配分组小于指定数字,则$指定数字结果为空。$后面跟字母,匹配结果均为空,直到下一个特殊字符出现,例如$abc#123,则匹配结果为#123;$后面跟特殊字符则直接输出特殊字符,例如$#匹配结果为$#。 取值范围:英文字母、数字、_~';@^-%#&$.+?,=!:|/(),且必须以"/"开头。 默认取值:${path},表示继承原值(即与被重写请求保持一致)。 |
query |
String |
参数解释:重定向的查询字符串。其中$1-$9会匹配请求url通配符星号(*),当正则匹配分组小于指定数字,则$指定数字结果为空。$后面跟字母,匹配结果均为空,直到下一个特殊字符出现,例如$abc#123,则匹配结果为#123;$后面跟特殊字符则直接输出特殊字符,例如$#匹配结果为$#。 取值范围:英文字母、数字和特殊字符:!$&'()+,-./:;=?@^_`。字母区分大小写。 默认取值:${query},表示继承原值(即与被重写请求保持一致)。 |
请求示例
查询转发策略列表
GET https://{ELB_Endpoint}/v3/99a3fff0d03c428eac3678da6a7d0f24/elb/l7policies?display_all_rules=true
响应示例
状态码:200
操作正常返回。
{ "request_id" : "d3c67339-be91-4813-bb24-85728a5d326a", "l7policies" : [ { "redirect_pool_id" : "768e9e8c-e7cb-4fef-b24b-af9399dbb240", "description" : "", "admin_state_up" : true, "rules" : [ { "id" : "c5c2d625-676b-431e-a4c7-c59cc2664881" } ], "project_id" : "7a9941d34fc1497d8d0797429ecfd354", "listener_id" : "cdb03a19-16b7-4e6b-bfec-047aeec74f56", "redirect_url" : null, "redirect_url_config" : null, "redirect_pools_config" : { "pool_id" : "722e9e8c-e7cb-4fef-b24b-af9399dbb240", "weight" : 12 }, "redirect_pools_sticky_session_config" : { "timeout" : 23, "enable" : false }, "fixed_response_config" : null, "redirect_listener_id" : null, "action" : "REDIRECT_TO_POOL", "position" : 100, "priority" : null, "provisioning_status" : "ACTIVE", "id" : "01832d99-bbd8-4340-9d0c-6ff8f7a37307", "name" : "l7policy-67" }, { "redirect_pool_id" : null, "description" : "", "admin_state_up" : true, "rules" : [ { "id" : "390f3a9f-670d-4ca6-b72c-6be8a48a8a00" } ], "project_id" : "7a9941d34fc1497d8d0797429ecfd354", "listener_id" : "bd782cbf-fb5e-411a-9295-530bdec05058", "redirect_url" : null, "redirect_url_config" : null, "redirect_pools_config" : { "pool_id" : "722e9e8c-e7cb-4fef-b24b-af9399dbb240", "weight" : 12 }, "redirect_pools_sticky_session_config" : { "timeout" : 23, "enable" : false }, "fixed_response_config" : { "content_type" : "text/plain", "message_body" : "", "status_code" : "207" }, "redirect_listener_id" : null, "action" : "FIXED_RESPONSE", "position" : 6, "priority" : 2, "provisioning_status" : "ACTIVE", "id" : "049a8635-9754-444e-94aa-678993b39cd6", "name" : "l7policy-67" } ], "page_info" : { "next_marker" : "2587d8b1-9e8d-459c-9081-7bccaa075d2b", "previous_marker" : "01832d99-bbd8-4340-9d0c-6ff8f7a37307", "current_count" : 2 } }
状态码
状态码 |
描述 |
---|---|
200 |
操作正常返回。 |
错误码
请参见错误码。