changeTargetGroupConfiguration

Article summary

Did you find this summary helpful?

Thank you for your feedback

Can be used in a VPC environment.

Summary

Change target group settings.

Request

Request Parameters

Parameter name	Requirement status	Type	Description
regionCode	No	String	Region code You can decide the region of a target group where the settings will be changed. You can obtain the regionCode through the getRegionList action. Default: Select the first region of the getRegionList search results
targetGroupNo	Yes	String	The target group number to change settings You can obtain the targetGroupNo through the getTargetGroupList action.
useStickySession	Conditional	Boolean	Access by session usage status It is available only if the selected target group type is either TCP, HTTP, or HTTPS. Options : true \| false
useProxyProtocol	Conditional	Boolean	Proxy protocol usage status It is available only if the selected target group type is PROXY_TCP. Options : true \| false
algorithmTypeCode	Conditional	String	Algorithm type code You can change the algorithm type to use for load balancing. Options : `RR (Round Robin)` `SIPHS (Source IP Hash)` `LC (Least Connection)` `MH (Maglev Hash)` The algorithm type that can be set is limited depending on the selected target group type. `PROXY_TCP / HTTP / HTTPS : RR / SIPHS / LC` `TCP : MH / RR`
responseFormatType	No	String	Format type of the response results Options : xml \| json Default : xml

Response

Response data type

TargetGroupList type

TargetGroupList extends CommonResponse
private Integer totalRows;
private List targetGroupList = new ArrayList<>();

TargetGroup
private String targetGroupNo;
private String targetGroupName;
private CommonCode targetType;
private String vpcNo;
private CommonCode targetGroupProtocolType;
private Integer targetGroupPort;
private String targetGroupDescription;
private Boolean useStickySession;
private Boolean useProxyProtocol;
private CommonCode algorithmType;
private Date createDate;
private String regionCode;
private String loadBalancerInstanceNo;
private CommonCode healthCheckProtocolType;
private Integer healthCheckPort;
private String healthCheckUrlPath;
private CommonCode healthCheckHttpMethodType;
private Integer healthCheckCycle;
private Integer healthCheckUpThreshold;
private Integer healthCheckDownThreshold;
private TargetNoList targetNoList;

TargetNoList
private List targetNoList = new ArrayList<>();

Example

Request example

ncloud vloadbalancer changeTargetGroupConfiguration --regionCode KR --targetGroupNo ***095 --useStickySession false --algorithmTypeCode RR

Response example

<changeTargetGroupConfigurationResponse>
  <requestId>b644e5ed-6ca8-48d5-9b7f-2a3549ef3c96</requestId>
  <returnCode>0</returnCode>
  <returnMessage>success</returnMessage>
  <totalRows>1</totalRows>
  <targetGroupList>
    <targetGroup>
      <targetGroupNo>***095</targetGroupNo>
      <targetGroupName>test-***</targetGroupName>
      <targetType>
        <code>VSVR</code>
        <codeName>Server (VPC)</codeName>
      </targetType>
      <vpcNo>***04</vpcNo>
      <targetGroupProtocolType>
        <code>HTTP</code>
        <codeName>HTTP protocol</codeName>
      </targetGroupProtocolType>
      <targetGroupPort>80</targetGroupPort>
      <targetGroupDescription></targetGroupDescription>
      <useStickySession>false</useStickySession>
      <useProxyProtocol>false</useProxyProtocol>
      <algorithmType>
        <code>RR</code>
        <codeName>Round Robin</codeName>
      </algorithmType>
      <createDate>2020-12-17T21:06:45+0900</createDate>
      <regionCode>KR</regionCode>
      <loadBalancerInstanceNo></loadBalancerInstanceNo>
      <healthCheckProtocolType>
        <code>HTTP</code>
        <codeName>HTTP protocol</codeName>
      </healthCheckProtocolType>
      <healthCheckPort>80</healthCheckPort>
      <healthCheckUrlPath>/</healthCheckUrlPath>
      <healthCheckHttpMethodType>
        <code>GET</code>
        <codeName>get</codeName>
      </healthCheckHttpMethodType>
      <healthCheckCycle>30</healthCheckCycle>
      <healthCheckUpThreshold>2</healthCheckUpThreshold>
      <healthCheckDownThreshold>2</healthCheckDownThreshold>
      <targetNoList/>
    </targetGroup>
  </targetGroupList>
</changeTargetGroupConfigurationResponse>

Was this article helpful?

What's Next

changeTargetGroupHealthCheckConfiguration

Table of contents

Summary
Request
Response
Example