查询转发策略列表

project_id

是

String

参数解释：项目ID。

marker

否

String

参数解释：上一页最后一条记录的ID。

约束限制：

• 必须与limit一起使用。

• 不指定时表示查询第一页。

• 该字段不允许为空或无效的ID。

limit

否

Integer

参数解释：每页返回的个数。

取值范围：0-2000

默认取值：2000

page_reverse

否

Boolean

参数解释：是否反向查询。

约束限制：

• 必须与limit一起使用。

• 当page_reverse=true时，若要查询上一页，marker取值为当前页返回值的previous_marker。

取值范围：

• true：查询上一页。

• false：查询下一页。

默认取值：false

enterprise_project_id

否

Array of strings

参数解释：所属的企业项目ID。

如果enterprise_project_id不传值，默认查询所有企业项目下的资源，鉴权按照细粒度权限鉴权，必须在用户组下分配elb:*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

参数解释：转发策略的转发动作。

取值范围：

• REDIRECT_TO_POOL：转发到后端服务器组。

• REDIRECT_TO_LISTENER：重定向到监听器。

• REDIRECT_TO_URL：重定向到URL。

• FIXED_RESPONSE：返回固定响应体。

支持多值查询，查询条件格式：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

参数解释：转发策略的配置状态。

取值范围：

• ACTIVE: 表示正常。

• ERROR: 表示当前策略与同一监听器下的其他策略存在相同的规则配置。

支持多值查询，查询条件格式：provisioning_status=xxx&provisioning_status=xxx。

display_all_rules

否

Boolean

参数解释：是否显示转发策略下的rule详细信息。

取值范围：

• true：显示policy下面的rule的详细信息。

• false：只显示policy下面的rule的id信息

priority

否

Array of integers

参数解释：转发策略的优先级。数值越小，优先级越高。

支持多值查询，查询条件格式：priority=xxx&priority=xxx。

X-Auth-Token

是

String

参数解释：IAM鉴权Token

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

参数解释：转发策略的转发动作。

约束限制：

• REDIRECT_TO_LISTENER的优先级最高，配置了以后，该监听器下的其他policy会失效。

• 当action为REDIRECT_TO_POOL时，

  只支持创建在PROTOCOL为HTTP、HTTPS、TERMINATED_HTTPS的listener上。

• 当action为REDIRECT_TO_LISTENER时，只支持创建在PROTOCOL为HTTP的listener上。

取值范围：

• REDIRECT_TO_POOL：转发到后端服务器组；

• REDIRECT_TO_LISTENER：重定向到监听器；

• REDIRECT_TO_URL：重定向到URL；

• FIXED_RESPONSE：返回固定响应体。

admin_state_up

Boolean

参数解释：转发策略的管理状态。

约束限制：只支持设置为true。

description

String

参数解释：转发策略描述信息。

id

String

参数解释：转发策略ID。

listener_id

String

参数解释：转发策略所属的监听器ID。

name

String

参数解释：转发策略名称

position

Integer

参数解释：转发策略的优先级，不支持更新。

不支持该字段，请勿使用。

priority

Integer

参数解释：转发策略的优先级。数字越小表示优先级越高。

约束限制：

• 同一个监听器下不同转发策略之间不允许重复的优先级数值。

• 当关联的监听器的高级转发策略功能（enhance_l7policy_enable）开启后才会生效，未开启传入该字段会报错。

• 当关联的监听器的高级转发策略功能（enhance_l7policy_enable）未开启，按原有policy的排序逻辑，自动排序。

  不同域名优先级独立。相同域名下，按path的compare_type排序，

  精确>前缀>正则，匹配类型相同时，path的长度越长优先级越高。

  若policy下只有域名rule，没有路径rule，默认path为前缀匹配/。

• 共享型负载均衡器下的转发策略不支持该字段。

取值范围：

• 当action为REDIRECT_TO_LISTENER时，支持指定为0-10000。

• 其它action取值，支持指定为1-10000。

默认取值：

• 若关联的监听器的高级转发策略功能（enhance_l7policy_enable）未开启，且不传入该字段，则新创建的转发策略的优先级的值为1。

• 当action为REDIRECT_TO_LISTENER时，则新创建的转发策略的优先级的值为0。

• 其它action取值，新创建的转发策略的优先级的值为同一监听器下已有转发策略的优先级的最大值+1。

  • 若监听器下没有转发策略，则新建的转发策略的优先级为1。

  • 若当前已有转发策略的优先级的最大值是10000，则新创建的转发策略会因超出取值范围10000而失败。此时可通过传入指定priority，或调整原有policy的优先级来避免错误。

