changeTargetGroupHealthCheckConfiguration

Prev Next

Available in VPC

Change target group's health check settings.

Request

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

Method URI
GET /changeTargetGroupHealthCheckConfiguration

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 health check settings you want to change
  • First Region of the getRegionList search result (default)
  • Check through getRegionList
targetGroupNo String Required Target group number
healthCheckPort Integer Conditional Port used by the load balancer when performing health checks to determine the health of the target
  • 1 - 65534 (default: 80)
healthCheckUrlPath String Conditional URL path to use when performing health checks
  • Enter the URL path starting with /
  • It can be changed if the target group's health check protocol type is HTTP or HTTPS
healthCheckHttpMethodTypeCode String Conditional HTTP method type to use for health checks
  • HEAD | GET
  • It can be changed if the selected target group's health check protocol type is HTTP or HTTPS
healthCheckCycle Integer Conditional Health check interval (seconds)
  • 5 - 300
healthCheckUpThreshold Integer Conditional Number of consecutive successful health checks required to determine that the target health is normal
  • 2 - 10
healthCheckDownThreshold Integer Conditional Number of consecutive failed health checks required to determine that the target health is abnormal
  • 2 - 10
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/changeTargetGroupHealthCheckConfiguration
?regionCode=KR
&targetGroupNo=*******
&healthCheckPort=80
&healthCheckUrlPath=/
&healthCheckHttpMethodTypeCode=GET
&healthCheckCycle=30
&healthCheckUpThreshold=2
&healthCheckDownThreshold=2'
--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.

<changeTargetGroupHealthCheckConfigurationResponse>
    <requestId>3a30cb81-63af-4565-b38b-55d01c9f777d</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>
</changeTargetGroupHealthCheckConfigurationResponse>