getVpcPeeringInstanceList

Available in VPC

Get the list of VPC peering instances based on the specified conditions.

Syntax

The getVpcPeeringInstanceList syntax is as follows:

./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>]

Options

This section describes the options available when running getVpcPeeringInstanceList.

Required options

The following options are required for getVpcPeeringInstanceList.

Options	Type	Required	Description
`--pageSize`	Integer	Conditional	Results to display per page Required when specifying `pageNo`. Uses `pageNo` and `pageSize` to paginate the results.

Optional options

These are the optional options for getVpcPeeringInstanceList. Options that are not specified will use their default values.

Options	Type	Required	Description
`--vpcPeeringInstanceNoList`	List	Optional	VPC peering instance number You can enter multiple items separated by spaces (e.g., `--vpcPeeringInstanceNoList 1234 2345`).
`--sourceVpcName`	String	Optional	Name of the VPC that requested peering
`--targetVpcName`	String	Optional	Name of the VPC that accepted peering
`--vpcPeeringName`	String	Optional	VPC peering name
`--vpcPeeringInstanceStatusCode`	String	Optional	VPC peering instance status code `INIT` \| `RUN` \| `TERMTING` `INIT`: Pending acceptance `RUN`: Running `TERMTING`: Terminating
`--sortedBy`	String	Optional	Sort criteria for query results `vpcPeeringName` \| `sourceVpcName` \| `targetVpcName` `vpcPeeringName`: VPC peering name `sourceVpcName`: Requested VPC name `targetVpcName`: Accepted VPC name
`--sortingOrder`	String	Optional	Sets ascending or descending sort order when using `sortedBy`. `ASC` (default) \| `DESC` `ASC`: Ascending `DESC`: Descending
`--pageNo`	Integer	Optional	Page numbers in paged results Page the result values using `pageNo` and `pageSize`.

Common options

For information about the options common to all vpc subcommands, see VPC options.

Examples

If the request to retrieve the list of VPC peering instances is successful, the configuration information for each VPC peering instance is returned.

Command

The command example is as follows:

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

Output

The output example is as follows:

{
  "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": "In operation"
        },
        "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"
  }
}