checkAddressGroupNameDuplicated

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

Address Group을 추가하기 전 사용하려는 이름의 중복 여부를 확인합니다.

요청

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

메서드	URI
POST	/{type}/{zone}/checkAddressGroupNameDuplicated

요청 헤더

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 존

요청 바디

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

필드	타입	필수 여부	설명
`memberNo`	String	Optional	사용자의 네이버 클라우드 플랫폼 회원 번호 getMemberInfo를 통해 확인
`instanceNo`	String	Optional	인스턴스 생성 시 부여된 계약 번호 getMemberInfo를 통해 확인
`addressGroup.addressGroupName`	String	Required	중복 여부를 확인할 Address Group 이름
`addressGroup.addressGroupNo`	Integer	Optional	Address Group에 부여된 고유 번호 getAddressGroupList를 통해 확인
`addressGroup.addressList[]`	Array	Optional	Address Group에 속한 Address 정보 getAddressGroupList를 통해 확인
`addressGroup.addressList[].memberNo`	String	Optional	사용자의 네이버 클라우드 플랫폼 회원 번호 getMemberInfo를 통해 확인
`addressGroup.addressList[].instanceNo`	String	Optional	인스턴스 생성 시 부여된 계약 번호 getMemberInfo를 통해 확인
`addressGroup.addressList[].addressNo`	Integer	Optional	Address에 부여된 고유 번호
`addressGroup.addressList[].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 존
`addressGroup.addressList[].fqdn`	String	Conditional	전체 도메인 이름 (FQDN) `type`이 `fqdn`인 경우 입력 필수
`addressGroup.addressList[].ip`	String	Optional	IP 주소 `type`이 `ipmask`인 경우 입력 필수
`addressGroup.addressList[].maskBit`	Integer	Optional	서브넷 마스크 비트 값 Secure Zone Advanced 타입에서 사용 가능
`addressGroup.addressList[].name`	String	Optional	Address의 이름
`addressGroup.addressList[].port`	String	Optional	포트 번호 `addressZone`이 `db`이고 `type`이 `fqdn`인 경우 입력
`addressGroup.addressList[].type`	String	Optional	Address 유형 정보 `ipmask` (기본값) \| `fqdn` `ipmask`: IP 주소와 서브넷 마스크로 정의된 주소 `fqdn`: Fully qualified domain name (전체 도메인 이름)
`addressGroup.addressZone`	String	Optional	Address Group이 속한 존에 대한 정보 미입력 시 목록 첫 번째 Address의 존 정보를 통해 자동 설정
`addressGroup.description`	String	Optional	Address Group에 대한 설명
`addressGroup.objectStorage`	Boolean	Optional	Object Storage 사용 여부 `true` \| `false`(기본값) `true`: Object Storage를 사용함 (Object Storage는 그룹을 생성할 수 없으므로 `true` 선택 불가) `false`: Object Storage를 사용하지 않음

요청 예시

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

curl --location --request POST 'https://securezonefirewall.apigw.gov-ntruss.com/api/v2/szfw/kr1/checkAddressGroupNameDuplicated'
--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 '{
  "addressGroup": {
    "addressGroupName": "grp111",
    "addressZone": "sz"
  }
}'

응답

응답 형식을 설명합니다.

응답 바디

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

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

응답 상태 코드

네이버 클라우드 플랫폼에서 공통으로 사용하는 응답 상태 코드에 대한 자세한 내용은 Ncloud API 응답 상태 코드를 참조해 주십시오.

응답 예시

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

{
    "action": "checkAddressGroupNameDuplicated",
    "returnCode": 230006,
    "returnMessage": "Duplicated Name."
}