addAccessControlGroupInboundRule

Prev Next

Available in VPC

Add an inbound rule to an ACG.

Request

This section describes the request format. The method and URI are as follows:

Method URI
GET | POST /vserver/v2/addAccessControlGroupInboundRule
Note

This guide is based on the GET method. POST method call tests can be performed through Swagger in the API Gateway service of the NAVER Cloud Platform console.

Request headers

For information about the headers common to all Server APIs, see Server request headers.

Request query parameters

You can use the following query parameters with your request:

Field Type Required Description
regionCode String Optional Region code
vpcNo String Required VPC number
accessControlGroupNo String Required ACG number
accessControlGroupRuleList.N.protocolTypeCode String Required Protocol type code
  • TCP | UDP | ICMP | 1-254 (protocol number)
  • Protocol number: See Protocol number.
accessControlGroupRuleList.N.ipBlock String Conditional Access source: IP address block
  • Example: 0.0.0.0/0, 100.10.20.0/24
  • Can't be used concurrently with accessControlGroupSequence.
accessControlGroupRuleList.N.accessControlGroupSequence String Conditional Access source: ACG number
accessControlGroupRuleList.N.portRange String Conditional Allowed port
  • Enter as a single port or range of ports.
  • Required if protocolTypeCode is TCP(6) or UDP(17)
  • Example: 22, 1-65535
accessControlGroupRuleList.N.accessControlGroupRuleDescription String Optional ACG inbound rule note (byte)
  • 0-1000
responseFormatType String Optional Format of the response data
  • xml (default) | json

Request example

The request example is as follows:

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}'

Response

This section describes the response format.

Response body

The response body includes the following data:

Field Type Required Description
addAccessControlGroupInboundRuleResponse Object - Response result
addAccessControlGroupInboundRuleResponse.requestId String - ID for the request
  • UUID format
addAccessControlGroupInboundRuleResponse.returnCode String - Response code
addAccessControlGroupInboundRuleResponse.returnMessage String - Response message

Response status codes

For information about the response status codes common to all Server APIs, see Server response status codes.

Response example

The response example is as follows:

{
  "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"
  }
}