---
title: "setLoadBalancerDescription"
slug: "networking-vloadbalancer-loadbalancer-setloadbalancerdescription"
updated: 2026-09-17T10:12:33Z
published: 2026-09-17T10:12:33Z
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

Available in VPC

Edit load balancer description.

## Request

The following describes the request format for the endpoint. The request format is as follows:

| Method | URI |
| --- | --- |
| GET | /vloadbalancer/v2/setLoadBalancerDescription |

### Request headers

For information about the headers common to all Load Balancer APIs, see [Load Balancer request headers](/docs/en/networking-vloadbalancer#%EC%9A%94%EC%B2%AD%ED%97%A4%EB%8D%94).

### Request query parameters

You can use the following query parameters with your request:

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `regionCode` | String | Optional | Region code for the load balancer instance whose description you want to edit - First Region of the getRegionList search result (default) - See [getRegionList](/docs/en/compute-vserver-server-common-getregionlist) |
| `loadBalancerInstanceNo` | String | Required | Number of the load balancer instance - See [getLoadBalancerInstanceList](/docs/en/networking-vloadbalancer-loadbalancer-getloadbalancerinstancelist) |
| `loadBalancerDescription` | String | Optional | Load balancer description (byte) - 0 - 1000 |
| `responseFormatType` | String | Optional | Response result format - `xml` (default) \| `json` |

### Request example

The following is a sample request.

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

## Response

The following describes the response format.

### Response body

See [LoadBalancerInstanceList](/docs/en/common-vapidatatype-loadbalancerinstancelist) for the response body.

### Response status codes

For information about the HTTP status codes common to all Load Balancer APIs, see [Load Balancer response status codes](/docs/en/networking-vloadbalancer#%EC%9D%91%EB%8B%B5%EC%83%81%ED%83%9C%EC%BD%94%EB%93%9C).

### Response example

The following is a sample response.

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