getVpcPeeringInstanceList

VPC環境で利用できます。

指定した条件に基づいて VPC Peeringインスタンスリストを照会します。

構文

getVpcPeeringInstanceList構文は次の通りです。

./ncloud vpc getVpcPeeringInstanceList \
    [--vpcPeeringInstanceNoList <vpc-peering-instance-no-list>] \
    [--sourceVpcName <source-vpc-name>] \
    [--targetVpcName <target-vpc-name>] \
    [--vpcPeeringName <vpc-peering-name>] \
    [--vpcPeeringInstanceStatusCode <INIT|RUN|TERMTING>] \
    [--sortedBy <vpcPeeringName|sourceVpcName|targetVpcName>] \
    [--sortingOrder <ASC|DESC>] \
    [--pageNo <page-no>] \
    [--pageSize <page-size>] \
    [--regionCode <KR|SGN|JPN>] \
    [--output <json|xml>]

オプション

getVpcPeeringInstanceListの実行時に指定できるオプションについて説明します。

必須オプション

getVpcPeeringInstanceListの必須オプションです。

オプション	タイプ	必須の有無	説明
`--pageSize`	Integer	Conditional	ページごとに表示する結果数 `pageNo`入力時、必ず入力 `pageNo`、`pageSize`を利用して結果値をページング処理

任意オプション

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

オプション	タイプ	必須の有無	説明
`--vpcPeeringInstanceNoList`	List	Optional	VPC Peeringインスタンス番号スペースで区切って複数入力可能 (例: `--vpcPeeringInstanceNoList 1234 2345`)
`--sourceVpcName`	String	Optional	Peeringをリクエストした VPCの名前
`--targetVpcName`	String	Optional	Peeringを承認した VPCの名前
`--vpcPeeringName`	String	Optional	VPC Peeringの名前
`--vpcPeeringInstanceStatusCode`	String	Optional	VPC Peeringインスタンスの状態コード `INIT` \| `RUN` \| `TERMTING` `INIT`: 承認待機中 `RUN`: 運用中 `TERMTING`: 終了中
`--sortedBy`	String	Optional	照会結果のソート基準 `vpcPeeringName` \| `sourceVpcName` \| `targetVpcName` `vpcPeeringName`: VPC Peering名 `sourceVpcName`: リクエスト VPC名 `targetVpcName`: 承認 VPC名
`--sortingOrder`	String	Optional	`sortedBy`利用時の昇順または降順のソートを設定 `ASC` (デフォルト) \| `DESC` `ASC`: 昇順 `DESC`: 降順
`--pageNo`	Integer	Optional	ページングされた結果のページ番号 `pageNo`、`pageSize`を利用して結果値をページング処理

共通オプション

vpcコマンドで共通して使用するオプションについては、VPCのオプションをご参照ください。

例

VPC Peeringインスタンスリストの照会リクエストが成功すると、各 VPC Peeringインスタンスの構成情報が返されます。

コマンド

コマンドの例は次の通りです。

./ncloud vpc getVpcPeeringInstanceList \
    --vpcPeeringInstanceNoList 67890123 67890124 \
    --sourceVpcName test-vpc-01 \
    --targetVpcName test-vpc-02 \
    --vpcPeeringName test-peering \
    --vpcPeeringInstanceStatusCode RUN \
    --sortedBy vpcPeeringName \
    --sortingOrder ASC \
    --pageNo 0 \
    --pageSize 10 \
    --regionCode KR \
    --output json

出力

出力の例は次の通りです。

{
  "getVpcPeeringInstanceListResponse": {
    "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": "VPC peering example",
        "hasReverseVpcPeering": false,
        "isBetweenAccounts": true,
        "reverseVpcPeeringInstanceNo": ""
      }
    ],
    "requestId": "b2c3d4e5-f6a7-8901-bcde-f23456789012",
    "returnCode": "0",
    "returnMessage": "success"
  }
}