addPolicy
- 印刷する
- PDF
addPolicy
- 印刷する
- PDF
記事の要約
この要約は役に立ちましたか?
ご意見ありがとうございます
Classic環境で利用できます。
Secure Zoneに適用するファイアウォールポリシー(Policy)を追加します。
リクエスト
リクエスト形式を説明します。リクエスト形式は次の通りです。
メソッド | URI |
---|---|
POST | /{type}/{zone}/addPolicy |
リクエストヘッダ
Secure Zone APIで共通して使用されるヘッダの詳細は、Secure Zoneのリクエストヘッダをご参照ください。
リクエストパスパラメータ
パラメータの説明は次の通りです。
フィールド | タイプ | 必須の有無 | 説明 |
---|---|---|---|
type | String | Required | Secure Zoneで提供するファイアウォールタイプ
|
zone | String | Required | Secure Zoneを構成したゾーン
|
リクエストボディ
リクエストボディの説明は次の通りです。
フィールド | タイプ | 必須の有無 | 説明 |
---|---|---|---|
action | String | Required | 許可するかどうか
|
description | String | Optional | ポリシーの説明 |
destinationAddressGroupList[] | Array | Required | 目的地に指定する Address Group情報
|
destinationAddressGroupList[].addressGroupName | String | Optional | 目的地 Address Groupの名前 |
destinationAddressGroupList[].addressGroupNo | Integer | Optional | Address Groupに付与された固有番号 |
destinationAddressGroupList[].description | String | Optional | 目的地 Address Groupの説明 |
destinationAddressGroupList[].addressList[] | Array | Required | Address Groupに属する Address情報 |
destinationAddressGroupList[].addressList[].addressNo | Integer | Optional | Addressに付与された固有番号 |
destinationAddressGroupList[].addressList[].addressZone | String | Optional | Addressが属するゾーンに関する情報
|
destinationAddressGroupList[].addressList[].fqdn | String | Optional | 完全修飾ドメイン名(FQDN)
|
destinationAddressGroupList[].addressList[].ip | String | Optional | IPアドレス
|
destinationAddressGroupList[].addressList[].maskBit | Integer | Optional | サブネットマスクのビット値
|
destinationAddressGroupList[].addressList[].name | String | Optional | 目的地 Addressの名前 |
destinationAddressGroupList[].addressList[].port | String | Optional | ポート番号
|
destinationAddressGroupList[].addressList[].type | String | Optional | Addressタイプ情報
|
destinationAddressGroupList[].addressZone | String | Optional | 目的地 Address Groupが属するゾーンに関する情報 |
destinationAddressGroupList[].objectStorage | Boolean | Optional | Object Storageの使用有無
|
destinationAddressList[] | Array | Required | 目的地に指定する個別 Address情報
|
destinationAddressList[].addressNo | Integer | Optional | Addressに付与された固有番号 |
destinationAddressList[].addressZone | String | Optional | Addressが属するゾーンに関する情報
|
destinationAddressList[].fqdn | String | Optional | 完全修飾ドメイン名(FQDN)
|
destinationAddressList[].ip | String | Optional | IPアドレス
|
destinationAddressList[].maskBit | Integer | Optional | サブネットマスクのビット値
|
destinationAddressList[].name | String | Optional | 目的地 Addressの名前 |
destinationAddressList[].port | String | Optional | ポート番号
|
destinationAddressList[].type | String | Optional | Addressタイプ情報
|
destinationAddressZone | String | Optional | Addressが属するゾーンに関する情報
|
policyName | String | Required | ポリシー名 |
port | String | Optional | ファイアウォールサービスのポート番号 |
protocol | String | Optional | ファイアウォールサービスのプロトコル |
sourceAddressGroupList[] | Array | Required | 出発地に指定する Address Group情報
|
sourceAddressGroupList[].addressGroupNo | Integer | Optional | Address Groupに付与された固有番号 |
sourceAddressGroupList[].addressGroupName | String | Optional | 出発地 Address Groupの名前 |
sourceAddressGroupList[].addressList[] | Array | Required | Address Groupに属する Address情報 |
sourceAddressGroupList[].addressList[].addressNo | Integer | Optional | Addressに付与された固有番号 |
sourceAddressGroupList[].addressList[].addressZone | String | Optional | Addressが属するゾーンに関する情報
|
sourceAddressGroupList[].addressList[].fqdn | String | Optional | fqdn(完全修飾ドメイン名)
|
sourceAddressGroupList[].addressList[].ip | String | Optional | IPアドレス
|
sourceAddressGroupList[].addressList[].maskBit | Integer | Optional | サブネットマスクのビット値
|
sourceAddressGroupList[].addressList[].name | String | Optional | 出発地 Addressの名前 |
sourceAddressGroupList[].addressList[].port | String | Optional | ポート番号
|
sourceAddressGroupList[].addressList[].type | String | Optional | Addressタイプ情報
|
sourceAddressGroupList[].addressZone | String | Optional | 出発地 Address Groupが属するゾーンに関する情報 |
sourceAddressGroupList[].description | String | Optional | 出発地 Address Groupの説明 |
sourceAddressGroupList[].objectStorage | Boolean | Optional | オブジェクトストレージの使用有無
|
sourceAddressList[] | Array | Required | 出発地に指定する個別 Address情報
|
sourceAddressList[].addressNo | Integer | Optional | Addressに付与された固有番号 |
sourceAddressList[].addressZone | String | Optional | Addressが属するゾーンに関する情報
|
sourceAddressList[].fqdn | String | Optional | fqdn(完全修飾ドメイン名)
|
sourceAddressList[].ip | String | Optional | IPアドレス
|
sourceAddressList[].maskBit | Integer | Optional | サブネットマスクのビット値
|
sourceAddressList[].name | String | Optional | 出発地 Addressの名前 |
sourceAddressList[].port | String | Optional | ポート番号
|
sourceAddressList[].type | String | Optional | Addressタイプ情報
|
sourceAddressZone | String | Optional | Addressが属するゾーンに関する情報
|
リクエスト例
リクエストのサンプルコードは次の通りです。
curl --location --request POST 'https://securezonefirewall.apigw.ntruss.com/api/v2/szfw/kr1/addPolicy'
--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 '{
"action": "allow",
"description": "policy3",
"destinationAddressGroupList": [
{
"addressGroupName": "dbgroup",
"addressGroupNo": 5452,
"description": "",
"addressList": [
{
"addressNo": 3646,
"addressZone": "db",
"fqdn": "db-****.cdb.ntruss.com",
"ip": "***.***.***.***",
"name": "test-db-001",
"port": "3306",
"type": "fqdn"
}
],
"addressZone": "db",
"objectStorage": false
}
],
"destinationAddressList": [],
"destinationAddressZone": "db",
"policyName": "policy3",
"port": "3306",
"protocol": "TCP",
"sourceAddressGroupList": [
{
"addressGroupNo": 5439,
"addressGroupName": "grp111",
"addressList": [
{
"addressNo": 3643,
"addressZone": "sz",
"ip": "***.***.***.***",
"name": "sv-securezone",
"type": "ipmask"
}
],
"addressZone": "sz",
"description": "string",
"objectStorage": false
}
],
"sourceAddressList": [],
"sourceAddressZone": "sz"
}'
レスポンス
レスポンス形式を説明します。
レスポンスボディ
レスポンスボディの説明は次の通りです。
フィールド | タイプ | 必須の有無 | 説明 |
---|---|---|---|
action | String | - | リクエストタイプ |
returnCode | Integer | - | レスポンスコード |
returnMessage | String | - | レスポンスメッセージ |
レスポンスステータスコード
NAVERクラウドプラットフォームで共通して使用されるレスポンスステータスコードの詳細は、Ncloud APIのレスポンスステータスコードをご参照ください。
レスポンス例
レスポンスのサンプルコードは次の通りです。
{
"action": "addPolicy",
"returnCode": 0,
"returnMessage": "success"
}
この記事は役に立ちましたか?