getVpcList

Available in VPC

Get the list of VPCs based on the conditions the user specifies.

Syntax

The getVpcList syntax is as follows:

./ncloud vpc getVpcList \
    [--vpcStatusCode <INIT|CREATING|RUN|TERMTING>] \
    [--vpcName <vpc-name>] \
    [--vpcNoList <vpc-no-list>] \
    [--regionCode <KR|SGN|JPN>] \
    [--output <json|xml>]

Options

This section describes the options available when running getVpcList.

Optional options

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

Options	Type	Required	Description
`--vpcStatusCode`	String	Optional	VPC status code `INIT` \| `CREATING` \| `RUN` \| `TERMTING`
`--vpcName`	String	Optional	VPC name
`--vpcNoList`	List	Optional	VPC number You can enter multiple items separated by spaces (e.g., `--vpcNoList 1234 2345`).

Common options

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

Examples

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

Command

The command example is as follows:

./ncloud vpc getVpcList \
    --vpcStatusCode RUN \
    --vpcNoList 12345678 23456789 \
    --regionCode KR \
    --output json

Output

The output example is as follows:

{
  "getVpcListResponse": {
    "totalRows": 1,
    "vpcList": [
      {
        "vpcNo": "12345678",
        "vpcName": "test-vpc-01",
        "ipv4CidrBlock": "10.0.0.0/16",
        "vpcStatus": {
          "code": "RUN",
          "codeName": "In operation"
        },
        "regionCode": "KR",
        "vpcType": "NORMAL",
        "createDate": "2026-07-07T14:07:27+0900"
      }
    ],
    "requestId": "b2c3d4e5-f6a7-8901-bcde-f23456789012",
    "returnCode": "0",
    "returnMessage": "success"
  }
}