文档首页/ 弹性负载均衡 ELB/ API参考/ API（V3）/ 转发规则/ 创建转发规则

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

在线调试

CLI示例

查看PDF

创建转发规则

功能介绍

创建七层转发规则。

接口约束

如果l7policy是重定向到listener的话，不允许创建l7rule。

调用方法

请参见如何调用API。

URI

POST /v3/{project_id}/elb/l7policies/{l7policy_id}/rules

表1 路径参数
参数	是否必选	参数类型	描述
l7policy_id	是	String	参数解释：转发策略ID。
project_id	是	String	参数解释：项目ID。

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	参数解释：IAM鉴权Token。

表3 请求Body参数
参数	是否必选	参数类型	描述
rule	是	CreateRuleOption object	参数解释：转发规则对象。

表4 CreateRuleOption
参数	是否必选	参数类型	描述
admin_state_up	否	Boolean	参数解释：转发规则的管理状态。约束限制：只支持设置为true。
compare_type	是	String	参数解释：转发匹配方式。约束限制： type为HOST_NAME时仅支持EQUAL_TO，支持通配符。 type为PATH时可以为REGEX，STARTS_WITH，EQUAL_TO。 type为METHOD、SOURCE_IP时，仅支持EQUAL_TO。 type为HEADER、QUERY_STRING，仅支持EQUAL_TO，支持通配符、？。取值范围： EQUAL_TO 表示精确匹配。 REGEX 表示正则匹配。 STARTS_WITH 表示前缀匹配。
key	否	String	参数解释：匹配项的名称，比如转发规则匹配类型是请求头匹配，则key表示请求头参数的名称。不支持该字段，请勿使用。
value	是	String	参数解释：匹配项的值。比如转发规则匹配类型是域名匹配，则value表示域名的值。约束限制：仅当conditions空时该字段生效。取值范围：当转发规则类别type为HOST_NAME时，字符串只能包含英文字母、数字、-、.或，必须以字母、数字或开头。若域名中包含，则只能出现在开头且必须以.开始。当开头时表示通配0~任一个字符。当转发规则类别type为PATH时，当转发规则的compare_type为STARTS_WITH、EQUAL_TO时，字符串只能包含英文字母、数字、_~';@^-%#&$.*+?,=!:\|\/()[]{}，且必须以/开头。当转发规则类别type为METHOD、SOURCE_IP、HEADER,QUERY_STRING时，该字段无意义，使用conditions来指定key/value。
project_id	否	String	参数解释：转发规则所在的项目ID。
type	是	String	参数解释：转发规则类别。约束限制：一个l7policy下创建的l7rule的HOST_NAME，PATH，METHOD，SOURCE_IP不能重复。 HEADER、QUERY_STRING支持重复的rule配置。取值范围： HOST_NAME：匹配域名。 PATH：匹配请求路径。 METHOD：匹配请求方法。 HEADER：匹配请求头。 QUERY_STRING：匹配请求查询参数。 SOURCE_IP：匹配请求源IP地址。 COOKIE: 匹配cookie信息。
invert	否	Boolean	参数解释：是否反向匹配。取值范围：true、false，默认false。不支持该字段，请勿使用。
conditions	否	Array of CreateRuleCondition objects	参数解释：转发规则的匹配条件。约束限制：当监听器的高级转发策略功能（enhance_l7policy_enable）开启后才会生效。若转发规则配置了conditions，字段key、字段value的值无意义。同一个rule内的conditions列表中所有key必须相同，value不允许重复。

