checkAddressGroupNameDuplicated

Available in Classic

Before adding an address group, check for duplicates of the name you want to use.

Request

The following describes the request format for the endpoint. The request format is as follows:

Method	URI
POST	/{type}/{zone}/checkAddressGroupNameDuplicated

Request headers

For headers common to Secure Zone APIs, see Secure Zone request headers.

Request path parameters

The following describes the parameters.

Field	Type	Required	Description
`type`	String	Required	firewall type provided by Secure Zone `szfw` \| `psfw` `szfw`: Secure Zone Standard `psfw`: Secure Zone Advanced
`zone`	String	Required	Zone in which Secure Zone is configured `kr1` \| `kr2` `kr1`: KR-1 zone `kr2`: KR-2 zone

Request body

The following describes the request body.

Field	Type	Required	Description
`memberNo`	String	Optional	User's NAVER Cloud Platform member ID Check through getMemberInfo
`instanceNo`	String	Optional	Contract number assigned when creating the instance Check through getMemberInfo
`addressGroup.addressGroupName`	String	Required	Address group name to check for duplicates
`addressGroup.addressGroupNo`	Integer	Optional	Unique number assigned to the address group Check through getAddressGroupList
`addressGroup.addressList[]`	Array	Optional	Information about addresses that belong to the address group Check through getAddressGroupList
`addressGroup.addressList[].memberNo`	String	Optional	User's NAVER Cloud Platform member ID Check through getMemberInfo
`addressGroup.addressList[].instanceNo`	String	Optional	Contract number assigned when creating the instance Check through getMemberInfo
`addressGroup.addressList[].addressNo`	Integer	Optional	Unique number assigned to the address
`addressGroup.addressList[].addressZone`	String	Optional	Information for the zone the address belongs to `sz` \| `os` \| `vm` \| `db` \| `vpn` \| `lb` \| `kr1` `sz`: Secure Zone `os`: Object Storage `vm`: VM `db`: Cloud DB `vpn`: SSL VPN or IPsec VPN `lb`: Load Balancer `kr1`: KR-1 zone
`addressGroup.addressList[].fqdn`	String	Conditional	Full domain name (FQDN) Required if `type` is `fqdn`
`addressGroup.addressList[].ip`	String	Optional	IP address Required if `type` is `ipmask`
`addressGroup.addressList[].maskBit`	Integer	Optional	Subnet mask bit value Available in the Secure Zone Advanced type
`addressGroup.addressList[].name`	String	Optional	Address name
`addressGroup.addressList[].port`	String	Optional	Port number Enter if `addressZone` is `db` and `type` is `fqdn`
`addressGroup.addressList[].type`	String	Optional	Address type information `ipmask` (default) \| `fqdn` `ipmask`: address defined by IP address and subnet mask `fqdn`: fully qualified domain name (full domain name)
`addressGroup.addressZone`	String	Optional	Information about the zone to which the address group belongs Automatically set via zone information in the first address in the list if not entered
`addressGroup.description`	String	Optional	Address group description
`addressGroup.objectStorage`	Boolean	Optional	Whether to use Object Storage `true` \| `false` (default) `true`: Object Storage is used (Since groups can't be created for Object Storage, `true` can't be selected.) `false`: Object Storage is not used

Request example

The following is a sample request.

curl --location --request POST 'https://securezonefirewall.apigw.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"
  }
}'

Response

The following describes the response format.

Response body

The following describes the response body.

Field	Type	Required	Description
`action`	String	-	Request type
`returnCode`	Integer	-	Response code
`returnMessage`	String	-	Response message

Response status codes

For response status codes common to NAVER Cloud Platform, see Ncloud API response status codes.

Response example

The following is a sample example.

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