changeTargetGroupConfiguration

Prev Next

Available in VPC

Change target group settings.

Request

The following describes the request format for the endpoint. The request format is as follows:

Method URI
GET /changeTargetGroupConfiguration

Request headers

For headers common to all Load Balancer APIs, see Load Balancer common headers.

Request query parameters

The following describes the parameters.

Field Type Required Description
regionCode String Optional Region code for the target group whose settings you want to change
  • First Region of the getRegionList search result (default)
  • Check through getRegionList
targetGroupNo String Required Target group number
useStickySession Boolean Conditional Whether to enable per-session access
  • true | false
  • It can be set if the target group's protocol type is TCP, UDP, HTTP, or HTTPS
useProxyProtocol Boolean Conditional Whether to use proxy protocols
  • true | false
  • It can be set if the target group's protocol type is PROXY_TCP
algorithmTypeCode String Conditional Type of algorithm to use for load balancing
  • RR | SIPHS | LC | MH
    • RR: Round Robin
    • SIPHS: Source IP Hash
    • LC: Least Connection
    • MH: Maglev Hash
  • Protocol type of the target group limits the values you can set
    • HTTP, HTTPS, PROXY_TCP protocol: RR | SIPHS | LC
    • TCP, UDP protocol: RR | MH
responseFormatType String Optional Response result format
  • xml (default) | json

Request example

The following is a sample request.

curl --location 'https://ncloud.apigw.ntruss.com/vloadbalancer/v2/changeTargetGroupConfiguration
?regionCode=KR
&targetGroupNo=*******
&useStickySession=false
&algorithmTypeCode=RR'
--header 'x-ncp-apigw-timestamp: {Timestamp}'
--header 'x-ncp-iam-access-key: {Access Key}'
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

Response

The following describes the response format.

Response body

See TargetGroupList for the response body.

Response status codes

For response status codes common to NAVER Cloud Platform, see Ncloud API response status codes.

Response example

The following is a sample response.

<changeTargetGroupConfigurationResponse>
    <requestId>70f14491-1ab0-4471-8130-2508cd393823</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    <totalRows>1</totalRows>
    <targetGroupList>
        <targetGroup>
            <targetGroupNo>*******</targetGroupNo>
            <targetGroupName>test-*****</targetGroupName>
            <targetType>
                <code>VSVR</code>
                <codeName>Server (VPC)</codeName>
            </targetType>
            <vpcNo>*****</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>2024-06-03T13:30:20+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>HTTP GET Method</codeName>
            </healthCheckHttpMethodType>
            <healthCheckCycle>30</healthCheckCycle>
            <healthCheckUpThreshold>2</healthCheckUpThreshold>
            <healthCheckDownThreshold>2</healthCheckDownThreshold>
            <targetNoList/>
        </targetGroup>
    </targetGroupList>
</changeTargetGroupConfigurationResponse>