文档首页/ 弹性负载均衡 ELB/ API参考/ API（V3）/ 转发策略/ 查询转发策略详情

更新时间：2024-12-13 GMT+08:00

在线调试

CLI示例

查看PDF

查询转发策略详情

功能介绍

查询七层转发策略详情。

调用方法

请参见如何调用API。

URI

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

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	参数解释：项目ID。
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_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_config	Array of RedirectPoolsConfig objects	参数解释：转发到多个主机组列表。约束限制：一个policy最多配置5个pool。
redirect_pools_sticky_session_config	RedirectPoolsStickySessionConfig object	参数解释：配置转发策略关联的服务器组之间会话保持。负载均衡器会根据客户端第一个请求生成一个cookie，后续所有包含这个cookie值的请求都会由同一个pool处理。约束限制：共享型负载均衡器下的转发策略不支持该字段，传入会报错。
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。

表5 RuleRef
参数	参数类型	描述
id	String	参数解释：规则ID。

表6 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
insert_headers_config	InsertHeadersConfig object	参数解释：要添加的请求头参数列表。
remove_headers_config	RemoveHeadersConfig object	参数解释：要移除的请求头参数列表。

表7 RedirectPoolsConfig
参数	参数类型	描述
pool_id	String	参数解释：所在后端服务器组ID。
weight	Integer	参数解释：转发策略主机组的权重。请求将根据该权重进行负载分发到不同的主机组。权重值越大，分发的请求越多。权重为0的后端不再接受新的请求。取值范围：0-100

表8 RedirectPoolsStickySessionConfig
参数	参数类型	描述
enable	Boolean	参数解释：转发策略主机组会话保持开启的开关。默认取值：false，表示关闭主机组会话保持。
timeout	Integer	参数解释：会话保持的时间。取值范围：1-1440（分钟）默认取值：1440

表9 RedirectPoolsExtendConfig
参数	参数类型	描述
rewrite_url_enable	Boolean	参数解释：是否开启url重定向。
rewrite_url_config	RewriteUrlConfig object	参数解释：URL重定向配置。约束限制：当action为REDIRECT_TO_POOL的时候生效。
insert_headers_config	InsertHeadersConfig object	参数解释：要添加的请求头参数列表。
remove_headers_config	RemoveHeadersConfig object	参数解释：要移除的请求头参数列表。
traffic_limit_config	TrafficLimitConfig object	参数解释：转发策略限速的配置。
cors_config	CorsConfig object	参数解释：转发策略跨域的配置。

**表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** CorsConfig
参数	参数类型	描述
allow_origin	Array of strings	参数解释：允许的访问来源列表。支持只配置一个元素，或配置一个或多个值。约束限制：单个值必须以http://或者https://开头，后边加一个正确的域名或一级泛域名。（例：http://.test.abc.example.com）单个值可以不加端口，也可以指定端口，端口范围：1~65535。
allow_methods	Array of strings	参数解释：选择跨域访问时允许的 HTTP 方法。
allow_headers	Array of strings	参数解释：允许跨域的 Header 列表。
expose_headers	Array of strings	参数解释：允许暴露的Header列表。
allow_credentials	Boolean	参数解释：是否允许携带凭证信息。取值范围： true：是。 false：否。
max_age	Long	参数解释：预检请求在浏览器的最大缓存时间，单位：秒。取值范围：-1~172800。

**表12** 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	参数解释：返回消息内容。
insert_headers_config	InsertHeadersConfig object	参数解释：要添加的请求头参数列表。
remove_headers_config	RemoveHeadersConfig object	参数解释：要移除的请求头参数列表。
traffic_limit_config	TrafficLimitConfig object	参数解释：转发策略限速的配置。

**表13** InsertHeadersConfig
参数	参数类型	描述
configs	Array of InsertHeaderConfig objects	参数解释：要添加请求头参数列表。

**表14** InsertHeaderConfig
参数	参数类型	描述
key	String	参数解释：请求头参数名。约束限制：不能是以下字符： connection、upgrade、content-length、transfer-encoding、keep-alive、te、host、cookie、remoteip、authority、x-forwarded-host、x-forwarded-for、x-forwarded-for-port、x-forwarded-tls-certificate-id、x-forwarded-tls-protocol、x-forwarded-tls-cipher、x-forwarded-elb-ip、x-forwarded-port、x-forwarded-elb-id、x-forwarded-elb-vip、x-real-ip、x-forwarded-proto、x-nuwa-trace-ne-in、x-nuwa-trace-ne-out。取值范围：1-40个字符，字母a-z（不区分大小写）、数字，短划线-和下划线_。
value_type	String	参数解释：请求头参数类别。取值范围：USER_DEFINED,REFERENCE_HEADER,SYSTEM_DEFINED。
value	String	参数解释：请求头参数的值。约束限制：当value_type为SYSTEM_DEFINED时，value只可从CLIENT-PORT,CLIENT-IP, ELB-PROTOCOL, ELB-ID, ELB-PORT, ELB-EIP, ELB-VIP中取值。取值范围：1-128个字符，支持ascii码值32<=ch<=127范围内可打印字符，*和英文问号?。不能以空格开头或结尾。

