---
title: "setTargetGroupDescription"
slug: "networking-vloadbalancer-targetgroup-settargetgroupdescription"
updated: 2026-09-17T09:58:20Z
published: 2026-09-17T09:58:20Z
canonical: "api.ncloud-docs.com/networking-vloadbalancer-targetgroup-settargetgroupdescription"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://api.ncloud-docs.com/llms.txt
> Use this file to discover all available pages before exploring further.

# setTargetGroupDescription

VPC環境で利用できます。

ターゲットグループの説明を変更します。

## リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

| メソッド | URI |
| --- | --- |
| GET | /vloadbalancer/v2/setTargetGroupDescription |

### リクエストヘッダ

Load Balancer APIで共通して使用されるヘッダの詳細は、[Load Balancerのリクエストヘッダ](/docs/ja/networking-vloadbalancer#%EC%9A%94%EC%B2%AD%ED%97%A4%EB%8D%94)をご参照ください。

### リクエストクエリパラメータ

リクエストクエリパラメータの説明は次の通りです。

| フィールド | タイプ | 必須の有無 | 説明 |
| --- | --- | --- | --- |
| `regionCode` | String | Optional | 説明を変更する対象ターゲットグループのリージョンコード - getRegionList照会結果の最初のリージョン(デフォルト) - [getRegionList](/docs/ja/compute-vserver-server-common-getregionlist)を参照 |
| `targetGroupNo` | String | Required | ターゲットグループの番号 - [getTargetGroupList](/docs/ja/networking-vloadbalancer-targetgroup-gettargetgrouplist)を参照 |
| `targetGroupDescription` | String | Optional | ターゲットタイプの説明(Byte) - 0~1,000 |
| `responseFormatType` | String | Optional | レスポンス結果の形式 - `xml`(デフォルト) \| `json` |

### リクエスト例

リクエストのサンプルコードは次の通りです。

```
curl --location 'https://ncloud.apigw.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](/docs/ja/common-vapidatatype-targetgrouplist)をご参照ください。

### レスポンスステータスコード

Load Balancer APIで共通して使用されるレスポンスステータスコードの詳細は、[Load Balancerのレスポンスステータスコード](/docs/ja/networking-vloadbalancer#%EC%9D%91%EB%8B%B5%EC%83%81%ED%83%9C%EC%BD%94%EB%93%9C)をご参照ください。

### レスポンス例

レスポンスのサンプルコードは次の通りです。

```
<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>
```