查询转发规则全局列表 - ListAllL7Rules

功能介绍

查询当前项目下所有转发规则列表

接口约束

分页查询使用的参数为marker、limit、page_reverse。
marker和page_reverse只有和limit一起使用时才会生效，单独使用无效。

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

如果使用角色与策略授权，具体权限要求请参见权限和授权项。
如果使用身份策略授权，当前API调用无需身份策略权限。

URI

GET /v3/{project_id}/elb/l7policies/rules

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	参数解释：项目ID。获取方式请参见获取项目ID。约束限制：不涉及取值范围：长度为32个字符，由小写字母和数字组成。默认取值：不涉及

表2 Query参数
参数	是否必选	参数类型	描述
limit	否	Integer	参数解释：每页返回的个数。约束限制：不涉及取值范围：0-2000 默认取值：2000
marker	否	String	参数解释：上一页最后一条记录的ID。约束限制：必须与limit一起使用。不指定时表示查询第一页。该字段不允许为空或无效的ID。取值范围：不涉及默认取值：不涉及
page_reverse	否	Boolean	参数解释：是否反向查询。约束限制：必须与limit一起使用。当page_reverse=true时，若要查询上一页，marker取值为当前页返回值的previous_marker。取值范围： true：查询上一页。 false：查询下一页。默认取值：false
id	否	Array of strings	参数解释：转发规则ID。支持多值查询，查询条件格式：id=xxx&id=xxx。约束限制：不涉及取值范围：不涉及默认取值：不涉及
compare_type	否	Array of strings	参数解释：转发匹配方式。支持多值查询，查询条件格式：compare_type=xxx&compare_type=xxx。约束限制：不涉及取值范围： EQUAL_TO 表示精确匹配。 REGEX 表示正则匹配。 STARTS_WITH 表示前缀匹配。默认取值：不涉及
provisioning_status	否	Array of strings	参数解释：转发规则的配置状态。支持多值查询，查询条件格式：provisioning_status=xxx&provisioning_status=xxx。约束限制：不涉及取值范围：ACTIVE 表示正常。默认取值：不涉及
invert	否	Boolean	参数解释：是否反向匹配。约束限制：不涉及取值范围：不涉及默认取值：不涉及
admin_state_up	否	Boolean	参数解释：转发规则的管理状态。约束限制：不涉及取值范围：不涉及默认取值：不涉及
value	否	Array of strings	参数解释：匹配内容的值。支持多值查询，查询条件格式：value=xxx&value=xxx。约束限制：不涉及取值范围：不涉及默认取值：不涉及
key	否	Array of strings	参数解释：匹配内容的键值，用于标识规则。支持多值查询，查询条件格式：key=xxx&key=xxx。约束限制：不涉及取值范围：不涉及默认取值：不涉及
type	否	Array of strings	参数解释：匹配类别。支持多值查询，查询条件格式：type=xxx&type=xxx。约束限制：不涉及取值范围： HOST_NAME：匹配域名。 PATH：匹配请求路径。默认取值：不涉及
enterprise_project_id	否	Array of strings	参数解释：所属的企业项目ID。支持多值查询，查询条件格式： enterprise_project_id=xxx&enterprise_project_id=xxx。约束限制：如果enterprise_project_id不传值，默认查询所有企业项目下的资源，鉴权按照细粒度权限鉴权，必须在用户组下分配elb:l7rules:list权限。如果enterprise_project_id传值，鉴权按照企业项目权限鉴权，分为传入具体eps_id和all_granted_eps两种场景，前者查询指定eps_id的eps下的资源，后者查询的是所有有list权限的eps下的资源。取值范围：不涉及默认取值：不涉及
l7policy_id	否	Array of strings	参数解释：七层转发策略ID。支持多值查询，查询条件格式：l7policy_id=xxx&l7policy_id=xxx。约束限制：不涉及取值范围：不涉及默认取值：不涉及

请求参数

表3 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	参数解释：IAM鉴权Token。约束限制：不涉及取值范围：不涉及默认取值：不涉及

响应参数

状态码：200

