addPolicy

Classic 환경에서 이용 가능합니다.

Secure Zone에 적용할 방화벽 정책(Policy)을 추가합니다.

요청

요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

메서드	URI
POST	/api/v1/{type}/{zone}/addPolicy

요청 헤더

Secure Zone API에서 공통으로 사용하는 헤더에 대한 정보는 Secure Zone 요청 헤더를 참조해 주십시오.

요청 경로 파라미터

요청 경로 파라미터에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`type`	String	Required	Secure Zone에서 제공하는 방화벽 유형 `szfw` \| `psfw` `szfw`: Secure Zone Standard `psfw`: Secure Zone Advanced
`zone`	String	Required	Secure Zone을 구성한 존 `kr1` \| `kr2` `kr1`: KR-1 존 `kr2`: KR-2 존

요청 바디

요청 바디에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`action`	String	Required	허용 여부 `allow` \| `deny`
`description`	String	Optional	정책에 대한 설명
`destinationAddressGroupList`	Array	Required	목적지로 지정할 Address Group의 정보: destinationAddressGroupList Address Group은 미리 생성한 항목 중 선택 getAddressGroupList 참조 추가할 Address Group이 없어도 공란 상태의 파라미터 입력
`destinationAddressList`	Array	Required	목적지로 지정할 개별 Address의 정보: destinationAddressList 추가할 Address가 없어도 공란 상태의 파라미터 입력
`destinationAddressZone`	String	Optional	Address가 속한 존에 대한 정보 미입력 시 Address Group 또는 Address와 같은 하위 정보를 통해 자동 설정
`policyName`	String	Required	정책 이름
`port`	String	Optional	방화벽 서비스의 포트 번호
`protocol`	String	Optional	방화벽 서비스의 프로토콜
`sourceAddressGroupList`	Array	Required	출발지로 지정할 Address Group의 정보: sourceAddressGroupList Address Group은 미리 생성한 항목 중 선택 getAddressGroupList 참조 추가할 Address Group이 없어도 공란 상태의 파라미터 입력
`sourceAddressList`	Array	Required	출발지로 지정할 개별 Address의 정보: sourceAddressList 추가할 Address가 없어도 공란 상태의 파라미터 입력
`sourceAddressZone`	String	Optional	Address가 속한 존에 대한 정보 미입력 시 Address Group 또는 Address와 같은 하위 정보를 통해 자동 설정

`destinationAddressGroupList`

destinationAddressGroupList에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`addressGroupName`	String	Optional	목적지 Address Group의 이름
`addressGroupNo`	Integer	Optional	Address Group에 부여된 고유 번호
`description`	String	Optional	목적지 Address Group에 대한 설명
`addressList`	Array	Required	Address Group에 속한 Address 정보: addressList
`addressZone`	String	Optional	목적지 Address Group이 속한 존에 대한 정보
`objectStorage`	Boolean	Optional	Object Storage 사용 여부 `true` \| `false` (기본값) `true`: Object Storage를 사용함 `false`: Object Storage를 사용하지 않음

`addressList`

addressList에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`addressNo`	Integer	Optional	Address에 부여된 고유 번호
`addressZone`	String	Optional	Address가 속한 존에 대한 정보 `sz` \| `os` \| `vm` \| `db` \| `vpn` \| `lb` \| `kr1` `sz`: Secure Zone `os`: Object Storage `vm`: VM `db`: Cloud DB `vpn`: SSL VPN 또는 IPsec VPN `lb`: Load Balancer `kr1`: KR-1 존
`fqdn`	String	Conditional	전체 도메인 이름 (FQDN) `type`이 `fqdn`인 경우, 필수 입력
`ip`	String	Conditional	IP 주소 `type`이 `ipmask`인 경우, 필수 입력
`maskBit`	Integer	Optional	서브넷 마스크 비트 값 Secure Zone Advanced 타입에서 사용 가능
`name`	String	Optional	목적지 Address의 이름
`port`	String	Optional	포트 번호 `addressZone`이 `db`이고 `type`이 `fqdn`인 경우 입력
`type`	String	Optional	Address 유형 정보 `ipmask` (기본값) \| `fqdn` `ipmask`: IP 주소와 서브넷 마스크로 정의된 주소 `fqdn`: Fully qualified domain name (전체 도메인 이름)

`destinationAddressList`

destinationAddressList에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`addressNo`	Integer	Optional	Address에 부여된 고유 번호
`addressZone`	String	Optional	Address가 속한 존에 대한 정보 `sz` \| `os` \| `vm` \| `db` \| `vpn` \| `lb` \| `kr1` `sz`: Secure Zone `os`: Object Storage `vm`: VM `db`: Cloud DB `vpn`: SSL VPN 또는 IPsec VPN `lb`: Load Balancer `kr1`: KR-1 존
`fqdn`	String	Conditional	전체 도메인 이름 (FQDN) `type`이 `fqdn`인 경우, 필수 입력
`ip`	String	Conditional	IP 주소 `type`이 `ipmask`인 경우, 필수 입력
`maskBit`	Integer	Optional	서브넷 마스크 비트 값 Secure Zone Advanced 타입에서 사용 가능
`name`	String	Optional	목적지 Address의 이름
`port`	String	Optional	포트 번호 `addressZone`이 `db`이고 `type`이 `fqdn`인 경우 입력
`type`	String	Optional	Address 유형 정보 `ipmask` (기본값) \| `fqdn` `ipmask`: IP 주소와 서브넷 마스크로 정의된 주소 `fqdn`: Fully qualified domain name (전체 도메인 이름)