表5 CreateRuleCondition
参数	是否必选	参数类型	描述
key	否	String	参数解释：匹配项的名称。约束限制：同一个rule内的conditions列表中所有key必须相同。取值范围：当转发规则类别type为HOST_NAME、PATH、METHOD、SOURCE_IP时，该字段固定为空字符串。当转发规则类别type为HEADER时，key表示请求头参数的名称，value表示请求头参数的值。 key的长度限制1-40字符，只允许包含字母、数字和-_。当转发规则类别type为QUERY_STRING时，key表示查询参数的名称，value表示查询参数的值。 key的长度限制为1-128字符，不支持空格，中括号，大括号，尖括号，反斜杠，双引号，'#'，'&'，'\|'，‘%’，‘~’，字母区分大小写。
value	是	String	参数解释：匹配项的值。约束限制：同一个rule内的conditions列表中所有key必须相同。同一个rule内的conditions列表中所有value不允许重复。取值范围：当转发规则类别type为HOST_NAME时，key固定为空字符串，value表示域名的值。 value长度1-128字符，字符串只能包含英文字母、数字、-、.或，必须以字母、数字或开头，只能出现在开头且必须以.开始。当转发规则类别type为PATH时，key固定为空字符串，value表示请求路径的值。 value长度1-128字符。当转发规则的compare_type为STARTS_WITH、EQUAL_TO时，字符串只能包含英文字母、数字、_~';@^-%#&$.+?,=!:\|\/()[]{}，且必须以/开头。当转发规则类别type为HEADER时，key表示请求头参数的名称，value表示请求头参数的值。 value长度限制1-128字符，不支持空格，双引号，支持以下通配符：（匹配0个或更多字符）和？（正好匹配1个字符）。当转发规则类别type为QUERY_STRING时，key表示查询参数的名称，value表示查询参数的值。 value长度限制为1-128字符，不支持空格，中括号，大括号，尖括号，反斜杠，双引号， '#'，'&'，'\|'，‘%’，‘~’，字母区分大小写，支持通配符：*（匹配0个或更多字符）和？（正好匹配1个字符）当转发规则类别type为METHOD时，key固定为空字符串，value表示请求方式。value取值范围为：GET, PUT, POST,DELETE, PATCH, HEAD, OPTIONS。当转发规则类别type为SOURCE_IP时，key固定为空字符串，value表示请求源地址。 value为CIDR格式，支持ipv4，ipv6。例如192.168.0.2/32，2049::49/64。

响应参数

状态码： 201

表6 响应Body参数
参数	参数类型	描述
request_id	String	参数解释：请求ID。注：自动生成。
rule	L7Rule object	参数解释：转发规则对象。

表7 L7Rule
参数	参数类型	描述
admin_state_up	Boolean	参数解释：转发规则的管理状，固定为true。不支持该字段，请勿使用。
compare_type	String	参数解释：转发规则的匹配方式。取值范围：type为HOST_NAME时可以为EQUAL_TO。type为PATH时可以为REGEX，STARTS_WITH，EQUAL_TO。
key	String	参数解释：匹配内容的键值。约束限制：type为HOST_NAME和PATH时，该字段不生效。
project_id	String	参数解释：转发规则所在的项目ID。
type	String	参数解释：转发规则类别。约束限制：一个l7policy下创建的l7rule的HOST_NAME，PATH，METHOD，SOURCE_IP不能重复。 HEADER、QUERY_STRING支持重复的rule配置。取值范围： HOST_NAME：匹配域名。 PATH：匹配请求路径。 METHOD：匹配请求方法。 HEADER：匹配请求头。 QUERY_STRING：匹配请求查询参数。 SOURCE_IP：匹配请求源IP地址。 COOKIE: 匹配cookie信息。
value	String	参数解释：匹配内容的值。约束限制：仅当conditions空时该字段生效。取值范围：当type为HOST_NAME时，字符串只能包含英文字母、数字、-.，必须以字母、数字或开头。若域名中包含，则只能出现在开头且必须以.开始。当开头时表示通配0~任一个字符。当type为PATH时，当转发规则的compare_type为STARTS_WITH、EQUAL_TO时，字符串只能包含英文字母、数字、_~';@^-%#&$.*+?,=!:\|\/()[]{}，且必须以/开头。当type为METHOD、SOURCE_IP、HEADER, QUERY_STRING时，该字段无意义，使用condition_pair来指定key，value。
provisioning_status	String	参数解释：provisioning状态。该字段无效，默认为ACTIVE。取值范围：ACTIVE、PENDING_CREATE 或者ERROR。
invert	Boolean	参数解释：是否反向匹配。约束限制：固定为false。该字段能更新但不会生效。
id	String	参数解释：规则ID。
conditions	Array of RuleCondition objects	参数解释：转发规则的匹配条件。约束限制：当监听器的高级转发策略功能（enhance_l7policy_enable）开启后才会生效。若转发规则配置了conditions，字段key、字段value的值无意义。同一个rule内的conditions列表中所有key必须相同，value不允许重复。
created_at	String	参数解释：创建时间。取值范围：格式：yyyy-MM-dd'T'HH:mm:ss'Z'，UTC时区。注意：独享型实例的历史数据以及共享型实例下的资源，不返回该字段。
updated_at	String	参数解释：更新时间。取值范围：格式：yyyy-MM-dd'T'HH:mm:ss'Z'，UTC时区。注意：独享型实例的历史数据以及共享型实例下的资源，不返回该字段。

