查询转发规则列表

project_id

是

String

参数解释：项目ID。

l7policy_id

是

String

策略ID。

limit

否

Integer

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

取值范围：0-2000

默认取值：2000

marker

否

String

上一页最后一条记录的ID。

使用说明：

• 必须与limit一起使用。

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

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

page_reverse

否

Boolean

是否反向查询。

取值：

• true：查询上一页。

• false：查询下一页，默认。

使用说明：

• 必须与limit一起使用。

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

id

否

Array of strings

转发规则ID。

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

compare_type

否

Array of strings

转发匹配方式。

取值：

• EQUAL_TO 表示精确匹配。

• REGEX 表示正则匹配。

• STARTS_WITH 表示前缀匹配。

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

provisioning_status

否

Array of strings

转发规则的配置状态。

取值：ACTIVE 表示正常。

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

invert

否

Boolean

是否反向匹配。使用说明：固定为false。该字段能更新但不会生效。

admin_state_up

否

Boolean

转发规则的管理状态。

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

value

否

Array of strings

匹配内容的值。

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

key

否

Array of strings

匹配内容的键值，用于标识规则。

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

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

type

否

Array of strings

匹配类别，可以为HOST_NAME，PATH。

一个l7policy下创建的l7rule的type不能重复。

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

enterprise_project_id

否

Array of strings

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

如果enterprise_project_id不传值，默认查询所有企业项目下的资源，鉴权按照细粒度权限鉴权，必须在用户组下分配elb:l7rules:list权限。

如果enterprise_project_id传值，鉴权按照企业项目权限鉴权，分为传入具体eps_id和all_granted_eps两种场景，前者查询指定eps_id的eps下的资源，后者查询的是所有有list权限的eps下的资源。

支持多值查询，查询条件格式：

enterprise_project_id=xxx&enterprise_project_id=xxx。

X-Auth-Token

是

String

参数解释：IAM鉴权Token

request_id

String

参数解释：请求ID。

注：自动生成 。

page_info

PageInfo object

参数解释：分页信息。

rules

Array of L7Rule objects

参数解释：规则对象列表。

previous_marker

String

参数解释：分页查询结果中第一条记录的ID。通常用于配合page_reverse=true查询上一页。

next_marker

String

参数解释：分页查询结果中最后一条记录的ID。通常用于查询下一页。

current_count

Integer

参数解释：当前的记录数。

admin_state_up

Boolean

参数解释：转发规则的管理状，固定为true。

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

compare_type

String

参数解释：转发规则的匹配方式。

取值范围：type为HOST_NAME时可以为EQUAL_TO。type为PATH时可以为REGEX，STARTS_WITH，EQUAL_TO。

key

String

参数解释：匹配内容的键值。

约束限制：type为HOST_NAME和PATH时，该字段不生效。

project_id

String

参数解释：转发规则所在的项目ID。

type

String

参数解释：转发规则类别。

约束限制：

• 一个l7policy下创建的l7rule的HOST_NAME，PATH，METHOD，SOURCE_IP不能重复。

  HEADER、QUERY_STRING支持重复的rule配置。

取值范围：

• HOST_NAME：匹配域名。

• PATH：匹配请求路径。

• METHOD：匹配请求方法。

• HEADER：匹配请求头。

• QUERY_STRING：匹配请求查询参数。

• SOURCE_IP：匹配请求源IP地址。

• COOKIE: 匹配cookie信息。

value

String

参数解释：匹配内容的值。

约束限制：仅当conditions空时该字段生效。

取值范围：

• 当type为HOST_NAME时，字符串只能包含英文字母、数字、-.，必须以字母、数字或开头。若域名中包含*，则只能出现在开头且必须以.开始。当*开头时表示通配0~任一个字符。

• 当type为PATH时，当转发规则的compare_type为STARTS_WITH、EQUAL_TO时，字符串只能包含英文字母、数字、_~';@^-%#&$.*+?,=!:|\/()[]{}，且必须以/开头。

• 当type为METHOD、SOURCE_IP、HEADER, QUERY_STRING时，该字段无意义，使用condition_pair来指定key，value。

provisioning_status

String

参数解释：provisioning状态。该字段无效，默认为ACTIVE。

取值范围：ACTIVE、PENDING_CREATE 或者ERROR。

invert

Boolean

参数解释：是否反向匹配。

约束限制：固定为false。该字段能更新但不会生效。

id

String

参数解释：规则ID。

conditions

Array of RuleCondition objects

参数解释：转发规则的匹配条件。

约束限制：

• 当监听器的高级转发策略功能（enhance_l7policy_enable）开启后才会生效。

• 若转发规则配置了conditions，字段key、字段value的值无意义。

• 同一个rule内的conditions列表中所有key必须相同，value不允许重复。

created_at

String

参数解释：创建时间。

取值范围：格式：yyyy-MM-dd'T'HH:mm:ss'Z'，UTC时区。

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

updated_at

String

参数解释：更新时间。

取值范围：格式：yyyy-MM-dd'T'HH:mm:ss'Z'，UTC时区。

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

key

String

参数解释：匹配项的名称。

约束限制：同一个rule内的conditions列表中所有key必须相同。

取值范围：

• 当转发规则类别type为HOST_NAME、PATH、METHOD、SOURCE_IP时，该字段固定为空字符串。

• 当转发规则类别type为HEADER时，key表示请求头参数的名称，value表示请求头参数的值。

  key的长度限制1-40字符，只允许包含字母、数字和-_。

• 当转发规则类别type为QUERY_STRING时，key表示查询参数的名称，value表示查询参数的值。

  key的长度限制为1-128字符，不支持空格，中括号，大括号，尖括号，反斜杠，双引号，

  '#'，'&'，'|'，‘%’，‘~’，字母区分大小写。

value

String

参数解释：匹配项的值。

约束限制：

同一个rule内的conditions列表中所有value不允许重复。

取值范围：

• 当转发规则类别type为HOST_NAME时，key固定为空字符串，value表示域名的值。

  value长度1-128字符，字符串只能包含英文字母、数字、-.*，

  必须以字母、数字或*开头，*只能出现在开头且必须以*.开始。

• 当转发规则类别type为PATH时，key固定为空字符串，value表示请求路径的值。

  value长度1-128字符。当转发规则的compare_type为STARTS_WITH、EQUAL_TO时，

  字符串只能包含英文字母、数字、_~';@^-%#&$.*+?,=!:|\/()[]{}，且必须以"/"开头。

• 当转发规则类别type为HEADER时，key表示请求头参数的名称，value表示请求头参数的值。

  value长度限制1-128字符，不支持空格，

  双引号，支持以下通配符：*（匹配0个或更多字符）和？（正好匹配1个字符）。

• 当转发规则类别type为QUERY_STRING时，key表示查询参数的名称，value表示查询参数的值。

  value长度限制为1-128字符，不支持空格，中括号，大括号，尖括号，反斜杠，双引号，

  '#'，'&'，'|'，‘%’，‘~’，字母区分大小写，支持通配符：*（匹配0个或更多字符）和？（正好匹配1个字符）

• 当转发规则类别type为METHOD时，key固定为空字符串，value表示请求方式。value取值范围为：GET, PUT,

  POST,DELETE, PATCH, HEAD, OPTIONS。

• 当转发规则类别type为SOURCE_IP时，key固定为空字符串，value表示请求源地址。

  value为CIDR格式，支持ipv4，ipv6。例如192.168.0.2/32，2049::49/64。

200

操作正常返回。