getAccessControlGroupList

VPC環境で利用できます。

ACGリストを照会します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド	URI
GET \| POST	/vserver/v2/getAccessControlGroupList

参考

ガイドは GETメソッドを基準に説明します。POSTメソッドの呼び出しテストは、NAVERクラウドプラットフォームコンソールの API Gatewayサービスの Swaggerで行えます。

リクエストヘッダ

Server APIで共通して使用されるヘッダの詳細は、Serverのリクエストヘッダをご参照ください。

リクエストクエリパラメータ

リクエストクエリパラメータの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`regionCode`	String	Optional	リージョンコード getRegionListを参照照会結果の最初のリージョン(デフォルト)
`vpcNo`	String	Optional	VPC番号で絞り込み getVpcListを参照
`accessControlGroupNoList.N`	Array	Optional	ACG番号リスト ACG番号で絞り込み <例> `accessControlGroupNoList.1=1234&accessControlGroupNoList.2=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`を入力
`pageSize`	Integer	Conditional	ページごとの項目数 1~1000 (デフォルト: 1) `pageNo`入力時、必ず入力
`responseFormatType`	String	Optional	レスポンスデータの形式 `xml`(デフォルト) \| `json`

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vserver/v2/getAccessControlGroupList
?regionCode=KR
&vpcNo=***75
&accessControlGroupNoList.1=***43
&accessControlGroupName=test-***
&accessControlGroupStatusCode=RUN' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`getAccessControlGroupListResponse`	Object	-	レスポンス結果 AccessControlGroupListを参照
`getAccessControlGroupListResponse.requestId`	String	-	リクエスト ID UUID形式
`getAccessControlGroupListResponse.returnCode`	String	-	レスポンスコード
`getAccessControlGroupListResponse.returnMessage`	String	-	レスポンスメッセージ

レスポンスステータスコード

Server APIで共通して使用されるレスポンスステータスコードの詳細は、Serverのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
  "getAccessControlGroupListResponse": {
    "totalRows": 3,
    "accessControlGroupList": [
      {
        "accessControlGroupNo": "6***4",
        "accessControlGroupName": "acgtestgroup",
        "isDefault": false,
        "vpcNo": "4**5",
        "accessControlGroupStatus": {
          "code": "RUN",
          "codeName": "運用中"
        },
        "accessControlGroupDescription": "act test group"
      },
      {
        "accessControlGroupNo": "6***6",
        "accessControlGroupName": "nks-****-1o8kky",
        "isDefault": false,
        "vpcNo": "4**5",
        "accessControlGroupStatus": {
          "code": "RUN",
          "codeName": "運用中"
        },
        "accessControlGroupDescription": "automatically created, don't delete it"
      }
    ],
    "requestId": "60adc59e-****-****-****-6826f315f8ac",
    "returnCode": "0",
    "returnMessage": "success"
  }
}