更新时间:2022-03-31 GMT+08:00
分享

查询转发策略列表

功能介绍

查询七层转发策略列表。

接口约束

  • 分页查询使用的参数为marker、limit、page_reverse。

  • marker和page_reverse只有和limit一起使用时才会生效,单独使用无效。

调试

您可以在API Explorer中调试该接口。

URI

GET /v3/{project_id}/elb/l7policies

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID。

表2 Query参数

参数

是否必选

参数类型

描述

marker

String

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

使用说明:

  • 必须与limit一起使用。

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

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

limit

Integer

每页返回的个数。

最小值:0

最大值:2000

缺省值:2000

page_reverse

Boolean

分页的顺序,true表示从后往前分页,false表示从前往后分页,默认为false。

使用说明:

  • 必须与limit一起使用。

enterprise_project_id

Array

企业项目ID。

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

转发策略的转发动作。取值:

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

  • REDIRECT_TO_LISTENER:重定向到监听器。

  • REDIRECT_TO_URL:重定向到URL。

  • FIXED_RESPONSE:返回固定响应体。

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

转发策略的配置状态。

取值范围:

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

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

支持多值查询,查询条件格式:provisioning_status=xxx&provisioning_status=xxx

display_all_rules

Boolean

是否显示转发策略下的rule详细信息。取值:

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

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

priority

Array

转发策略的优先级。数值越小,优先级越高。

支持多值查询,查询条件格式:priority=xxx&priority=xxx

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

IAM鉴权Token

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

request_id

String

请求ID。

注:自动生成 。

page_info

PageInfo object

分页信息。

l7policies

Array of L7Policy objects

转发策略对象列表。

表5 PageInfo

参数

参数类型

描述

previous_marker

String

分页查询结果中第一条记录的ID

next_marker

String

分页查询结果中最后一条记录的ID。

current_count

Integer

当前的记录数。

表6 L7Policy

参数

参数类型

描述

action

String

转发策略的转发动作。取值:

  • REDIRECT_TO_POOL:转发到后端云服务器组;

  • REDIRECT_TO_LISTENER:重定向到监听器;

  • REDIRECT_TO_URL:重定向到URL;

-FIXED_RESPONSE:返回固定响应体。

使用说明:

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

  • 当action为REDIRECT_TO_POOL时,只支持创建在PROTOCOL为HTTP、HTTPS、TERMINATED_HTTPS的listener上。

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

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

转发策略的配置状态。 取值范围:

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

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

redirect_pool_id

String

转发到pool的ID。当action为REDIRECT_TO_POOL时生效。

使用说明:

  • 指定的pool不能是listener的default_pool。不能是其他listener的l7policy使用的pool。

  • 当action为REDIRECT_TO_POOL时为必选字段。当action为REDIRECT_TO_LISTENER时,不可指定。

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。

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

正则匹配:(https?|ftp|file)://[-A-Za-z0-9+&@#/%?=~_|!:,.;]+[-A-Za-z0-9+&@#/%=~_|]

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}。

fixed_response_config

FixtedResponseConfig object

固定返回页面的配置。当监听器的高级转发策略功能(enhance_l7policy_enable)开启后才会生效,未开启传入该字段会报错。

当action为FIXED_RESPONSE时生效,且为必选字段,其他action不可指定。

表7 RuleRef

参数

参数类型

描述

id

String

规则ID。

表8 RedirectUrlConfig

参数

参数类型

描述

protocol

String

重定向的协议。默认值${protocol}表示继承原值(即与被转发请求保持一致)。

取值范围:

  • HTTP

  • HTTPS

  • ${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.xxx.com:8080/elb?type=loadbalancer,此时${query}表示type=loadbalancer)时,将会重定向到https://www.xxx.com:8080/elb?type=loadbalancer&name=my_name。 只能包含英文字母、数字和特殊字符:!$&'()*+,-./:;=?@^_`。字母区分大小写。

缺省值:${query}

最小长度:0

最大长度:128

status_code

String

重定向后的返回码。

取值范围:

  • 301

  • 302

  • 303

  • 307

  • 308

最小长度:1

最大长度:16

表9 FixtedResponseConfig

参数

参数类型

描述

status_code

String

返回码。支持200~299,400~499,500~599。

最小长度:1

最大长度:16

content_type

String

返回body的格式。

取值范围:

  • text/plain

  • text/css

  • text/html

  • application/javascript

  • application/json

最小长度:0

最大长度:32

message_body

String

返回消息内容。

最小长度:0

最大长度:1024

请求示例

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

操作正常返回。

错误码

请参见错误码

分享:

    相关文档

    相关产品

关闭导读