`sourceAddressGroupList`

sourceAddressGroupList에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`addressGroupNo`	Integer	Optional	Address Group에 부여된 고유 번호
`addressGroupName`	String	Optional	출발지 Address Group의 이름
`addressList`	Array	Required	Address Group에 속한 Address 정보: addressList
`addressZone`	String	Optional	출발지 Address Group이 속한 존에 대한 정보
`description`	String	Optional	출발지 Address Group에 대한 설명
`objectStorage`	Boolean	Optional	오브젝트 스토리지 사용 여부 `true` \| `false` (기본값) `true`: 오브젝트 스토리지를 사용함 `false`: 오브젝트 스토리지를 사용하지 않음

`addressList`

addressList에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`addressNo`	Integer	Optional	Address에 부여된 고유 번호
`addressZone`	String	Optional	Address가 속한 존에 대한 정보 `sz` \| `os` \| `vm` \| `db` \| `vpn` \| `lb` \| `kr1` `sz`: Secure Zone `os`: Object Storage `vm`: VM `db`: Cloud DB `vpn`: SSL VPN 또는 IPsec VPN `lb`: Load Balancer `kr1`: KR-1 존
`fqdn`	String	Conditional	fqdn (전체 도메인 이름) `type`이 `fqdn`인 경우, 필수 입력
`ip`	String	Conditional	IP 주소 `type`이 `ipmask`인 경우, 필수 입력
`maskBit`	Integer	Optional	서브넷 마스크 비트 값 Secure Zone Advanced 타입에서 사용 가능
`name`	String	Optional	출발지 Address의 이름
`port`	String	Optional	포트 번호 `addressZone`이 `db`이고 `type`이 `fqdn`인 경우 입력
`type`	String	Optional	Address 유형 정보 `ipmask` (기본값) \| `fqdn` `ipmask`: IP 주소와 서브넷 마스크로 정의된 주소 `fqdn`: Fully qualified domain name (전체 도메인 이름)

`sourceAddressList`

sourceAddressList에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`addressNo`	Integer	Optional	Address에 부여된 고유 번호
`addressZone`	String	Optional	Address가 속한 존에 대한 정보 `sz` \| `os` \| `vm` \| `db` \| `vpn` \| `lb` \| `kr1` `sz`: Secure Zone `os`: Object Storage `vm`: VM `db`: Cloud DB `vpn`: SSL VPN 또는 IPsec VPN `lb`: Load Balancer `kr1`: KR-1 존
`fqdn`	String	Conditional	fqdn (전체 도메인 이름) `type`이 `fqdn`인 경우, 필수 입력
`ip`	String	Conditional	IP 주소 `type`이 `ipmask`인 경우, 필수 입력
`maskBit`	Integer	Optional	서브넷 마스크 비트 값 Secure Zone Advanced 타입에서 사용 가능
`name`	String	Optional	출발지 Address의 이름
`port`	String	Optional	포트 번호 `addressZone`이 `db`이고 `type`이 `fqdn`인 경우 입력
`type`	String	Optional	Address 유형 정보 `ipmask` (기본값) \| `fqdn` `ipmask`: IP 주소와 서브넷 마스크로 정의된 주소 `fqdn`: Fully qualified domain name (전체 도메인 이름)

요청 예시

요청 예시는 다음과 같습니다.

curl --location --request POST 'https://securezonefirewall.apigw.gov-ntruss.com/api/v2/szfw/kr1/addPolicy'
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'x-ncp-mbr_no: {User number}' \
--header 'Content-Type: application/json' \
--data '{
  "action": "allow",
  "description": "policy3",
  "destinationAddressGroupList": [
    {
      "addressGroupName": "dbgroup",
      "addressGroupNo": 5452,
      "description": "",
      "addressList": [
                {
          "addressNo": 3646,
          "addressZone": "db",
          "fqdn": "db-****.cdb.ntruss.com",
          "ip": "***.***.***.***",
          "name": "test-db-001",
          "port": "3306",
          "type": "fqdn"
        }
      ],
      "addressZone": "db",
      "objectStorage": false
    }
  ],
  "destinationAddressList": [],
  "destinationAddressZone": "db",
  "policyName": "policy3",
  "port": "3306",
  "protocol": "TCP",
  "sourceAddressGroupList": [
        {
      "addressGroupNo": 5439,
      "addressGroupName": "grp111",
      "addressList": [
        {
          "addressNo": 3643,
          "addressZone": "sz",
          "ip": "***.***.***.***",
          "name": "sv-securezone",
          "type": "ipmask"
        }
      ],
      "addressZone": "sz",
      "description": "string",
      "objectStorage": false
    }
  ],
  "sourceAddressList": [],
  "sourceAddressZone": "sz"
}'

응답

응답 형식을 설명합니다.

응답 바디

응답 바디에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`action`	String	-	요청 유형
`returnCode`	Integer	-	응답 코드
`returnMessage`	String	-	응답 메시지

응답 상태 코드

Secure Zone API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Secure Zone 응답 상태 코드를 참조해 주십시오.

응답 예시

응답 예시는 다음과 같습니다.

{
    "action": "addPolicy",
    "returnCode": 0,
    "returnMessage": "success"
}