MENU
      checkAddressGroupNameDuplicated

        checkAddressGroupNameDuplicated


        Article summary

        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:

        MethodURI
        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.

        FieldTypeRequiredDescription
        typeStringRequiredfirewall type provided by Secure Zone
        • szfw | psfw
          • szfw: Secure Zone Standard
          • psfw: Secure Zone Advanced
        zoneStringRequiredZone in which Secure Zone is configured
        • kr1 | kr2
          • kr1: KR-1 zone
          • kr2: KR-2 zone

        Request body

        The following describes the request body.

        FieldTypeRequiredDescription
        memberNoStringOptionalUser's NAVER Cloud Platform member ID
        instanceNoStringOptionalContract number assigned when creating the instance
        addressGroup.addressGroupNameStringRequiredAddress group name to check for duplicates
        addressGroup.addressGroupNoIntegerOptionalUnique number assigned to the address group
        addressGroup.addressList[]ArrayOptionalInformation about addresses that belong to the address group
        addressGroup.addressList[].memberNoStringOptionalUser's NAVER Cloud Platform member ID
        addressGroup.addressList[].instanceNoStringOptionalContract number assigned when creating the instance
        addressGroup.addressList[].addressNoIntegerOptionalUnique number assigned to the address
        addressGroup.addressList[].addressZoneStringOptionalInformation 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[].fqdnStringConditionalFull domain name (FQDN)
        • Required if type is fqdn
        addressGroup.addressList[].ipStringOptionalIP address
        • Required if type is ipmask
        addressGroup.addressList[].maskBitIntegerOptionalSubnet mask bit value
        • Available in the Secure Zone Advanced type
        addressGroup.addressList[].nameStringOptionalAddress name
        addressGroup.addressList[].portStringOptionalPort number
        • Enter if addressZone is db and type is fqdn
        addressGroup.addressList[].typeStringOptionalAddress type information
        • ipmask (default) | fqdn
          • ipmask: address defined by IP address and subnet mask
          • fqdn: fully qualified domain name (full domain name)
        addressGroup.addressZoneStringOptionalInformation 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.descriptionStringOptionalAddress group description
        addressGroup.objectStorageBooleanOptionalWhether 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"
          }
        }'
        Curl

        Response

        The following describes the response format.

        Response body

        The following describes the response body.

        FieldTypeRequiredDescription
        actionString-Request type
        returnCodeInteger-Response code
        returnMessageString-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."
        }
        JSON

        Was this article helpful?

        Changing your password will log you out immediately. Use the new password to log back in.
        First name must have atleast 2 characters. Numbers and special characters are not allowed.
        Last name must have atleast 1 characters. Numbers and special characters are not allowed.
        Enter a valid email
        Enter a valid password
        Your profile has been successfully updated.