addAccessControlGroupInboundRule

Prev Next

VPC環境で利用できます。

ACGに Inboundルールを追加します。

リクエスト

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

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

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

リクエストヘッダ

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

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

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

フィールド タイプ 必須の有無 説明
regionCode String Optional リージョンコード
  • getRegionListを参照
    • 照会結果の最初のリージョン(デフォルト)
vpcNo String Required VPC番号
accessControlGroupNo String Required ACG番号
accessControlGroupRuleList.N.protocolTypeCode String Required プロトコルタイプコード
accessControlGroupRuleList.N.ipBlock String Conditional アクセスソース: IPアドレスブロック
  • <例> 0.0.0.0/0、100.10.20.0/24
  • accessControlGroupSequenceと同時に使用不可
accessControlGroupRuleList.N.accessControlGroupSequence String Conditional アクセスソース: ACG番号
accessControlGroupRuleList.N.portRange String Conditional 許可ポート
  • 単一のポートまたはポートの範囲を入力
  • protocolTypeCodeがTCP(6)、UDP(17)の場合、必ず入力
  • <例> 22、1-65535
accessControlGroupRuleList.N.accessControlGroupRuleDescription String Optional ACG Inboundルールのメモ(Byte)
  • 0~1000
responseFormatType String Optional レスポンスデータの形式
  • xml(デフォルト) | json

リクエスト例

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

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vserver/v2/addAccessControlGroupInboundRule
?regionCode=KR
&vpcNo=4**5
&accessControlGroupNo=6***4
&accessControlGroupRuleList.1.protocolTypeCode=TCP
&accessControlGroupRuleList.1.ipBlock=*.*.20.0%2F24
&accessControlGroupRuleList.1.portRange=1-65535
&accessControlGroupRuleList.1.accessControlGroupRuleDescription=putty
&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}'

レスポンス

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

レスポンスボディ

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

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

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

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

レスポンス例

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

{
  "addAccessControlGroupInboundRuleResponse": {
    "totalRows": 1,
    "accessControlGroupRuleList": [
      {
        "accessControlGroupNo": "6***4",
        "protocolType": {
          "code": "TCP",
          "codeName": "tcp",
          "number": 6
        },
        "ipBlock": "*.*.20.0/24",
        "accessControlGroupSequence": "",
        "portRange": "1-65535",
        "accessControlGroupRuleType": {
          "code": "INBND",
          "codeName": "Inbound"
        },
        "accessControlGroupRuleDescription": "putty"
      }
    ],
    "requestId": "ac7285ca-****-****-****-6511d447736a",
    "returnCode": "0",
    "returnMessage": "success"
  }
}