project_id

String

参数解释：转发策略所在的项目ID。

provisioning_status

String

参数解释：转发策略的配置状态。

取值范围：

• ACTIVE: 默认值，表示正常。

• ERROR: 表示当前策略与同一监听器下的其他策略存在相同的规则配置。

redirect_pool_id

String

参数解释：转发到pool的ID。

约束限制：当action为REDIRECT_TO_POOL时生效。

redirect_listener_id

String

参数解释：转发到的listener的ID。

约束限制：

• 当action为REDIRECT_TO_LISTENER时必选。

• 只支持protocol为HTTPS/TERMINATED_HTTPS的listener。

• 不能指定为其他loadbalancer下的listener。

• 当action为REDIRECT_TO_POOL时，创建或更新时不能传入该参数。

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_config

Array of RedirectPoolsConfig objects

参数解释：转发到多个主机组列表。

约束限制：一个policy最多配置5个pool。

redirect_pools_sticky_session_config

RedirectPoolsStickySessionConfig object

参数解释：配置转发策略关联的服务器组之间会话保持。负载均衡器会根据客户端第一个请求生成一个cookie，后续所有包含这个cookie值的请求都会由同一个pool处理。

约束限制：共享型负载均衡器下的转发策略不支持该字段，传入会报错。

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时区。

注意：独享型实例的历史数据以及共享型实例下的资源，不返回该字段。

enterprise_project_id

String

参数解释：企业项目ID。

id

String

参数解释：规则ID。

protocol

String

参数解释：重定向的协议。

取值范围：

• HTTP

• HTTPS

• ${protocol}，表示继承原值（即与被转发请求保持一致）。

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

参数解释：重定向后的返回码。

取值范围：

• 301

• 302

• 303

• 307

• 308

insert_headers_config

InsertHeadersConfig object

参数解释：要添加的请求头参数列表。

remove_headers_config

RemoveHeadersConfig object

参数解释：要移除的请求头参数列表。

pool_id

String

参数解释：所在后端服务器组ID。

weight

Integer

参数解释：转发策略主机组的权重。请求将根据该权重进行负载分发到不同的主机组。权重值越大，分发的请求越多。权重为0的后端不再接受新的请求。

取值范围：0-100

enable

Boolean

参数解释：转发策略主机组会话保持开启的开关。

默认取值：false，表示关闭主机组会话保持。

timeout

Integer

参数解释：会话保持的时间。

取值范围：1-1440（分钟）

默认取值：1440

rewrite_url_enable

Boolean

参数解释：是否开启url重定向。

rewrite_url_config

RewriteUrlConfig object

参数解释：URL重定向配置。

约束限制：当action为REDIRECT_TO_POOL的时候生效。

insert_headers_config

InsertHeadersConfig object

参数解释：要添加的请求头参数列表。

remove_headers_config

RemoveHeadersConfig object

参数解释：要移除的请求头参数列表。

traffic_limit_config

TrafficLimitConfig object

参数解释：转发策略限速的配置。

cors_config

CorsConfig object

参数解释：转发策略跨域的配置。

host

String

参数解释：重定向的域名。

取值范围：英文字母、数字、“-”、“.”，必须以字母、数字开头。

默认取值：${host}，表示继承原值（即与被重写请求host保持一致）。

path

String

参数解释：重定向的请求路径。其中$1-$9会匹配请求url通配符星号(*)，当正则匹配分组小于指定数字，则$指定数字结果为空。$后面跟字母，匹配结果均为空，直到下一个特殊字符出现，例如$abc#123，则匹配结果为#123；$后面跟特殊字符则直接输出特殊字符，例如$#匹配结果为$#。

取值范围：英文字母、数字、_~';@^-%#&$.+?,=!:|/()，且必须以"/"开头。

默认取值：${path}，表示继承原值（即与被重写请求保持一致）。

query

String

参数解释：重定向的查询字符串。其中$1-$9会匹配请求url通配符星号（*），当正则匹配分组小于指定数字，则$指定数字结果为空。$后面跟字母，匹配结果均为空，直到下一个特殊字符出现，例如$abc#123，则匹配结果为#123；$后面跟特殊字符则直接输出特殊字符，例如$#匹配结果为$#。

