更新时间:2026-01-16 GMT+08:00

查询转发策略详情

功能介绍

查询七层转发策略详情。

调用方法

请参见如何调用API。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:项目ID。获取方式请参见获取项目ID。

约束限制:不涉及

取值范围:长度为32个字符,由小写字母和数字组成。

默认取值:不涉及

l7policy_id

是

String

参数解释:转发策略ID。

约束限制:不涉及

取值范围:不涉及

默认取值:不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释:IAM鉴权Token。

约束限制:不涉及

取值范围:不涉及

默认取值:不涉及

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

request_id

String

参数解释:请求ID。

取值范围:由数字、小写字母和中划线(-)组成的字符串,自动生成。

l7policy

L7Policy object

参数解释:l7policy对象。

表4 L7Policy

参数

参数类型

描述

action

String

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

取值范围:

  • 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

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

取值范围:

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

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

project_id

String

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

取值范围:不涉及

provisioning_status

String

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

取值范围:

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

redirect_pool_id

String

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

取值范围:不涉及

redirect_listener_id

String

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

取值范围:不涉及

redirect_url

String

参数解释:转发到的url。

取值范围:必须满足格式: protocol://host:port/path?query。

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

rules

Array of RuleRef objects

参数解释:转发策略关联的转发规则列表。

redirect_url_config

RedirectUrlConfig object

参数解释:转发到的url配置。

redirect_pools_config

Array of RedirectPoolsConfig objects

参数解释:转发策略服务器组的权重配置。当监听器的高级转发策略功能(enhance_l7policy_enable)开启后才会生效,未开启传入该字段会报错。

redirect_pools_sticky_session_config

RedirectPoolsStickySessionConfig object

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

redirect_pools_extend_config

RedirectPoolsExtendConfig object

参数解释:转发到的后端服务器组的配置。

fixed_response_config

FixtedResponseConfig object

参数解释:固定返回页面的配置。

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。

取值范围:不涉及

表5 RuleRef

参数

参数类型

描述

id

String

参数解释:规则ID。

取值范围:不涉及

表6 RedirectUrlConfig

参数

参数类型

描述

protocol

String

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

取值范围:

  • HTTP

  • HTTPS

  • ${protocol},表示继承原值(即与被转发请求保持一致)。

host

String

参数解释:重定向的主机名。

取值范围:只能包含英文字母、数字、“-”、“.”。且必须以字母、数字开头。

port

String

参数解释:重定向到的端口。

取值范围:不涉及

path

String

参数解释:重定向的路径。

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

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通配符星号(*)

status_code

String

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

取值范围:

  • 301

  • 302

  • 303

  • 307

  • 308

表7 RedirectPoolsConfig

参数

参数类型

描述

pool_id

String

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

取值范围:不涉及

weight

Integer

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

取值范围:0-100

表8 RedirectPoolsStickySessionConfig

参数

参数类型

描述

enable

Boolean

参数解释:转发策略服务器组会话保持开启的开关。

默认取值:false,表示关闭服务器组会话保持。

timeout

Integer

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

取值范围:1-1440(分钟)

表9 RedirectPoolsExtendConfig

参数

参数类型

描述

rewrite_url_enable

Boolean

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

取值范围:true 开启,false 未开启。

rewrite_url_config

RewriteUrlConfig object

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

表10 RewriteUrlConfig

参数

参数类型

描述

host

String

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

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

path

String

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

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

query

String

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

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

表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/cf4360fd-8631-41ff-a6f5-b72c35da74be

响应示例

状态码:200

操作正常返回。

{
  "l7policy" : {
    "name" : "my policy",
    "redirect_pool_id" : null,
    "description" : "",
    "admin_state_up" : true,
    "rules" : [ {
      "id" : "a8310d08-6d4c-413a-aa45-7e43f8183193"
    } ],
    "project_id" : "0c1503d710984bad92306faea3654dfd",
    "listener_id" : "8b9d7d2c-49dc-43ba-99f5-3bc476bdf10b",
    "redirect_url" : null,
    "redirect_url_config" : null,
    "redirect_pools_config" : [ {
      "weight" : 100,
      "pool_id" : "599fdd99-d908-4dff-9db3-15eec274dfed"
    } ],
    "redirect_pools_sticky_session_config" : {
      "enable" : false,
      "timeout" : 1000
    },
    "fixed_response_config" : null,
    "redirect_listener_id" : null,
    "action" : "REDIRECT_TO_POOL",
    "position" : 100,
    "priority" : 1,
    "provisioning_status" : "ACTIVE",
    "id" : "10ebd807-54b1-4f73-a21e-4e7af939d13b",
    "enterprise_project_id" : "0",
    "created_at" : "2025-04-15T08:36:43Z",
    "updated_at" : "2025-04-15T11:49:56Z",
    "redirect_pools_extend_config" : {
      "rewrite_url_enable" : false,
      "rewrite_url_config" : null,
      "insert_headers_config" : {
        "configs" : [ {
          "key" : "test",
          "value" : "xxx",
          "value_type" : "USER_DEFINED"
        } ]
      },
      "remove_headers_config" : {
        "configs" : [ {
          "key" : "req-trace-id"
        } ]
      },
      "traffic_limit_config" : null,
      "cors_config" : null,
      "traffic_mirror_config" : null
    }
  },
  "request_id" : "54961722be349499068aa73a5f91745a"
}

状态码

状态码

描述

200

操作正常返回。

错误码

请参见错误码。