setTargetGroupDescription
    • PDF

    setTargetGroupDescription

    • PDF

    Article Summary

    Can be used in a VPC environment.

    Summary

    Edit the target group description.

    Request

    Request Parameters

    Parameter nameRequirement statusTypeRestrictionsDescription
    regionCodeNoStringRegion code
    You can decide the region of a target group where the description will be edited.
    You can obtain the regionCode through the getRegionList action.
    Default: Select the first region of the getRegionList search results
    targetGroupNoYesStringTarget group number
    You can obtain the targetGroupNo through the getTargetGroupList action.
    targetGroupDescriptionNoStringMin : 0, Max : 1000 BytesDescription about the target group to edit
    responseFormatTypeNoStringFormat type of the response results
    Options : xml | json
    Default : xml

    Response

    Response body

    Example

    Request example

    GET {API_URL}/setTargetGroupDescription
    ?regionCode=KR
    &targetGroupNo=***095
    &targetGroupDescription=test-description
    

    Response example

    <setTargetGroupDescriptionResponse>
      <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>test-description</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>
    </setTargetGroupDescriptionResponse>
    

    Was this article helpful?

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.