取值范围：英文字母、数字和特殊字符：!$&'()+,-./:;=?@^_`。字母区分大小写。

默认取值：${query}，表示继承原值（即与被重写请求保持一致）。

allow_origin

Array of strings

参数解释：允许的访问来源列表。支持只配置一个元素*，或配置一个或多个值。

约束限制：

• 单个值必须以http://或者https://开头，后边加一个正确的域名或一级泛域名。（例：http://*.test.abc.example.com）

• 单个值可以不加端口，也可以指定端口，端口范围：1~65535。

allow_methods

Array of strings

参数解释：选择跨域访问时允许的 HTTP 方法。

allow_headers

Array of strings

参数解释：允许跨域的 Header 列表。

expose_headers

Array of strings

参数解释：允许暴露的Header列表。

allow_credentials

Boolean

参数解释：是否允许携带凭证信息。

取值范围：

• true：是。

• false：否。

max_age

Long

参数解释：预检请求在浏览器的最大缓存时间，单位：秒。

取值范围：-1~172800。

status_code

String

参数解释：返回码。支持200~299,400~499,500~599。

content_type

String

参数解释：返回body的格式。

取值范围：

• text/plain

• text/css

• text/html

• application/javascript

• application/json

message_body

String

参数解释：返回消息内容。

insert_headers_config

InsertHeadersConfig object

参数解释：要添加的请求头参数列表。

remove_headers_config

RemoveHeadersConfig object

参数解释：要移除的请求头参数列表。

traffic_limit_config

TrafficLimitConfig object

参数解释：转发策略限速的配置。

configs

Array of InsertHeaderConfig objects

参数解释：要添加请求头参数列表。

key

String

参数解释：请求头参数名。

约束限制：不能是以下字符：

connection、upgrade、content-length、transfer-encoding、keep-alive、te、host、cookie、remoteip、authority、x-forwarded-host、x-forwarded-for、x-forwarded-for-port、x-forwarded-tls-certificate-id、x-forwarded-tls-protocol、x-forwarded-tls-cipher、x-forwarded-elb-ip、x-forwarded-port、x-forwarded-elb-id、x-forwarded-elb-vip、x-real-ip、x-forwarded-proto、x-nuwa-trace-ne-in、x-nuwa-trace-ne-out。

取值范围：1-40个字符，字母a-z（不区分大小写）、数字，短划线-和下划线_。

value_type

String

参数解释：请求头参数类别。

取值范围：USER_DEFINED,REFERENCE_HEADER,SYSTEM_DEFINED。

value

String

参数解释：请求头参数的值。

约束限制：当value_type为SYSTEM_DEFINED时，value只可从CLIENT-PORT,CLIENT-IP, ELB-PROTOCOL, ELB-ID, ELB-PORT, ELB-EIP, ELB-VIP中取值。

取值范围：1-128个字符，支持ascii码值32<=ch<=127范围内可打印字符，*和英文问号?。不能以空格开头或结尾。

configs

Array of RemoveHeaderConfig objects

参数解释：要移除的请求头参数列表。

key

String

参数解释：被移除的请求头的参数名。

约束限制：不能移除以下请求头参数：

connection、upgrade、content-length、transfer-encoding、keep-alive、te、host、cookie、remoteip、authority、x-forwarded-host、x-forwarded-for、x-forwarded-for-port、x-forwarded-tls-certificate-id、x-forwarded-tls-protocol、x-forwarded-tls-cipher、x-forwarded-elb-ip、x-forwarded-port、x-forwarded-elb-id、x-forwarded-elb-vip、x-real-ip、x-forwarded-proto、x-nuwa-trace-ne-in、x-nuwa-trace-ne-out

取值范围：1-40个字符，字母a-z（不区分大小写）、数字，短划线-和下划线_。

qps

Integer

参数解释：转发策略qps限速。

取值范围：0-100000，单位：个/秒。0表示不限速。

per_source_ip_qps

Integer

参数解释：对转发策略单源(单个客户端IP)进行限速。

约束限制：

• quic监听器下转发策略不支持配置单源限速。

• 指定该字段时，赋值可以为0或者为null。

• 如果qps不为0，per_source_ip_qps需要小于qps。

取值范围：0-100000，单位：个/秒。0表示不限速。

burst

Integer

参数解释：设置当单源qps超限时，允许的局部突增请求数量。超出该限制的请求将返回503。

取值范围：0-100000，单位：个/秒。

200

操作正常返回。