changeTargetGroupHealthCheckConfiguration

Prev Next

Can be used in a VPC environment.

Summary

Change target group's health check settings.

Request

Request Parameters

Parameter name Requirement status Type Restrictions Description
regionCode No String Region code
You can decide the region of a target group where the health check 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 the health check settings
You can obtain the targetGroupNo through the getTargetGroupList action.
healthCheckPort Conditional Integer Min : 1, Max : 65534 Health check port
You can edit the port to use for the health check.
healthCheckUrlPath Conditional String Health check URL path
You can change the URL path to use for the health check.
You can change it only if the selected target group's health check protocol type is either HTTP or HTTPS.
Enter the URL path starting with /.
healthCheckHttpMethodTypeCode Conditional String Health check HTTP Method type code
You can change the HTTP Method to use for the health check.
You can change it only if the selected target group's health check protocol type is either HTTP or HTTPS.
Options : HEAD | GET
healthCheckCycle Conditional Integer Min: 5, Max: 300 seconds Health check interval
You can change the health check interval.
healthCheckUpThreshold Conditional Integer Min : 2, Max : 10 Health check normal threshold
You can change the number of successful continuous status checks required before the health check is considered normal.
healthCheckDownThreshold Conditional Integer Min : 2, Max : 10 Health check failure threshold
You can change the number of failed continuous status checks required before the health check is considered failure.
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 changeTargetGroupHealthCheckConfiguration --regionCode KR --targetGroupNo ***095 --healthCheckPort 80 --healthCheckUrlPath "/" --healthCheckHttpMethodTypeCode GET --healthCheckCycle 30 --healthCheckUpThreshold 2 --healthCheckDownThreshold 2

Response example

<changeTargetGroupHealthCheckConfigurationResponse>
  <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>
</changeTargetGroupHealthCheckConfigurationResponse>