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	ユーザーの NAVERクラウドプラットフォーム会員番号 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	ユーザーの NAVERクラウドプラットフォーム会員番号 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が属するゾーンに関する情報未入力時はリストの1番目の 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.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	-	レスポンスメッセージ

レスポンスステータスコード

NAVERクラウドプラットフォームで共通して使用されるレスポンスステータスコードの詳細は、Ncloud APIのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

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