setTargetGroupDescription

VPC 환경에서 이용 가능합니다.

타깃 그룹의 설명을 수정합니다.

요청

요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

메서드	URI
GET	/setTargetGroupDescription

요청 헤더

Load Balancer API에서 공통으로 사용하는 헤더에 대한 자세한 내용은 Load Balancer 공통 헤더를 참조해 주십시오.

요청 쿼리 파라미터

파라미터에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`regionCode`	String	Optional	설명을 수정하려는 타깃 그룹의 리전 코드 getRegionList 조회 결과의 첫 번째 리전(기본값) getRegionList를 통해 확인
`targetGroupNo`	String	Required	타깃 그룹의 번호 getTargetGroupList를 통해 확인
`targetGroupDescription`	String	Optional	타깃 그룹에 대한 설명(Byte) 0~1,000
`responseFormatType`	String	Optional	응답 결과의 형식 `xml` (기본값) \| `json`

요청 예시

요청 예시는 다음과 같습니다.

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

응답

응답 형식을 설명합니다.

응답 바디

응답 바디는 TargetGroupList를 참조해 주십시오.

응답 상태 코드

네이버 클라우드 플랫폼에서 공통으로 사용하는 응답 상태 코드에 대한 자세한 내용은 Ncloud API 응답 상태 코드를 참조해 주십시오.

응답 예시

응답 예시는 다음과 같습니다.

<setTargetGroupDescriptionResponse>
    <requestId>ead95ec5-8357-4f5e-8382-d103bd34c35a</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    <totalRows>1</totalRows>
    <targetGroupList>
        <targetGroup>
            <targetGroupNo>*******</targetGroupNo>
            <targetGroupName>YOUR_TARGET_GROUP</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>YOUR_DESCRIPTION</targetGroupDescription>
            <useStickySession>false</useStickySession>
            <useProxyProtocol>false</useProxyProtocol>
            <algorithmType>
                <code>RR</code>
                <codeName>Round Robin</codeName>
            </algorithmType>
            <createDate>2024-06-06T10:05:33+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>
</setTargetGroupDescriptionResponse>