getLoadBalancerRuleList

Prev Next

VPC環境で利用できます。

概要

ロードバランサリスナーに登録されたルールリストを照会します。

リクエスト

リクエストパラメータ

パラメータ名 必須有無 タイプ 制約事項 説明
regionCode No String リージョンコード
ルールリストが照会されるロードバランサインスタンスのリージョン(Region)を決定できます。
regionCodeはgetRegionListアクションを通じて取得できます。
Default:getRegionList照会結果の最初のリージョンを選択
loadBalancerListenerNo Yes String ルールリストを照会するロードバランサリスナー番号
loadBalancerListenerNoはgetLoadBalancerListenerListアクションを通じて取得できます。
responseFormatType No String レスポンス結果のフォーマットタイプ
Options : xml | json
Default : xml

レスポンス

レスポンスデータのタイプ

  • LoadBalancerRuleListタイプ
LoadBalancerRuleList extends CommonResponse
private Integer totalRows;
private List loadBalancerRuleList = new ArrayList<>();
LoadBalancerRule
private String loadBalancerListenerNo;
private String loadBalancerRuleNo;
private Integer priority;
private List loadBalancerRuleConditionList;
private List loadBalancerRuleActionList;
LoadBalancerRuleCondition
private CommonCode ruleConditionType;
private HostHeaderCondition hostHeaderCondition;
private PathPatternCondition pathPatternCondition;
HostHeaderCondition
private HostHeaderList hostHeaderList;
HostHeaderList
private List hostHeaderList = new ArrayList<>();
PathPatternCondition
private PathPatternList pathPatternList;
PathPatternList
private List pathPatternList = new ArrayList<>();
LoadBalancerRuleAction
private CommonCode ruleActionType;
private TargetGroupAction targetGroupAction;
private RedirectionAction redirectionAction;
TargetGroupAction
private List targetGroupWeightList;
private Boolean useStickySession;
TargetGroupWeight
private String targetGroupNo;
private Integer weight;
RedirectionAction
private String protocol;
private String port;
private String host;
private String path;
private String query;
private String statusCode;

リクエスト例

ncloud vloadbalancer getLoadBalancerRuleList --regionCode KR --loadBalancerListenerNo ***961

レスポンス例

<getLoadBalancerRuleListResponse>
  <requestId>884a2d69-3fd2-4237-8ae9-b9bce9fc98d4</requestId>
  <returnCode>0</returnCode>
  <returnMessage>success</returnMessage>
  <totalRows>1</totalRows>
  <loadBalancerRuleList>
    <loadBalancerRule>
      <loadBalancerListenerNo>***961</loadBalancerListenerNo>
      <loadBalancerRuleNo>***444</loadBalancerRuleNo>
      <priority>10000</priority>
      <loadBalancerRuleConditionList>
        <loadBalancerRuleCondition>
          <ruleConditionType>
            <code>DEFAULT</code>
            <codeName>Default condition</codeName>
          </ruleConditionType>
        </loadBalancerRuleCondition>
      </loadBalancerRuleConditionList>
      <loadBalancerRuleActionList>
        <loadBalancerRuleAction>
          <ruleActionType>
            <code>TARGET_GROUP</code>
            <codeName>Target Group action</codeName>
          </ruleActionType>
          <targetGroupAction>
            <targetGroupWeightList>
              <targetGroupWeight>
                <targetGroupNo>***095</targetGroupNo>
                <weight>1</weight>
              </targetGroupWeight>
            </targetGroupWeightList>
            <useStickySession>false</useStickySession>
          </targetGroupAction>
        </loadBalancerRuleAction>
      </loadBalancerRuleActionList>
    </loadBalancerRule>
  </loadBalancerRuleList>
</getLoadBalancerRuleListResponse>