文档

CreateRules - 为HTTP或HTTPS监听添加转发规则

更新时间:

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

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
slb:CreateRulesWrite
  • loadbalancer
    acs:slb:{#regionId}:{#accountId}:loadbalancer/{#loadbalancerId}
  • slb:tag

请求参数

名称类型必填描述示例值
RegionIdstring

负载均衡实例的地域 ID。

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

cn-hangzhou
LoadBalancerIdstring

负载均衡实例 ID。

lb-bp1ca0zt07t934w******
ListenerPortinteger

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

取值范围:1~65535

443
ListenerProtocolstring

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

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

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

  • RuleName(必选):String 类型。转发规则名称,长度为 1~40 个字符,支持字母、数字、短划线(-)、正斜线(/)、半角句号(.)和下划线(_)这些字符。同一个监听内不同规则的名称必须唯一。

  • Domain(可选): String 类型。转发规则关联的请求域名,与 Url 参数至少选择一个。

  • Url(可选):String 类型,可选,访问路径,长度限制为 1~80 个字符,只能使用字母、数字和短划线(-)、正斜线(/)、半角句号(.)、百分号(%)、问号(?)、井号(#)和 and(&)这些字符。 URL 不能只为正斜线(/),但必须以正斜线(/)开头,与 Domain 参数至少选择一个。

  • VServerGroupId(必选):String 类型。该转发规则的目标虚拟服务器组 ID。

说明 DomainUrl两者必须指定一个,也可以同时指定。DomainUrl的组合在同一个监听内必须唯一。
[{"RuleName":"Rule2","Domain":"test.com","VServerGroupId":"rsp-bp114ni******"}]

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

9DEC9C28-AB05-4DDF-9A78-6B08EC9CE18C
Rulesobject []

转发规则列表。

RuleNamestring

转发规则名称。

Rule2
RuleIdstring

转发规则 ID。

rule-bp12jzy0*****

示例

正常返回示例

JSON格式

{
  "RequestId": "9DEC9C28-AB05-4DDF-9A78-6B08EC9CE18C",
  "Rules": {
    "Rule": [
      {
        "RuleName": "Rule2",
        "RuleId": "rule-bp12jzy0*****"
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
400InvalidParameterThe specified VServerGroupId does not belong to the LoadBalancerId of the rule.指定的服务器组和当前转发规则不属于同一个负载均衡实例。
400InvalidParameterValue.RegionNotSupportThe region does not support the parameter value, %s.当前地域不支持指定的参数取值。
400TooManyListenersMore than 1 listener is found, please be more specified.检索到的监听数量大于1,请提供更具体的查询条件。
400DomainExistrule with same domain and url already exists in specified vip监听中已经存在了相同的域名和URL的规则。
400OperationFailed.ListenerStatusNotSupportThe status of the listener does not support this operation. Please try again later.操作失败,原因是当前监听正在变配中,请稍后重试。
400OperationFailed.ActionNotSupportThe loadbalancer does not support such action.当前实例不支持该操作。
400MissingParameter.RuleNameThe parameter RuleName is required.参数RuleName缺失。

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