计算
弹性云服务器 ECS
Flexus云服务
裸金属服务器 BMS
弹性伸缩 AS
镜像服务 IMS
专属主机 DeH
函数工作流 FunctionGraph
云手机服务器 CPH
Huawei Cloud EulerOS
网络
虚拟私有云 VPC
弹性公网IP EIP
虚拟专用网络 VPN
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
VPC终端节点 VPCEP
云连接 CC
企业路由器 ER
企业交换机 ESW
全球加速 GA
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
边缘安全 EdgeSec
威胁检测服务 MTD
CDN与智能边缘
内容分发网络 CDN
CloudPond云服务
智能边缘云 IEC
迁移
主机迁移服务 SMS
对象存储迁移服务 OMS
云数据迁移 CDM
迁移中心 MGC
大数据
MapReduce服务 MRS
数据湖探索 DLI
表格存储服务 CloudTable
云搜索服务 CSS
数据接入服务 DIS
数据仓库服务 GaussDB(DWS)
数据治理中心 DataArts Studio
数据可视化 DLV
数据湖工厂 DLF
湖仓构建 LakeFormation
企业应用
云桌面 Workspace
应用与数据集成平台 ROMA Connect
云解析服务 DNS
专属云
专属计算集群 DCC
IoT物联网
IoT物联网
设备接入 IoTDA
智能边缘平台 IEF
用户服务
账号中心
费用中心
成本中心
资源中心
企业管理
工单管理
国际站常见问题
ICP备案
我的凭证
支持计划
客户运营能力
合作伙伴支持计划
专业服务
区块链
区块链服务 BCS
Web3节点引擎服务 NES
解决方案
SAP
高性能计算 HPC
视频
视频直播 Live
视频点播 VOD
媒体处理 MPC
实时音视频 SparkRTC
数字内容生产线 MetaStudio
存储
对象存储服务 OBS
云硬盘 EVS
云备份 CBR
存储容灾服务 SDRS
高性能弹性文件服务 SFS Turbo
弹性文件服务 SFS
云硬盘备份 VBS
云服务器备份 CSBS
数据快递服务 DES
专属分布式存储服务 DSS
容器
云容器引擎 CCE
容器镜像服务 SWR
应用服务网格 ASM
华为云UCS
云容器实例 CCI
管理与监管
云监控服务 CES
统一身份认证服务 IAM
资源编排服务 RFS
云审计服务 CTS
标签管理服务 TMS
云日志服务 LTS
配置审计 Config
资源访问管理 RAM
消息通知服务 SMN
应用运维管理 AOM
应用性能管理 APM
组织 Organizations
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
应用身份管理服务 OneAccess
数据库
云数据库 RDS
文档数据库服务 DDS
数据管理服务 DAS
数据复制服务 DRS
云数据库 GeminiDB
云数据库 GaussDB
分布式数据库中间件 DDM
数据库和应用迁移 UGO
云数据库 TaurusDB
人工智能
人脸识别服务 FRS
图引擎服务 GES
图像识别 Image
内容审核 Moderation
文字识别 OCR
AI开发平台ModelArts
图像搜索 ImageSearch
对话机器人服务 CBS
华为HiLens
视频智能分析服务 VIAS
语音交互服务 SIS
应用中间件
分布式缓存服务 DCS
API网关 APIG
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
多活高可用服务 MAS
事件网格 EG
企业协同
华为云会议 Meeting
云通信
消息&短信 MSGSMS
云生态
合作伙伴中心
云商店
开发者工具
SDK开发指南
API签名指南
Terraform
华为云命令行工具服务 KooCLI
其他
产品价格详情
系统权限
管理控制台
客户关联华为云合作伙伴须知
消息中心
公共问题
开发与运维
应用管理与运维平台 ServiceStage
软件开发生产线 CodeArts
需求管理 CodeArts Req
部署 CodeArts Deploy
性能测试 CodeArts PerfTest
编译构建 CodeArts Build
流水线 CodeArts Pipeline
制品仓库 CodeArts Artifact
测试计划 CodeArts TestPlan
代码检查 CodeArts Check
代码托管 CodeArts Repo
云应用引擎 CAE
开天aPaaS
云消息服务 KooMessage
云手机服务 KooPhone
云空间服务 KooDrive

查询转发策略列表

功能介绍

查询七层转发策略列表。

接口约束

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

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

调用方法

请参见如何调用API

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

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

约束限制:

  • 必须与limit一起使用。

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

取值范围:

  • true:查询上一页。

  • false:查询下一页。

默认取值:false

enterprise_project_id

Array of strings

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

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

请求参数

表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。通常用于配合page_reverse=true查询上一页。

next_marker

String

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

current_count

Integer

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

表6 L7Policy

参数

参数类型

描述

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

表7 RuleRef

参数

参数类型

描述

id

String

参数解释:规则ID。

表8 RedirectUrlConfig

参数

参数类型

描述

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

表9 RedirectPoolsExtendConfig

参数

参数类型

描述

rewrite_url_enable

Boolean

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

rewrite_url_config

RewriteUrlConfig object

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

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

表10 RewriteUrlConfig

参数

参数类型

描述

host

String

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

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

默认取值:${host},表示继承原值(即与被重写请求host保持一致)。

path

String

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

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

默认取值:${path},表示继承原值(即与被重写请求保持一致)。

query

String

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

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

默认取值:${query},表示继承原值(即与被重写请求保持一致)。

表11 FixtedResponseConfig

参数

参数类型

描述

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

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

请求示例

查询转发策略列表

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,
    "redirect_pools_config" : {
      "pool_id" : "722e9e8c-e7cb-4fef-b24b-af9399dbb240",
      "weight" : 12
    },
    "redirect_pools_sticky_session_config" : {
      "timeout" : 23,
      "enable" : false
    },
    "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,
    "redirect_pools_config" : {
      "pool_id" : "722e9e8c-e7cb-4fef-b24b-af9399dbb240",
      "weight" : 12
    },
    "redirect_pools_sticky_session_config" : {
      "timeout" : 23,
      "enable" : false
    },
    "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

操作正常返回。

错误码

请参见错误码

我们使用cookie来确保您的高速浏览体验。继续浏览本站,即表示您同意我们使用cookie。 详情

文档反馈

文档反馈

意见反馈

0/500

标记内容

同时提交标记内容