getAccessControlGroupList

VPC環境で利用できます。

ACGリストを照会します。

構文

getAccessControlGroupList構文は次の通りです。

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

オプション

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

必須オプション

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

オプション	タイプ	必須の有無	説明
`--pageSize`	Integer	Conditional	ページごとの項目数 `1`~`1000` (デフォルト: `1`) `pageNo`入力時、必ず入力

任意オプション

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

オプション	タイプ	必須の有無	説明
`--vpcNo`	String	Optional	VPC番号 getVpcListを参照
`--accessControlGroupNoList`	List	Optional	ACG番号リストスペースで区切って複数入力可能 (例: `--accessControlGroupNoList 1234 2345`)
`--accessControlGroupName`	String	Optional	ACG名
`--accessControlGroupStatusCode`	String	Optional	ACG状態コード `INIT` \| `SET` \| `RUN` \| `TERMTING` `INIT`: 初期化 `SET`: 設定中 `RUN`: 運用中 `TERMTING`: 終了中
`--pageNo`	Integer	Optional	ページ番号 `0`~N (デフォルト: `0`) 最初のページ: `0`または`1`を入力

共通オプション

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

例

ACGリストの照会リクエストが成功すると、各 ACGの識別情報と運用状態が返されます。

コマンド

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

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

出力

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

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

Documentation Index