---
title: "setVpcPeeringDescription"
slug: "networking-vpc-vpcpeering-setvpcpeeringdescription"
tags: ["VPC", "VPC Peering"]
updated: 2026-09-17T09:16:52Z
published: 2026-09-17T09:16:52Z
canonical: "api.ncloud-docs.com/networking-vpc-vpcpeering-setvpcpeeringdescription"
---

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

# setVpcPeeringDescription

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

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

## 요청

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

| 메서드 | URI |
| --- | --- |
| GET \| POST | /vpc/v2/setVpcPeeringDescription |

참고

가이드는 GET 방식 기준으로 안내합니다. POST 방식의 호출 테스트는 네이버 클라우드 플랫폼 콘솔의 API Gateway 서비스에서 Swagger를 통해서 가능합니다.

### 요청 헤더

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

### 요청 쿼리 파라미터

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

| 필드 | 타입 | 필수 여부 | 설명 |
| --- | --- | --- | --- |
| `regionCode` | String | Optional | 설명을 수정하려는 VPC Peering 인스턴스의 리전 코드 - 조회 결과의 첫 번째 리전(기본값) - [getRegionList](/docs/compute-vserver-server-common-getregionlist) 참조 |
| `vpcPeeringInstanceNo` | String | Required | 설명을 수정하려는 VPC Peering 인스턴스 번호 - [getVpcPeeringInstanceList](/docs/networking-vpc-vpcpeering-getvpcpeeringinstancelist) 참조 |
| `vpcPeeringDescription` | String | Optional | 수정하려는 VPC Peering에 대한 설명(Byte) - 0~1000 |
| `responseFormatType` | String | Optional | 응답 결과의 형식 - `xml` (기본값) \| `json` |

### 요청 예시

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

```
curl --location 'https://ncloud.apigw.ntruss.com/vpc/v2/setVpcPeeringDescription
?regionCode=KR
&vpcPeeringInstanceNo=***6212
&vpcPeeringDescription=test-description' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'
```

## 응답

응답 형식을 설명합니다.

### 응답 바디

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

### 응답 상태 코드

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

### 응답 예시

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

```
<setVpcPeeringDescriptionResponse>
  <requestId>714c5071-50d0-48ea-8e4f-e449009036d2</requestId>
  <returnCode>0</returnCode>
  <returnMessage>success</returnMessage>
  <totalRows>1</totalRows>
  <vpcPeeringInstanceList>
    <vpcPeeringInstance>
      <vpcPeeringInstanceNo>***6212</vpcPeeringInstanceNo>
      <vpcPeeringName>test-***</vpcPeeringName>
      <regionCode>KR</regionCode>
      <createDate>2020-08-04T14:57:08+0900</createDate>
      <lastModifyDate>2020-08-04T14:57:08+0900</lastModifyDate>
      <vpcPeeringInstanceStatus>
        <code>RUN</code>
        <codeName>run</codeName>
      </vpcPeeringInstanceStatus>
      <vpcPeeringInstanceStatusName>Running</vpcPeeringInstanceStatusName>
      <vpcPeeringInstanceOperation>
        <code>NULL</code>
        <codeName>NULL OP</codeName>
      </vpcPeeringInstanceOperation>
      <sourceVpcNo>***05</sourceVpcNo>
      <sourceVpcName>test-***</sourceVpcName>
      <sourceVpcIpv4CidrBlock>***.**1.0.0/16</sourceVpcIpv4CidrBlock>
      <sourceVpcLoginId>test-***@naver.com</sourceVpcLoginId>
      <targetVpcNo>***06</targetVpcNo>
      <targetVpcName>test-***</targetVpcName>
      <targetVpcIpv4CidrBlock>***.**2.0.0/16</targetVpcIpv4CidrBlock>
      <targetVpcLoginId>test-***@naver.com</targetVpcLoginId>
      <vpcPeeringDescription>test-description</vpcPeeringDescription>
      <hasReverseVpcPeering>false</hasReverseVpcPeering>
      <isBetweenAccounts>false</isBetweenAccounts>
      <reverseVpcPeeringInstanceNo></reverseVpcPeeringInstanceNo>
    </vpcPeeringInstance>
  </vpcPeeringInstanceList>
</setVpcPeeringDescriptionResponse>
```