Skip to Content
负载均衡 ULB ALB描述应用型负载均衡转发规则 - DescribeRules

描述应用型负载均衡转发规则 - DescribeRules

简介

描述一条指定的转发规则或者一个应用型负载均衡监听器下的所有转发规则

💡 默认规则的Weight与target的真实Weight保持同步

定义

公共参数

参数名类型描述信息必填
Actionstring对应的 API 指令名称，当前 API 为 DescribeRulesYes
PublicKeystring用户公钥，可从 控制台  获取Yes
Signaturestring根据公钥及 API 指令生成的用户签名，参见 签名算法Yes

请求参数

参数名类型描述信息必填
Regionstring地域。 参见 地域和可用区列表Yes
ProjectIdstring项目ID。不填写为默认项目，子帐号必须填写。 请参考GetProjectList接口Yes
LoadBalancerIdstring应用型负载均衡实例的IDYes
ListenerIdstring监听器的IDYes
RuleIdstring应用型负载均衡转发规则的ID。指定RuleId，则只描述该规则No

响应字段

字段名类型描述信息必填
RetCodeint返回状态码，为 0 则为成功返回，非 0 为失败Yes
Actionstring操作指令名称Yes
Messagestring返回错误消息，当 RetCode 非 0 时提供详细的描述信息No
Rulesarray[Rule]转发规则信息Yes

数据模型

Rule

字段名类型描述信息必填
RuleIdstring转发规则的IDNo
RuleConditionsarray[RuleCondition]转发规则匹配条件。具体结构详见 RuleConditionNo
RuleActionsarray[RuleAction]转发动作。具体规则详见RuleActionNo
IsDefaultboolean是否为默认转发规则No
Passboolean当转发的服务节点为空时，规则是否忽略No

RuleCondition

字段名类型描述信息必填
Typestring匹配条件类型。限定枚举值：Host，PathYes
HostConfigHostConfigSet域名相关配置。Type为Host时必填。具体结构详见 HostConfigSetNo
PathConfigPathConfigSet路径相关配置。Type为Path时必填。具体结构详见 PathConfigSetNo

RuleAction

字段名类型描述信息必填
Typestring动作类型。限定枚举值：ForwardYes
ForwardConfigForwardConfigSet转发服务节点相关配置。 具体结构详见 ForwardConfigSetNo

ForwardConfigSet

字段名类型描述信息必填
Targetsarray[ForwardTargetSet]转发的后端服务节点。限定在监听器的服务节点池里；数组长度可以为0。具体结构详见 ForwardTargetSetYes

ForwardTargetSet

字段名类型描述信息必填
Idstring服务节点的标识IDYes
Weightint权重。仅监听器负载均衡算法是加权轮询是有效；取值范围[1-100]，默认值为1No

HostConfigSet

字段名类型描述信息必填
Valuesarray[string]取值。暂时只支持数组长度为1； 取值需符合相关匹配方式的条件Yes
MatchModestring匹配方式。限定枚举值：Regular-正则，Wildcard-泛域名； 默认值：RegularNo

PathConfigSet

字段名类型描述信息必填
Valuesarray[string]取值。暂时只支持数组长度为1； 取值需符合相关匹配方式的条件Yes

示例

请求示例

https://api.an-link.com/?Action=DescribeRules
&Region=cn-zj
&ProjectId=AONmKvcb
&LoadBalancerId=cCWlIOts
&ListenerId=NmxHLcXL
&RuleId=vNcPniOK

响应示例

{
  "Action": "DescribeRulesResponse",
  "RetCode": 0,
  "Rules": [
    {
      "IsDefault": true,
      "Pass": false,
      "RuleActions": [
        {
          "ForwardConfig": {},
          "Type": "RmzLzQXc"
        }
      ],
      "RuleConditions": [
        {
          "HostConfig": {},
          "PathConfig": {},
          "Type": "cn-zj"
        }
      ],
      "RuleId": "GHOQYSjh"
    }
  ]
}
描述应用型负载均衡监听器 - DescribeListeners创建传统型负载均衡负载均衡 - CreateULB