查询转发策略列表
功能介绍
查询七层转发策略列表。
接口约束
-
分页查询使用的参数为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 |
是否反向查询。 取值:
使用说明:
|
enterprise_project_id |
否 |
Array |
企业项目ID。不传时查询default企业项目"0"下的资源,鉴权按照default企业项目鉴权; 如果传值,则传已存在的企业项目ID或all_granted_eps(表示查询所有企业项目)进行查询。 支持多值查询,查询条件格式: enterprise_project_id=xxx&enterprise_project_id=xxx。 |
id |
否 |
Array |
转发策略ID。 支持多值查询,查询条件格式:id=xxx&id=xxx。 |
name |
否 |
Array |
转发策略名称。 支持多值查询,查询条件格式:name=xxx&name=xxx。 |
description |
否 |
Array |
转发策略额描述信息。 支持多值查询,查询条件格式:description=xxx&description=xxx。 |
admin_state_up |
否 |
Boolean |
转发策略的管理状态,默认为true。 不支持该字段,请勿使用。 |
listener_id |
否 |
Array |
转发策略所属的监听器ID。 支持多值查询,查询条件格式:listener_id=xxx&listener_id=xxx。 |
position |
否 |
Array |
转发策略的优先级。 支持多值查询,查询条件格式:position=xxx&position=xxx。 不支持该字段,请勿使用。 |
action |
否 |
Array |
转发策略的转发动作。 取值:
支持多值查询,查询条件格式:action=xxx&action=xxx。 |
redirect_url |
否 |
Array |
转发到的url。必须满足格式: protocol://host:port/path?query。 支持多值查询,查询条件格式:redirect_url=xxx&redirect_url=xxx。 不支持该字段,请勿使用。 |
redirect_pool_id |
否 |
Array |
转发到pool的ID。 支持多值查询,查询条件格式:redirect_pool_id=xxx&redirect_pool_id=xxx。 |
redirect_listener_id |
否 |
Array |
转发到的listener的ID。 支持多值查询,查询条件格式:redirect_listener_id=xxx&redirect_listener_id=xxx。 |
provisioning_status |
否 |
Array |
转发策略的配置状态。 取值范围:
支持多值查询,查询条件格式:provisioning_status=xxx&provisioning_status=xxx。 |
display_all_rules |
否 |
Boolean |
是否显示转发策略下的rule详细信息。 取值:
|
priority |
否 |
Array |
转发策略的优先级。数值越小,优先级越高。 支持多值查询,查询条件格式: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 |
转发策略名称 最小长度:1 最大长度:255 |
position |
Integer |
转发策略的优先级,不支持更新。 不支持该字段,请勿使用。 最小值:1 最大值:100 |
priority |
Integer |
转发策略的优先级。数字越小表示优先级越高,同一监听器下不允许重复。 当监听器的高级转发策略功能(enhance_l7policy_enable)开启后才会生效,未开启传入该字段会报错。 当action为REDIRECT_TO_LISTENER时,仅支持指定为0,优先级最高。 当关联的listener没有开启enhance_l7policy_enable,按原有policy的排序逻辑,自动排序。 各域名之间优先级独立,相同域名下,按path的compare_type排序,精确>前缀>正则, 匹配类型相同时,path的长度越长优先级越高。若policy下只有域名rule,没有路径rule,默认path为前缀匹配/。 当关联的listener开启了enhance_l7policy_enable,且不传该字段,则新创建的转发策略的优先级的值为: 同一监听器下已有转发策略的优先级的最大值+1。 因此,若当前已有转发策略的优先级的最大值是10000,新创建会因超出取值范围10000而失败。 此时可通过传入指定priority,或调整原有policy的优先级来避免错误。若监听器下没有转发策略,则新建的转发策略的优先级为1。 共享型负载均衡器下的转发策略不支持该字段。 |
project_id |
String |
转发策略所在的项目ID。 |
provisioning_status |
String |
转发策略的配置状态。 取值范围:
|
redirect_pool_id |
String |
转发到pool的ID。当action为REDIRECT_TO_POOL时生效。 |
redirect_listener_id |
String |
转发到的listener的ID,当action为REDIRECT_TO_LISTENER时必选。 使用说明:
|
redirect_url |
String |
转发到的url。必须满足格式: protocol://host:port/path?query。 不支持该字段,请勿使用。 |
rules |
Array of RuleRef objects |
转发策略关联的转发规则列表 |
redirect_url_config |
RedirectUrlConfig object |
转发到的url配置。 当监听器的高级转发策略功能(enhance_l7policy_enable)开启后才会生效,未开启传入该字段会报错。 当action为REDIRECT_TO_URL时生效,且为必选字段,其他action不可指定,否则报错。 格式: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 |
固定返回页面的配置。 当监听器的高级转发策略功能(enhance_l7policy_enable)开启后才会生效,未开启传入该字段会报错。 当action为FIXED_RESPONSE时生效,且为必选字段,其他action不可指定,否则报错。 共享型负载均衡器下的转发策略不支持该字段,传入会报错。 |
created_at |
String |
创建时间。格式:yyyy-MM-dd'T'HH:mm:ss'Z',UTC时区。 注意:独享型实例的历史数据以及共享型实例下的资源,不返回该字段。 |
updated_at |
String |
更新时间。格式:yyyy-MM-dd'T'HH:mm:ss'Z',UTC时区。 注意:独享型实例的历史数据以及共享型实例下的资源,不返回该字段。 |
参数 |
参数类型 |
描述 |
---|---|---|
protocol |
String |
重定向的协议。默认值${protocol}表示继承原值(即与被转发请求保持一致)。 取值:
最小长度:1 最大长度:36 |
host |
String |
重定向的主机名。字符串只能包含英文字母、数字、“-”、“.”。 且必须以字母、数字开头。默认值${host}表示继承原值(即与被转发请求保持一致)。 缺省值:${host} 最小长度:1 最大长度:128 |
port |
String |
重定向到的端口。默认值${port}表示继承原值(即与被转发请求保持一致)。 缺省值:${port} 最小长度:1 最大长度:16 |
path |
String |
重定向的路径。默认值${path}表示继承原值(即与被转发请求保持一致)。 支持英文字母、数字、_~';@^-%#&$.*+?,=!:|\/()[]{},且必须以"/"开头。 缺省值:${path} 最小长度:1 最大长度:128 |
query |
String |
重定向的查询字符串。默认${query}表示继承原值(即与被转发请求保持一致)。举例如下: 若该字段被设置为:${query}&name=my_name,则在转发符合条件的URL (如https://www.example.com:8080/elb?type=loadbalancer, 此时${query}表示type=loadbalancer)时,将会重定向到 https://www.example.com:8080/elb?type=loadbalancer&name=my_name。 只能包含英文字母、数字和特殊字符:!$&'()*+,-./:;=?@^_`。字母区分大小写。 缺省值:${query} 最小长度:0 最大长度:128 |
status_code |
String |
重定向后的返回码。 取值范围:
最小长度:1 最大长度:16 |
参数 |
参数类型 |
描述 |
---|---|---|
rewrite_url_enable |
Boolean |
是否开启url重定向 |
rewrite_url_config |
RewriteUrlConfig object |
转发到的后端主机组的URL配置。rewrite_url_enable为true时,改字段有效。 |
请求示例
查询转发策略列表
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, "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, "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 |
操作正常返回。 |
错误码
请参见错误码。