getPolicy

Prev Next

Classic環境で利用できます。

ファイアウォールポリシーの中から選択したポリシーの情報を照会します。

リクエスト

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

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

リクエストヘッダ

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ゾーン

リクエストボディ

リクエストボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
policyName String Conditional 照会対象のポリシー名
  • getPolicyListを通じて確認
  • policyNoが指定されていない場合、必須
policyNo String Conditional ポリシーに付与された固有番号
  • getPolicyListを通じて確認
  • policyNameが指定されていない場合、必須
  • 0を入力すると優先順位が最も低いポリシーを照会

リクエスト例

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

curl --location --request POST 'https://securezonefirewall.apigw.ntruss.com/api/v2/szfw/kr2/getPolicy'
--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 '{
  "policyName": "pol1",
  "policyNo": 0
}'

レスポンス

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

レスポンスボディ

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

フィールド タイプ 必須の有無 説明
action String - リクエストタイプ
returnCode Integer - レスポンスコード
returnMessage String - レスポンスメッセージ
policy List<String> - 照会対象のポリシー情報
policy.policyNo Integer - ポリシーに付与された固有番号
policy.policyName String - ポリシー名
policy.description String - ポリシーの説明
policy.action String - 許可するかどうか
  • allow | deny
policy.memberNo String - ユーザーの NAVERクラウドプラットフォーム会員番号
policy.instanceNo String - インスタンス作成時に付与された契約番号
policy.sourceAddressList[] Array - 出発地 Address情報
policy.sourceAddressList[].addressNo Integer - Addressに付与された固有番号
policy.sourceAddressList[].memberNo String - ユーザーの NAVERクラウドプラットフォーム会員番号
policy.sourceAddressList[].instanceNo String - インスタンス作成時に付与された契約番号
policy.sourceAddressList[].name String - Addressの名前
policy.sourceAddressList[].ip String - IPアドレス
policy.sourceAddressList[].port String - ポート番号
  • addressZonedbtypefqdnの場合に表示
policy.sourceAddressList[].type String - Addressタイプ情報
  • ipmask | fqdn
    • ipmask: IPアドレスとサブネットマスクで定義されたアドレス
    • fqdn: Fully qualified domain name(完全修飾ドメイン名)
policy.sourceAddressList[].addressZone String - 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ゾーン
policy.sourceAddressList[].fqdn String - 完全修飾ドメイン名(FQDN)
policy.sourceAddressList[].dbAddressZone Boolean - DB Address Zoneかどうか
policy.sourceAddressList[].maskBit Integer - サブネットマスクのビット値
  • Secure Zone Advancedタイプの場合に表示
policy.sourceAddressGroupList[] Array - 出発地 Address Group情報
policy.sourceAddressGroupList[].addressGroupNo Integer - Address Groupに付与された固有番号
policy.sourceAddressGroupList[].addressGroupName String - Address Groupの名前
policy.sourceAddressGroupList[].description String - Address Groupの説明
policy.sourceAddressGroupList[].memberNo String - ユーザーの NAVERクラウドプラットフォーム会員番号
policy.sourceAddressGroupList[].instanceNo String - インスタンス作成時に付与された契約番号
policy.sourceAddressGroupList[].addressList[].addressNo Integer - Addressに付与された固有番号
policy.sourceAddressGroupList[].addressList[].memberNo String - ユーザーの NAVERクラウドプラットフォーム会員番号
policy.sourceAddressGroupList[].addressList[].instanceNo String - インスタンス作成時に付与された契約番号
policy.sourceAddressGroupList[].addressList[].name String - Addressの名前
policy.sourceAddressGroupList[].addressList[].ip String - IPアドレス
policy.sourceAddressGroupList[].addressList[].port String - ポート番号
  • addressZonedbtypefqdnの場合に表示
policy.sourceAddressGroupList[].addressList[].type String - Addressタイプ情報
  • ipmask | fqdn
    • ipmask: IPアドレスとサブネットマスクで定義されたアドレス
    • fqdn: Fully qualified domain name(完全修飾ドメイン名)
policy.sourceAddressGroupList[].addressList[].addressZone String - 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ゾーン
policy.sourceAddressGroupList[].addressList[].fqdn String - 完全修飾ドメイン名(FQDN)
policy.sourceAddressGroupList[].addressList[].dbAddressZone Boolean - DB Address Zoneかどうか
policy.sourceAddressGroupList[].addressList[].maskBit Integer - サブネットマスクのビット値
  • Secure Zone Advancedタイプの場合に表示
policy.sourceAddressGroupList[].addressZone String - 出発地 Address Groupが属するゾーンに関する情報
  • 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ゾーン
policy.sourceAddressGroupList[].associatedPoliciesCount Integer - 使用しない
policy.sourceAddressGroupList[].objectStorage Boolean - Object Storageの使用有無
  • true | false
    • true: Object Storageを使用
    • false: Object Storageを使用しない
policy.destinationAddressList[] Array - 目的地 Address情報
policy.destinationAddressList[].addressNo Integer - Addressに付与された固有番号
policy.destinationAddressList[].memberNo String - ユーザーの NAVERクラウドプラットフォーム会員番号
policy.destinationAddressList[].instanceNo String - インスタンス作成時に付与された契約番号
policy.destinationAddressList[].name String - Addressの名前
policy.destinationAddressList[].ip String - IPアドレス
policy.destinationAddressList[].port String - ポート番号
  • addressZonedbtypefqdnの場合に表示
