setLoadBalancerDescription

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

개요

로드밸런서의 설명을 수정합니다.

요청

요청 파라미터

파라미터명	필수 여부	타입	제약 사항	설명
regionCode	No	String		- 리전 코드 설명을 수정할 로드밸런서 인스턴스의 리전(Region) 결정 regionCode는 getRegionList 액션을 통해서 획득 Default : getRegionList 조회 결과의 첫 번째 리전을 선택
loadBalancerInstanceNo	Yes	String		- 로드밸런서 인스턴스 번호 loadBalancerInstanceNo는 getLoadBalancerInstanceList 액션을 통해서 획득
loadBalancerDescription	No	String	Min : 0, Max : 1000 Bytes	수정할 로드밸런서에 대한 설명
responseFormatType	No	String		- 응답 결과의 포맷 타입 Options : xml \| json Default : xml

응답

응답 데이터 타입

LoadBalancerInstanceList 타입

LoadBalancerInstanceList extends CommonResponse
private Integer totalRows;
private List loadBalancerInstanceList = new ArrayList<>();

LoadBalancerInstance
private String loadBalancerInstanceNo;
private CommonCode loadBalancerInstanceStatus;
private CommonCode loadBalancerInstanceOperation;
private String loadBalancerInstanceStatusName;
private String loadBalancerDescription;
private Date createDate;
private String loadBalancerName;
private String loadBalancerDomain;
private LoadBalancerIpList loadBalancerIpList;
private CommonCode loadBalancerType;
private CommonCode loadBalancerNetworkType;
private CommonCode throughputType;
private Integer idleTimeout;
private String vpcNo;
private String regionCode;
private SubnetNoList subnetNoList;
private List<LoadBalancerSubnet> loadBalancerSubnetList;
private LoadBalancerListenerNoList loadBalancerListenerNoList;

LoadBalancerIpList
private List loadBalancerIpList = new ArrayList<>();

SubnetNoList
private List subnetNoList = new ArrayList<>();

LoadBalancerSubnet
private String zoneCode;
private String subnetNo;
private String publicIpInstanceNo;

LoadBalancerListenerNoList
private List loadBalancerListenerNoList = new ArrayList<>();

예시

요청 예시

ncloud vloadbalancer setLoadBalancerDescription --regionCode KR --loadBalancerInstanceNo ***887 --loadBalancerDescription test-description

응답 예시

<setLoadBalancerDescriptionResponse>
  <requestId>959a2fe5-fd1b-459a-9af3-df0e51b68e1d</requestId>
  <returnCode>0</returnCode>
  <returnMessage>success</returnMessage>
  <totalRows>1</totalRows>
  <loadBalancerInstanceList>
    <loadBalancerInstance>
      <loadBalancerInstanceNo>***887</loadBalancerInstanceNo>
      <loadBalancerInstanceStatus>
        <code>USED</code>
        <codeName>LB USED state</codeName>
      </loadBalancerInstanceStatus>
      <loadBalancerInstanceOperation>
        <code>NULL</code>
        <codeName>LB NULL OP</codeName>
      </loadBalancerInstanceOperation>
      <loadBalancerInstanceStatusName>Running</loadBalancerInstanceStatusName>
      <loadBalancerDescription>test-description</loadBalancerDescription>
      <createDate>2020-12-20T19:21:02+0900</createDate>
      <loadBalancerName>test-***</loadBalancerName>
      <loadBalancerDomain>test-***-***887-***.com</loadBalancerDomain>
      <loadBalancerIpList>
        <loadBalancerIp>***.***.5.6</loadBalancerIp>
      </loadBalancerIpList>
      <loadBalancerType>
        <code>APPLICATION</code>
        <codeName>Application Load Balancer</codeName>
      </loadBalancerType>
      <loadBalancerNetworkType>
        <code>PRIVATE</code>
        <codeName>Private</codeName>
      </loadBalancerNetworkType>
      <throughputType>
        <code>SMALL</code>
        <codeName>Small</codeName>
      </throughputType>
      <idleTimeout>60</idleTimeout>
      <vpcNo>***04</vpcNo>
      <regionCode>KR</regionCode>
      <subnetNoList>
        <subnetNo>***43</subnetNo>
      </subnetNoList>
      <loadBalancerSubnetList>
        <loadBalancerSubnet>
          <zoneCode>KR-1</zoneCode>
          <subnetNo>***43</subnetNo>
          <publicIpInstanceNo/>
        </loadBalancerSubnet>
      </loadBalancerSubnetList>
      <loadBalancerListenerNoList>
        <loadBalancerListenerNo>***961</loadBalancerListenerNo>
      </loadBalancerListenerNoList>
    </loadBalancerInstance>
  </loadBalancerInstanceList>
</setLoadBalancerDescriptionResponse>