---
title: "setVpcPeeringDescription"
slug: "cli-vpc-vpcpeering-setvpcpeeringdescription"
updated: 2026-10-08T09:53:28Z
published: 2026-10-08T09:53:28Z
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/ja/cli-vpc-vpcpeering-getvpcpeeringinstancelist)を参照 |

### 任意オプション

`setVpcPeeringDescription`の任意オプションです。指定しない場合、オプションにはデフォルト値が適用されます。

| オプション | タイプ | 必須の有無 | 説明 |
| --- | --- | --- | --- |
| `--vpcPeeringDescription` | String | Optional | VPC Peeringの説明 (Byte) - 0~1,000 |

### 共通オプション

`vpc`コマンドで共通して使用するオプションについては、[VPCのオプション](/docs/ja/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"
  }
}
```