调用CreateRules为指定的HTTP或HTTPS监听添加转发规则。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String CreateRules

要执行的操作。

取值:CreateRules

ListenerPort Integer 443

负载均衡实例前端使用的监听端口。

取值范围:1~65535

LoadBalancerId String lb-bp1ca0zt07t934w******

负载均衡实例ID。

RegionId String cn-hangzhou

负载均衡实例的地域ID。

您可以通过调用DescribeRegions接口查询地域ID。

RuleList String [{"RuleName":"Rule2","Domain":"test.com","VServerGroupId":"rsp-bp114ni******"}]

要添加的转发规则。一次请求中,最多可添加10条转发规则。每条转发规则包含以下参数:

  • RuleName(必选):String类型。转发规则名称,长度为1~40个字符,支持字母、数字、短划线(-)、正斜线(/)、半角句号(.)和下划线(_)这些字符。同一个监听内不同规则的名称必须唯一。
  • Domain(可选): String类型。转发规则关联的请求域名,与Url参数至少选择一个。
  • Url(可选):String类型,可选,访问路径,长度限制为1~80个字符,只能使用字母、数字和短划线(-)、正斜线(/)、半角句号(.)、百分号(%)、问号(?)、井号(#)和and(&)这些字符。 URL不能只为正斜线(/),但必须以正斜线(/)开头,与Domain参数至少选择一个。
  • VServerGroupId(必选):String类型。该转发规则的目标虚拟服务器组ID。
说明 DomainUrl两者必须指定一个,也可以同时指定。DomainUrl的组合在同一个监听内必须唯一。
ListenerProtocol String https

负载均衡实例前端使用的协议。

说明 相同端口存在不同协议监听时,此字段必选。

返回数据

名称 类型 示例值 描述
Rules Array of Rule

转发规则列表。

Rule
RuleId String rule-bp12jzy0*****

转发规则ID。

RuleName String Rule2

转发规则名称。

RequestId String 9DEC9C28-AB05-4DDF-9A78-6B08EC9CE18C

请求ID。

示例

请求示例

http(s)://[Endpoint]/?Action=CreateRules
&ListenerPort=443
&LoadBalancerId=lb-bp1ca0zt07t934w******
&RegionId=cn-hangzhou
&RuleList=[{"RuleName":"Rule2","Domain":"test.com","VServerGroupId":"rsp-bp114ni******"}]
&<公共请求参数>

正常返回示例

XML格式

<CreateRulesResponse>
	  <RequestId>D63E42FB-F963-4EE5-9B32-05602BF351F3</RequestId>
	  <Rules>
		    <Rule>
			      <RuleId>rule-bp12jzy******</RuleId>
			      <RuleName>Rule3</RuleName>
		    </Rule>
	  </Rules>
</CreateRulesResponse>

JSON格式

{
    "RequestId": "D63E42FB-F963-4EE5-9B32-05602BF351F3", 
    "Rules": {
        "Rule": [
            {
                "RuleId": "rule-bp12jzy******", 
                "RuleName": "Rule3"
            }
        ]
    }
}

错误码

HttpCode 错误码 错误信息 描述
400 DomainExist rule with same domain and url already exists in specified vip 监听中已经存在了相同的域名和URL的规则。
400 OperationFailed.ListenerStatusNotSupport The status of the listener does not support this operation. Please try again later. 监听当前的状态不支持此操作,请稍后重试。

访问错误中心查看更多错误码。