文档首页/ 弹性负载均衡 ELB/ API参考/ API（V3）/ 转发策略/ 查询转发策略详情
更新时间：2025-08-26 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询转发策略详情

功能介绍

查询七层转发策略详情。

调用方法

请参见如何调用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: 默认值，表示正常。

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

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

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（分钟）
表9 RedirectPoolsExtendConfig

参数

参数类型

描述

rewrite_url_enable

Boolean

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

取值范围：true 开启，false 未开启。

rewrite_url_config

RewriteUrlConfig object

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

insert_headers_config

InsertHeadersConfig object

参数解释：要添加的请求头参数列表。

remove_headers_config

RemoveHeadersConfig object

参数解释：要移除的请求头参数列表。

traffic_limit_config

TrafficLimitConfig object

参数解释：转发策略限速的配置。

cors_config

CorsConfig object

参数解释：转发策略跨域的配置。

traffic_mirror_config

TrafficMirrorConfig object

参数解释：流量镜像的配置
表10 RewriteUrlConfig

参数

参数类型

描述

host

String

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

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

path

String

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

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

query

String

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

取值范围：英文字母、数字和特殊字符：!$&'()+,-./:;=?@^_`。字母区分大小写。
表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 TrafficMirrorConfig

参数

参数类型

描述

target_ids

Array of strings

参数解释：流量镜像的目的后端服务器组ID。

取值范围：不涉及

mirror_request_body_enable

Boolean

参数解释：镜像请求是否携带请求体，默认true。

取值范围：不涉及
表13 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

参数解释：转发策略限速的配置。
表14 InsertHeadersConfig

参数

参数类型

描述

configs

Array of InsertHeaderConfig objects

参数解释：要添加请求头参数列表。

约束限制：不涉及
表15 InsertHeaderConfig

参数

参数类型

描述

key

String

参数解释：请求头参数名。

取值范围：1-40个字符，字母a-z（不区分大小写）、数字，短划线-和下划线_。

value_type

String

参数解释：请求头参数类别。

取值范围：USER_DEFINED,REFERENCE_HEADER,SYSTEM_DEFINED。

value

String

参数解释：请求头参数的值。

取值范围：1-128个字符，支持ascii码值32<=ch<=127范围内可打印字符，*和英文问号?。不能以空格开头或结尾。
表16 RemoveHeadersConfig

参数

参数类型

描述

configs

Array of RemoveHeaderConfig objects

参数解释：要移除的请求头参数列表。

约束限制：不涉及
表17 RemoveHeaderConfig

参数

参数类型

描述

key

String

参数解释：被移除的请求头的参数名。

取值范围：1-40个字符，字母a-z（不区分大小写）、数字，短划线-和下划线_。
表18 TrafficLimitConfig

参数

参数类型

描述

qps

Integer

参数解释：转发策略qps限速。

取值范围：0-100000，单位：个/秒。0表示不限速。

per_source_ip_qps

Integer

参数解释：对转发策略单源(单个客户端IP)进行限速。

取值范围：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代码示例如下。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
 
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());
        }
    }
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
 
# 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)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
 
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

操作正常返回。

错误码

请参见错误码。

父主题： 转发策略

相关文档