表4 响应Body参数
参数	参数类型	描述
request_id	String	参数解释：请求ID。取值范围：由数字、小写字母和中划线（-）组成的字符串，自动生成。
page_info	PageInfo object	参数解释：分页信息。
rules	Array of L7Rule objects	参数解释：规则对象列表。

表5 PageInfo
参数	参数类型	描述
previous_marker	String	参数解释：分页查询结果中第一条记录的ID。通常用于配合page_reverse=true查询上一页。取值范围：不涉及
next_marker	String	参数解释：分页查询结果中最后一条记录的ID。通常用于查询下一页。取值范围：不涉及
current_count	Integer	参数解释：当前页返回记录数。取值范围：不涉及

表6 L7Rule
参数	参数类型	描述
admin_state_up	Boolean	参数解释：转发规则的管理状。取值范围：固定为true。不支持该字段，请勿使用。
compare_type	String	参数解释：转发规则的匹配方式。取值范围：type为HOST_NAME时可以为EQUAL_TO。type为PATH时可以为REGEX，STARTS_WITH，EQUAL_TO。
key	String	参数解释：匹配内容的键值。取值范围：不涉及
project_id	String	参数解释：转发规则所在的项目ID。取值范围：不涉及
type	String	参数解释：转发规则类别。取值范围： HOST_NAME：匹配域名。 PATH：匹配请求路径。 METHOD：匹配请求方法。 HEADER：匹配请求头。 QUERY_STRING：匹配请求查询参数。 SOURCE_IP：匹配请求源IP地址。 COOKIE: 匹配cookie信息。
value	String	参数解释：匹配内容的值。取值范围：当type为HOST_NAME时，字符串只能包含英文字母、数字、-.，必须以字母、数字或开头。若域名中包含，则只能出现在开头且必须以.开始。当开头时表示通配0~任一个字符。当type为PATH时，当转发规则的compare_type为STARTS_WITH、EQUAL_TO时，字符串只能包含英文字母、数字、_~';@^-%#&$.*+?,=!:\|\/()[]{}，且必须以/开头。当type为METHOD、SOURCE_IP、HEADER、QUERY_STRING时，该字段无意义，使用conditions来指定key，value。
provisioning_status	String	参数解释：provisioning状态。该字段无效，默认为ACTIVE。取值范围： ACTIVE：已生效。 PENDING_CREATE：创建中。 ERROR：当前配置有误。
invert	Boolean	参数解释：是否反向匹配。取值范围：不涉及
id	String	参数解释：规则ID。取值范围：不涉及
conditions	Array of RuleCondition objects	参数解释：转发规则的匹配条件。取值范围：不涉及
created_at	String	参数解释：创建时间。取值范围：格式：yyyy-MM-dd'T'HH:mm:ss'Z'，UTC时区。注意：独享型实例的历史数据以及共享型实例下的资源，不返回该字段。
updated_at	String	参数解释：更新时间。取值范围：格式：yyyy-MM-dd'T'HH:mm:ss'Z'，UTC时区。注意：独享型实例的历史数据以及共享型实例下的资源，不返回该字段。

表7 RuleCondition
参数	参数类型	描述
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。默认取值*：不涉及

请求示例

查询当前项目下所有转发规则列表

GET https://{ELB_Endpoint}/v3/{99a3fff0d03c428eac3678da6a7d0f24}/elb/l7policies/rules

响应示例

状态码：200

操作正常返回。

{
  "rules" : [ {
    "compare_type" : "STARTS_WITH",
    "provisioning_status" : "ACTIVE",
    "project_id" : "99a3fff0d03c428eac3678da6a7d0f24",
    "invert" : false,
    "admin_state_up" : true,
    "value" : "/ccc.html",
    "key" : null,
    "type" : "PATH",
    "id" : "84f4fcae-9c15-4e19-a99f-72c0b08fd3d7"
  } ],
  "page_info" : {
    "previous_marker" : "84f4fcae-9c15-4e19-a99f-72c0b08fd3d7",
    "current_count" : 1
  },
  "request_id" : "ae4dbd7d-9271-4040-98b6-3bfe45bb15ee"
}