Can be used in a VPC environment.
Summary
Search list of rules registered in the load balancer listener.
Request
Request Parameters
| Parameter name |
Requirement status |
Type |
Restrictions |
Description |
| regionCode |
No |
String |
|
Region code
- You can decide the region of load balancer instances where the list of rules will be searched.
- You can obtain the regionCode through the getRegionList action.
- Default: Select the first region of the getRegionList search results |
| loadBalancerListenerNo |
Yes |
String |
|
The load balancer listener number to search the list of rules
- You can obtain the loadBalancerListenerNo through the getLoadBalancerListenerList action. |
| responseFormatType |
No |
String |
|
Format type of the response results
- Options : xml | json
- Default : xml |
Response
Response data type
- LoadBalancerRuleList type
| 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; |
Example
Request example
ncloud vloadbalancer getLoadBalancerRuleList --regionCode KR --loadBalancerListenerNo ***961
Response example
<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>