**表15** RemoveHeadersConfig
参数	参数类型	描述
configs	Array of RemoveHeaderConfig objects	参数解释：要移除的请求头参数列表。

**表16** RemoveHeaderConfig
参数	参数类型	描述
key	String	参数解释：被移除的请求头的参数名。约束限制：不能移除以下请求头参数： connection、upgrade、content-length、transfer-encoding、keep-alive、te、host、cookie、remoteip、authority、x-forwarded-host、x-forwarded-for、x-forwarded-for-port、x-forwarded-tls-certificate-id、x-forwarded-tls-protocol、x-forwarded-tls-cipher、x-forwarded-elb-ip、x-forwarded-port、x-forwarded-elb-id、x-forwarded-elb-vip、x-real-ip、x-forwarded-proto、x-nuwa-trace-ne-in、x-nuwa-trace-ne-out 取值范围：1-40个字符，字母a-z（不区分大小写）、数字，短划线-和下划线_。

**表17** TrafficLimitConfig
参数	参数类型	描述
qps	Integer	参数解释：转发策略qps限速。取值范围：0-100000，单位：个/秒。0表示不限速。
per_source_ip_qps	Integer	参数解释：对转发策略单源(单个客户端IP)进行限速。约束限制： quic监听器下转发策略不支持配置单源限速。指定该字段时，赋值可以为0或者为null。如果qps不为0，per_source_ip_qps需要小于qps。取值范围：0-100000，单位：个/秒。0表示不限速。
burst	Integer	参数解释：设置当单源qps超限时，允许的局部突增请求数量。超出该限制的请求将返回503。取值范围：0-100000，单位：个/秒。

请求示例

查询指定转发策略详情

GET https://{ELB_Endpoint}/v3/99a3fff0d03c428eac3678da6a7d0f24/elb/l7policies/cf4360fd-8631-41ff-a6f5-b72c35da74be

响应示例

状态码： 200

操作正常返回。

{
  "l7policy" : {
    "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" : {
      "content_type" : "text/plain",
      "message_body" : "",
      "status_code" : "207"
    },
    "redirect_listener_id" : null,
    "action" : "REDIRECT_TO_POOL",
    "position" : 100,
    "priority" : 1,
    "provisioning_status" : "ACTIVE",
    "id" : "01832d99-bbd8-4340-9d0c-6ff8f7a37307",
    "name" : "l7policy-67"
  },
  "request_id" : "6be83ec4-623e-4840-a417-2fcdf8ad5dfa"
}

SDK代码示例

SDK代码示例如下。

      
       
         
         
           package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.elb.v3.region.ElbRegion;
import com.huaweicloud.sdk.elb.v3.*;
import com.huaweicloud.sdk.elb.v3.model.*;


public class ShowL7PolicySolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        ElbClient client = ElbClient.newBuilder()
                .withCredential(auth)
                .withRegion(ElbRegion.valueOf("<YOUR REGION>"))
                .build();
        ShowL7PolicyRequest request = new ShowL7PolicyRequest();
        request.withL7policyId("{l7policy_id}");
        try {
            ShowL7PolicyResponse response = client.showL7Policy(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

          

        

      
     

      
       
         
         
           # coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkelb.v3.region.elb_region import ElbRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkelb.v3 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = ElbClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(ElbRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ShowL7PolicyRequest()
        request.l7policy_id = "{l7policy_id}"
        response = client.show_l7_policy(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

          

        

      
     

      
       
         
         
           package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    elb "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/elb/v3"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/elb/v3/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/elb/v3/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    projectId := "{project_id}"

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := elb.NewElbClient(
        elb.ElbClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ShowL7PolicyRequest{}
	request.L7policyId = "{l7policy_id}"
	response, err := client.ShowL7Policy(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

          

        

      
     

更多编程语言的SDK代码示例，请参见API Explorer的代码示例页签，可生成自动对应的SDK代码示例。

状态码

状态码	描述
200	操作正常返回。

错误码

请参见错误码。

父主题：转发策略

上一篇：查询转发策略列表

下一篇：更新转发策略

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！您可在我的云声建议查看反馈及问题处理状态。

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消

如您有其它疑问，您也可以通过华为云社区问答频道来与我们联系探讨

智能客服提问云社区提问

查询转发策略详情

功能介绍

调用方法

URI

请求参数

响应参数

请求示例

响应示例

SDK代码示例

状态码

错误码

相关文档

意见反馈

文档内容是否对您有帮助？

7*24

备案

专业服务

退订

建议反馈

售前咨询热线