getAccessControlGroupRuleList

Prev Next

VPC環境で利用できます。

ACGのルールリストを照会します。

リクエスト

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

メソッド URI
GET | POST /vserver/v2/getAccessControlGroupRuleList
参考

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

リクエストヘッダ

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

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

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

フィールド タイプ 必須の有無 説明
regionCode String Optional リージョンコード
  • getRegionListを参照
    • 照会結果の最初のリージョン(デフォルト)
accessControlGroupNo String Required ACG番号
accessControlGroupRuleTypeCode String Optional ACGルールタイプコードで絞り込み
  • INBND | OTBND (デフォルト: すべてのルール)
    • INBND: Inboundルール
    • OTBND: Outboundルール
responseFormatType String Optional レスポンスデータの形式
  • xml(デフォルト) | json

リクエスト例

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

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vserver/v2/getAccessControlGroupRuleList
?regionCode=KR
&accessControlGroupNo=1***1
&responseFormatType=json' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

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

レスポンスボディ

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

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

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

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

レスポンス例

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

{
  "getAccessControlGroupRuleListResponse": {
    "totalRows": 5,
    "accessControlGroupRuleList": [
      {
        "accessControlGroupNo": "1***1",
        "protocolType": {
          "code": "TCP",
          "codeName": "tcp",
          "number": 6
        },
        "ipBlock": "0.0.0.0/0",
        "accessControlGroupSequence": "",
        "portRange": "3389",
        "accessControlGroupRuleType": {
          "code": "INBND",
          "codeName": "Inbound"
        },
        "accessControlGroupRuleDescription": ""
      },
      {
        "accessControlGroupNo": "1***1",
        "protocolType": {
          "code": "TCP",
          "codeName": "tcp",
          "number": 6
        },
        "ipBlock": "0.0.0.0/0",
        "accessControlGroupSequence": "",
        "portRange": "22",
        "accessControlGroupRuleType": {
          "code": "INBND",
          "codeName": "Inbound"
        },
        "accessControlGroupRuleDescription": ""
      },
      {
        "accessControlGroupNo": "1***1",
        "protocolType": {
          "code": "ICMP",
          "codeName": "icmp",
          "number": 1
        },
        "ipBlock": "0.0.0.0/0",
        "accessControlGroupSequence": "",
        "portRange": "",
        "accessControlGroupRuleType": {
          "code": "OTBND",
          "codeName": "Outbound"
        },
        "accessControlGroupRuleDescription": ""
      },
      {
        "accessControlGroupNo": "1***1",
        "protocolType": {
          "code": "UDP",
          "codeName": "udp",
          "number": 17
        },
        "ipBlock": "0.0.0.0/0",
        "accessControlGroupSequence": "",
        "portRange": "1-65535",
        "accessControlGroupRuleType": {
          "code": "OTBND",
          "codeName": "Outbound"
        },
        "accessControlGroupRuleDescription": ""
      },
      {
        "accessControlGroupNo": "1***1",
        "protocolType": {
          "code": "TCP",
          "codeName": "tcp",
          "number": 6
        },
        "ipBlock": "0.0.0.0/0",
        "accessControlGroupSequence": "",
        "portRange": "1-65535",
        "accessControlGroupRuleType": {
          "code": "OTBND",
          "codeName": "Outbound"
        },
        "accessControlGroupRuleDescription": ""
      }
    ],
    "requestId": "0bbc6a2b-****-****-****-8bfee31a6869",
    "returnCode": "0",
    "returnMessage": "success"
  }
}