getPolicyList

Prev Next

Classic環境で利用できます。

ファイアウォールポリシーリストを照会します。

リクエスト

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

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

リクエストヘッダ

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

リクエストボディ

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

フィールド タイプ 必須の有無 説明
page Integer Optional ページインデックス
  • 0(デフォルト)
countPerPage Integer Optional ページごとの項目数
  • 0(デフォルト)

リクエスト例

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

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

レスポンス

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

レスポンスボディ

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

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

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

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

レスポンス例

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

{
  "action": "getPolicyList",
  "returnCode": 0,
  "returnMessage": "success",
  "totalCount": 1,
  "policyList": [
    {
      "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
    }
  ]
}