getAccessControlGroupList

Available in VPC

Get a list of ACGs.

Syntax

The getAccessControlGroupList syntax is as follows:

./ncloud vserver getAccessControlGroupList \
    [--vpcNo <vpc-no>] \
    [--accessControlGroupNoList <acg-no-list>] \
    [--accessControlGroupName <acg-name>] \
    [--accessControlGroupStatusCode <INIT|SET|RUN|TERMTING>] \
    [--pageNo <page-no>] \
    [--pageSize <page-size>] \
    [--regionCode <KR|SGN|JPN>] \
    [--output <json|xml>]

Options

This section describes the options available when running getAccessControlGroupList.

Required options

The following options are required for getAccessControlGroupList.

Options	Type	Required	Description
`--pageSize`	Integer	Conditional	Number of items per page `1`-`1000` (default: `1`) Required when entering `pageNo`

Optional options

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

Options	Type	Required	Description
`--vpcNo`	String	Optional	VPC number See getVpcList.
`--accessControlGroupNoList`	List	Optional	ACG number list You can enter multiple items separated by spaces. (e.g., `--accessControlGroupNoList 1234 2345`)
`--accessControlGroupName`	String	Optional	ACG name
`--accessControlGroupStatusCode`	String	Optional	ACG status code `INIT` \| `SET` \| `RUN` \| `TERMTING` `INIT`: Reset `SET`: Configuring `RUN`: Running `TERMTING`: Terminating
`--pageNo`	Integer	Optional	Page number `0`-N (default: `0`) First page: Enter `0` or `1`.

Common options

For information about the options common to all vserver subcommands, see Server (VPC) options.

Examples

If the ACG list query request is successful, the identification information and operational status of the created ACG are returned.

Command

The command example is as follows:

./ncloud vserver getAccessControlGroupList \
    --vpcNo 12345678 \
    --accessControlGroupNoList 67890123 67890124 \
    --accessControlGroupStatusCode RUN \
    --pageNo 1 \
    --pageSize 10 \
    --regionCode KR \
    --output json

Output

The output example is as follows:

{
  "getAccessControlGroupListResponse": {
    "totalRows": 2,
    "accessControlGroupList": [
      {
        "accessControlGroupNo": "67890123",
        "accessControlGroupName": "test-acg-01",
        "isDefault": false,
        "vpcNo": "12345678",
        "accessControlGroupStatus": {
          "code": "RUN",
          "codeName": "In operation"
        },
        "accessControlGroupDescription": "ACG for web tier"
      },
      {
        "accessControlGroupNo": "67890124",
        "accessControlGroupName": "test-acg-02",
        "isDefault": false,
        "vpcNo": "12345678",
        "accessControlGroupStatus": {
          "code": "RUN",
          "codeName": "In operation"
        },
        "accessControlGroupDescription": "ACG for database tier"
      }
    ],
    "requestId": "b2c3d4e5-f678-9012-bcde-f23456789012",
    "returnCode": "0",
    "returnMessage": "success"
  }
}

Documentation Index