getLoadBalancerRuleList

Prev Next

VPC 환경에서 이용 가능합니다.

로드 밸런서 리스너에 등록된 규칙 목록을 조회합니다.

요청

요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

메서드 URI
GET /vloadbalancer/v2/getLoadBalancerRuleList

요청 헤더

Load Balancer API에서 공통으로 사용하는 헤더에 대한 정보는 Load Balancer 요청 헤더를 참조해 주십시오.

요청 쿼리 파라미터

요청 쿼리 파라미터에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
regionCode String Optional 조회하려는 규칙 목록이 등록된 로드 밸런서 리스너의 리전 코드
  • getRegionList 조회 결과의 첫 번째 리전(기본값)
  • getRegionList 참조
loadBalancerListenerNo String Required 로드 밸런서 리스너의 번호
responseFormatType String Optional 응답 결과의 형식
  • xml (기본값) | json

요청 예시

요청 예시는 다음과 같습니다.

curl --location 'https://ncloud.apigw.gov-ntruss.com/vloadbalancer/v2/getLoadBalancerRuleList?regionCode=KR&loadBalancerListenerNo=******' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

응답

응답 형식을 설명합니다.

응답 바디

응답 바디는 LoadBalancerRuleList를 참조해 주십시오.

응답 상태 코드

Load Balancer API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Load Balancer 응답 상태 코드를 참조해 주십시오.

응답 예시

응답 예시는 다음과 같습니다.

<getLoadBalancerRuleListResponse>
    <requestId>76f1860a-da5f-4673-8999-3d550cdaee6e</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    <totalRows>1</totalRows>
    <loadBalancerRuleList>
        <loadBalancerRule>
            <loadBalancerListenerNo>******</loadBalancerListenerNo>
            <loadBalancerRuleNo>******</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>*******</targetGroupNo>
                                <weight>1</weight>
                            </targetGroupWeight>
                        </targetGroupWeightList>
                        <useStickySession>false</useStickySession>
                    </targetGroupAction>
                </loadBalancerRuleAction>
            </loadBalancerRuleActionList>
        </loadBalancerRule>
    </loadBalancerRuleList>
</getLoadBalancerRuleListResponse>