---
title: "setVpcPeeringDescription"
slug: "cli-vpc-vpcpeering-setvpcpeeringdescription"
updated: 2026-09-17T09:16:08Z
published: 2026-09-17T09:16:08Z
canonical: "cli.ncloud-docs.com/cli-vpc-vpcpeering-setvpcpeeringdescription"
---

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

# setVpcPeeringDescription

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

VPC Peering 인스턴스 번호를 지정하여 VPC Peering에 대한 설명을 수정합니다.

## 구문

`setVpcPeeringDescription` 구문은 다음과 같습니다.

```
./ncloud vpc setVpcPeeringDescription \
    --vpcPeeringInstanceNo <vpc-peering-instance-no> \
    [--vpcPeeringDescription <vpc-peering-description>] \
    [--regionCode <KR|SGN|JPN>] \
    [--output <json|xml>]
```

## 옵션

`setVpcPeeringDescription` 실행 시 지정할 수 있는 옵션을 설명합니다.

### 필수 옵션

`setVpcPeeringDescription`의 필수 옵션입니다.

| 옵션 | 타입 | 필수 여부 | 설명 |
| --- | --- | --- | --- |
| `--vpcPeeringInstanceNo` | String | Required | VPC Peering 인스턴스 번호 - [getVpcPeeringInstanceList](/docs/cli-vpc-vpcpeering-getvpcpeeringinstancelist) 참조 |

### 선택 옵션

`setVpcPeeringDescription`의 선택 옵션입니다. 지정하지 않은 옵션에는 기본값이 적용됩니다.

| 옵션 | 타입 | 필수 여부 | 설명 |
| --- | --- | --- | --- |
| `--vpcPeeringDescription` | String | Optional | VPC Peering에 대한 설명 (Byte) - 0~1,000 |

### 공통 옵션

`vpc` 명령에서 공통으로 사용하는 옵션에 대한 정보는 [VPC 옵션](/docs/cli-vpc#%EC%98%B5%EC%85%98)을 참조해 주십시오.

## 예시

VPC Peering 설명 수정 요청이 성공하면 인스턴스의 구성 정보가 반환됩니다.

### 명령

명령 예시는 다음과 같습니다.

```
./ncloud vpc setVpcPeeringDescription \
    --vpcPeeringInstanceNo 67890123 \
    --vpcPeeringDescription "Updated peering description" \
    --regionCode KR \
    --output json
```

### 출력

출력 예시는 다음과 같습니다.

```
{
  "setVpcPeeringDescriptionResponse": {
    "totalRows": 1,
    "vpcPeeringInstanceList": [
      {
        "vpcPeeringInstanceNo": "67890123",
        "vpcPeeringName": "test-peering",
        "regionCode": "KR",
        "createDate": "2026-07-07T16:41:47+0900",
        "lastModifyDate": "2026-07-07T16:41:47+0900",
        "vpcPeeringInstanceStatus": {
          "code": "RUN",
          "codeName": "운영중"
        },
        "vpcPeeringInstanceStatusName": "Running",
        "vpcPeeringInstanceOperation": {
          "code": "NULL",
          "codeName": "NULL OP"
        },
        "sourceVpcNo": "12345678",
        "sourceVpcName": "test-vpc-01",
        "sourceVpcIpv4CidrBlock": "10.0.0.0/16",
        "sourceVpcLoginId": "user@example.com",
        "targetVpcNo": "12345679",
        "targetVpcName": "test-vpc-02",
        "targetVpcIpv4CidrBlock": "172.31.0.0/16",
        "targetVpcLoginId": "user2@example.com",
        "vpcPeeringDescription": "Updated peering description",
        "hasReverseVpcPeering": false,
        "isBetweenAccounts": true,
        "reverseVpcPeeringInstanceNo": ""
      }
    ],
    "requestId": "d4e5f6a7-b8c9-0123-defa-456789012345",
    "returnCode": "0",
    "returnMessage": "success"
  }
}
```