表8 RuleCondition
参数	参数类型	描述
key	String	参数解释：匹配项的名称。约束限制：同一个rule内的conditions列表中所有key必须相同。取值范围：当转发规则类别type为HOST_NAME、PATH、METHOD、SOURCE_IP时，该字段固定为空字符串。当转发规则类别type为HEADER时，key表示请求头参数的名称，value表示请求头参数的值。 key的长度限制1-40字符，只允许包含字母、数字和-_。当转发规则类别type为QUERY_STRING时，key表示查询参数的名称，value表示查询参数的值。 key的长度限制为1-128字符，不支持空格，中括号，大括号，尖括号，反斜杠，双引号， '#'，'&'，'\|'，‘%’，‘~’，字母区分大小写。
value	String	参数解释：匹配项的值。约束限制：同一个rule内的conditions列表中所有value不允许重复。取值范围：当转发规则类别type为HOST_NAME时，key固定为空字符串，value表示域名的值。 value长度1-128字符，字符串只能包含英文字母、数字、-.，必须以字母、数字或开头，只能出现在开头且必须以.开始。当转发规则类别type为PATH时，key固定为空字符串，value表示请求路径的值。 value长度1-128字符。当转发规则的compare_type为STARTS_WITH、EQUAL_TO时，字符串只能包含英文字母、数字、_~';@^-%#&$.+?,=!:\|\/()[]{}，且必须以"/"开头。当转发规则类别type为HEADER时，key表示请求头参数的名称，value表示请求头参数的值。 value长度限制1-128字符，不支持空格，双引号，支持以下通配符：（匹配0个或更多字符）和？（正好匹配1个字符）。当转发规则类别type为QUERY_STRING时，key表示查询参数的名称，value表示查询参数的值。 value长度限制为1-128字符，不支持空格，中括号，大括号，尖括号，反斜杠，双引号， '#'，'&'，'\|'，‘%’，‘~’，字母区分大小写，支持通配符：*（匹配0个或更多字符）和？（正好匹配1个字符）当转发规则类别type为METHOD时，key固定为空字符串，value表示请求方式。value取值范围为：GET, PUT, POST,DELETE, PATCH, HEAD, OPTIONS。当转发规则类别type为SOURCE_IP时，key固定为空字符串，value表示请求源地址。 value为CIDR格式，支持ipv4，ipv6。例如192.168.0.2/32，2049::49/64。

请求示例

创建转发规则，并指定规则类型为路径

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

{
  "rule" : {
    "compare_type" : "EQUAL_TO",
    "type" : "PATH",
    "value" : "/bbb.html"
  }
}

响应示例

状态码： 201

POST操作正常返回。

{
  "rule" : {
    "compare_type" : "EQUAL_TO",
    "provisioning_status" : "ACTIVE",
    "project_id" : "99a3fff0d03c428eac3678da6a7d0f24",
    "invert" : false,
    "admin_state_up" : true,
    "value" : "/bbb.html",
    "key" : null,
    "type" : "PATH",
    "id" : "84f4fcae-9c15-4e19-a99f-72c0b08fd3d7"
  },
  "request_id" : "3639f1b7-f04b-496e-9218-ec5a9e493f69"
}

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 CreateL7RuleSolution {

    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();
        CreateL7RuleRequest request = new CreateL7RuleRequest();
        request.withL7policyId("{l7policy_id}");
        CreateL7RuleRequestBody body = new CreateL7RuleRequestBody();
        CreateRuleOption rulebody = new CreateRuleOption();
        rulebody.withCompareType("EQUAL_TO")
            .withValue("/bbb.html")
            .withType("PATH");
        body.withRule(rulebody);
        request.withBody(body);
        try {
            CreateL7RuleResponse response = client.createL7Rule(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 = CreateL7RuleRequest()
        request.l7policy_id = "{l7policy_id}"
        rulebody = CreateRuleOption(
            compare_type="EQUAL_TO",
            value="/bbb.html",
            type="PATH"
        )
        request.body = CreateL7RuleRequestBody(
            rule=rulebody
        )
        response = client.create_l7_rule(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.CreateL7RuleRequest{}
	request.L7policyId = "{l7policy_id}"
	rulebody := &model.CreateRuleOption{
		CompareType: "EQUAL_TO",
		Value: "/bbb.html",
		Type: "PATH",
	}
	request.Body = &model.CreateL7RuleRequestBody{
		Rule: rulebody,
	}
	response, err := client.CreateL7Rule(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

          

        

      
     

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

状态码

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

错误码

请参见错误码。

父主题：转发规则

上一篇：转发规则

下一篇：查询转发规则列表

意见反馈

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

有帮助没帮助

提供反馈

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

系统繁忙，请稍后重试

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

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

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

字符长度不能超过500

直接提交取消

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

智能客服提问云社区提问

创建转发规则

功能介绍

接口约束

调用方法

URI

请求参数

响应参数

请求示例

响应示例

SDK代码示例

状态码

错误码

相关文档

意见反馈

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

7*24

备案

专业服务

退订

建议反馈

售前咨询热线