リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド	URI
POST	/{type}/{zone}/getIpsecAddress

リクエストヘッダ

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を通じて確認

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request POST 'https://securezonefirewall.apigw.ntruss.com/api/v2/psfw/kr2/getIpsecAddress'
--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 '{
  "memberNo": "27***85",
  "instanceNo": "25****11"
}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`action`	String	-	リクエストタイプ
`addressList[]`	Array	-	照会対象の Addressリスト
`addressList[].addressNo`	Integer	-	Addressに付与された固有番号
`addressList[].addressZone`	String	-	Addressが属するゾーンに関する情報 `vpn` `vpn`: IPsec VPN
`addressList[].dbAddressZone`	Boolean	-	DB Address Zoneかどうか
`addressList[].fqdn`	String	-	完全修飾ドメイン名(FQDN)
`addressList[].instanceNo`	String	-	インスタンス作成時に付与された契約番号
`addressList[].ip`	String	-	IPアドレス
`addressList[].maskBit`	Integer	-	サブネットマスクのビット値 Secure Zone Advancedタイプの場合に表示
`addressList[].memberNo`	String	-	ユーザーの NAVERクラウドプラットフォーム会員番号
`addressList[].name`	String	-	Addressの名前
`addressList[].port`	Integer	-	ポート番号 `addressZone`が`db`で`type`が`fqdn`の場合に表示
`addressList[].type`	String	-	Addressタイプ情報 `ipmask` \| `fqdn` `ipmask`: IPアドレスとサブネットマスクで定義されたアドレス `fqdn`: Fully qualified domain name(完全修飾ドメイン名)
`returnCode`	Integer	-	レスポンスコード
`returnMessage`	String	-	レスポンスメッセージ

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

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

レスポンス例

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

{
  "action": "string",
  "addressList": [
    {
      "addressNo": 0,
      "addressZone": "string",
      "fqdn": "string",
      "instanceNo": "string",
      "ip": "string",
      "maskBit": 0,
      "memberNo": "string",
      "name": "string",
      "port": "string",
      "type": "ipmask"
    }
  ],
  "returnCode": 0,
  "returnMessage": "string"
}

この記事は役に立ちましたか?

リクエスト
レスポンス

タグ

Secure Zone