policy.destinationAddressList[].type String - Addressタイプ情報
  • ipmask | fqdn
    • ipmask: IPアドレスとサブネットマスクで定義されたアドレス
    • fqdn: Fully qualified domain name(完全修飾ドメイン名)
policy.destinationAddressList[].addressZone String - 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ゾーン
policy.destinationAddressList[].fqdn String - 完全修飾ドメイン名(FQDN)
policy.destinationAddressList[].dbAddressZone Boolean - DB Address Zoneかどうか
policy.destinationAddressList[].maskBit Integer - サブネットマスクのビット値
  • Secure Zone Advancedタイプの場合に表示
policy.destinationAddressGroupList[] Array - 目的地 Address Group情報
policy.destinationAddressGroupList[].addressGroupNo Integer - Address Groupに付与された固有番号
policy.destinationAddressGroupList[].addressGroupName String - Address Groupの名前
policy.destinationAddressGroupList[].description String - Address Groupの説明
policy.destinationAddressGroupList[].memberNo String - ユーザーの NAVERクラウドプラットフォーム会員番号
policy.destinationAddressGroupList[].instanceNo String - インスタンス作成時に付与された契約番号
policy.destinationAddressGroupList[].addressList[].addressNo Integer - Addressに付与された固有番号
policy.destinationAddressGroupList[].addressList[].memberNo String - ユーザーの NAVERクラウドプラットフォーム会員番号
policy.destinationAddressGroupList[].addressList[].instanceNo String - インスタンス作成時に付与された契約番号
policy.destinationAddressGroupList[].addressList[].name String - Addressの名前
policy.destinationAddressGroupList[].addressList[].ip String - IPアドレス
policy.destinationAddressGroupList[].addressList[].port String - ポート番号
  • addressZonedbtypefqdnの場合に表示
policy.destinationAddressGroupList[].addressList[].type String - Addressタイプ情報
  • ipmask | fqdn
    • ipmask: IPアドレスとサブネットマスクで定義されたアドレス
    • fqdn: Fully qualified domain name(完全修飾ドメイン名)
policy.destinationAddressGroupList[].addressList[].addressZone String - 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ゾーン
policy.destinationAddressGroupList[].addressList[].fqdn String - 完全修飾ドメイン名(FQDN)
policy.destinationAddressGroupList[].addressList[].dbAddressZone Boolean - DB Address Zoneかどうか
policy.destinationAddressGroupList[].addressList[].maskBit Integer - サブネットマスクのビット値
  • Secure Zone Advancedタイプの場合に表示
policy.destinationAddressGroupList[].addressZone String - 目的地 Address Groupが属するゾーンに関する情報
  • 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ゾーン
policy.destinationAddressGroupList[].associatedPoliciesCount Integer - 使用しない
policy.destinationAddressGroupList[].objectStorage Boolean - Object Storageの使用有無
  • true | false
    • true: Object Storageを使用
    • false: Object Storageを使用しない
policy.sourceAddressZone String - ポリシーの出発地 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ゾーン
policy.destinationAddressZone String - ポリシーの目的地 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ゾーン
policy.serviceList[] Array - 照会対象ポリシーのサービス情報
policy.serviceList[].serviceNo Integer - ファイアウォールサービス番号
policy.serviceList[].serviceName String - ファイアウォールサービス名
policy.serviceList[].protocol String - ファイアウォールサービスのプロトコル
policy.serviceList[].port String - ファイアウォールサービスのポート番号
policy.serviceList[].memberNo String - ユーザーの NAVERクラウドプラットフォーム会員番号
policy.serviceList[].instanceNo String - インスタンス作成時に付与された契約番号
policy.firewallPolicyId Integer - ファイアウォールポリシーに付与された ID
policy.firewallOrder Integer - ファイアウォールポリシーの順序

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

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

レスポンス例

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

{
    "action": "getPolicy",
    "returnCode": 0,
    "returnMessage": "success",
    "policy": {
        "policyNo": 11787,
        "policyName": "pol1",
        "description": "policy1",
        "action": "allow",
        "memberNo": "27***85",
        "instanceNo": "25****11",
        "sourceAddressList": [
            {
                "addressNo": 3643,
                "memberNo": "27***85",
                "instanceNo": "25****11",
                "name": "sv-securezone",
                "ip": "***.***.***.***",
                "type": "ipmask",
                "addressZone": "sz"
            }
        ],
        "sourceAddressGroupList": [],
        "destinationAddressList": [],
        "destinationAddressGroupList": [
            {
                "addressGroupNo": 5432,
                "addressGroupName": "Object Storage",
                "description": "object storage address group",
                "memberNo": "27***85",
                "instanceNo": "25****11",
                "addressList": [],
                "addressZone": "vm",
                "associatedPoliciesCount": 0,
                "objectStorage": true
            }
        ],
        "sourceAddressZone": "sz",
        "destinationAddressZone": "os",
        "serviceList": [
            {
                "serviceNo": 1371,
                "serviceName": "TCP_443",
                "protocol": "TCP",
                "port": "443",
                "memberNo": "27***85",
                "instanceNo": "25****11"
            }
        ],
        "firewallPolicyId": 1,
        "firewallOrder": 1
    }
}