---
title: "setLoadBalancerDescription"
slug: "networking-vloadbalancer-loadbalancer-setloadbalancerdescription"
updated: 2026-09-17T09:16:52Z
published: 2026-09-17T09:16:52Z
canonical: "api.ncloud-docs.com/networking-vloadbalancer-loadbalancer-setloadbalancerdescription"
---

> ## 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.

# setLoadBalancerDescription

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

로드 밸런서의 설명을 수정합니다.

## 요청

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

| 메서드 | URI |
| --- | --- |
| GET | /vloadbalancer/v2/setLoadBalancerDescription |

### 요청 헤더

Load Balancer API에서 공통으로 사용하는 헤더에 대한 정보는 [Load Balancer 요청 헤더](/docs/networking-vloadbalancer#%EC%9A%94%EC%B2%AD%ED%97%A4%EB%8D%94)를 참조해 주십시오.

### 요청 쿼리 파라미터

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

| 필드 | 타입 | 필수 여부 | 설명 |
| --- | --- | --- | --- |
| `regionCode` | String | Optional | 설명을 수정하려는 로드 밸런서 인스턴스의 리전 코드 - getRegionList 조회 결과의 첫 번째 리전(기본값) - [getRegionList](/docs/compute-vserver-server-common-getregionlist) 참조 |
| `loadBalancerInstanceNo` | String | Required | 로드 밸런서 인스턴스의 번호 - [getLoadBalancerInstanceList](/docs/networking-vloadbalancer-loadbalancer-getloadbalancerinstancelist) 참조 |
| `loadBalancerDescription` | String | Optional | 로드 밸런서에 대한 설명(Byte) - 0~1,000 |
| `responseFormatType` | String | Optional | 응답 결과의 형식 - `xml` (기본값) \| `json` |

### 요청 예시

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

```
curl --location 'https://ncloud.apigw.ntruss.com/vloadbalancer/v2/setLoadBalancerDescription?regionCode=KR&loadBalancerInstanceNo=********&loadBalancerDescription=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}'
```

## 응답

응답 형식을 설명합니다.

### 응답 바디

응답 바디는 [LoadBalancerInstanceList](/docs/common-vapidatatype-loadbalancerinstancelist)를 참조해 주십시오.

### 응답 상태 코드

Load Balancer API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 [Load Balancer 응답 상태 코드](/docs/networking-vloadbalancer#%EC%9D%91%EB%8B%B5%EC%83%81%ED%83%9C%EC%BD%94%EB%93%9C)를 참조해 주십시오.

### 응답 예시

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

```
<changeLoadBalancerInstanceConfigurationResponse>
    <requestId>133b0622-dd59-4026-ae42-bfbc08e98fae</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    <totalRows>1</totalRows>
    <loadBalancerInstanceList>
        <loadBalancerInstance>
            <loadBalancerInstanceNo>********</loadBalancerInstanceNo>
            <loadBalancerInstanceStatus>
                <code>USED</code>
                <codeName>LB USED state</codeName>
            </loadBalancerInstanceStatus>
            <loadBalancerInstanceOperation>
                <code>NULL</code>
                <codeName>LB NULL OP</codeName>
            </loadBalancerInstanceOperation>
            <loadBalancerInstanceStatusName>Running</loadBalancerInstanceStatusName>
            <loadBalancerDescription>YOUR_DESCRIPTION</loadBalancerDescription>
            <createDate>2024-06-03T17:09:52+0900</createDate>
            <loadBalancerName>YOUR_LOAD_BALANCER</loadBalancerName>
            <loadBalancerDomain>***.com</loadBalancerDomain>
            <loadBalancerIpList>
                <loadBalancerIp>**.*.*.*</loadBalancerIp>
            </loadBalancerIpList>
            <loadBalancerType>
                <code>APPLICATION</code>
                <codeName>Application Load Balancer</codeName>
            </loadBalancerType>
            <loadBalancerNetworkType>
                <code>PRIVATE</code>
                <codeName>Private</codeName>
            </loadBalancerNetworkType>
            <throughputType>
                <code>SMALL</code>
                <codeName>Small</codeName>
            </throughputType>
            <idleTimeout>60</idleTimeout>
            <vpcNo>*****</vpcNo>
            <regionCode>KR</regionCode>
            <subnetNoList>
                <subnetNo>******</subnetNo>
            </subnetNoList>
            <loadBalancerSubnetList>
                <loadBalancerSubnet>
                    <zoneCode>KR-1</zoneCode>
                    <subnetNo>******</subnetNo>
                    <publicIpInstanceNo></publicIpInstanceNo>
                </loadBalancerSubnet>
            </loadBalancerSubnetList>
            <loadBalancerListenerNoList>
                <loadBalancerListenerNo>******</loadBalancerListenerNo>
            </loadBalancerListenerNoList>
        </loadBalancerInstance>
    </loadBalancerInstanceList>
</changeLoadBalancerInstanceConfigurationResponse>
```