getPolicy
    • PDF

    getPolicy

    • PDF

    記事の要約

    Classic環境で利用できます。

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

    リクエスト

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

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

    リクエストヘッダ

    Secure Zone APIで共通して使用されるヘッダの詳細は、Secure Zoneのリクエストヘッダをご参照ください。

    リクエストパスパラメータ

    パラメータの説明は次の通りです。

    フィールドタイプ必須の有無説明
    typeStringRequiredSecure Zoneで提供するファイアウォールタイプ
    • szfw | psfw
      • szfw: Secure Zone Standard
      • psfw: Secure Zone Advanced
    zoneStringRequiredSecure Zoneを構成したゾーン
    • kr1 | kr2
      • kr1: KR-1ゾーン
      • kr2: KR-2ゾーン

    リクエストボディ

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

    フィールドタイプ必須の有無説明
    policyNameStringConditional照会対象のポリシー名
    • getPolicyListを通じて確認
    • policyNoが指定されていない場合、必須
    policyNoStringConditionalポリシーに付与された固有番号
    • 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
    }'
    

    レスポンス

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

    レスポンスボディ

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

    フィールドタイプ必須の有無説明
    actionString-リクエストタイプ
    returnCodeInteger-レスポンスコード
    returnMessageString-レスポンスメッセージ
    policyList<String>-照会対象のポリシー情報
    policy.policyNoInteger-ポリシーに付与された固有番号
    policy.policyNameString-ポリシー名
    policy.descriptionString-ポリシーの説明
    policy.actionString-許可するかどうか
    • allow | deny
    policy.memberNoString-ユーザーの NAVERクラウドプラットフォーム会員番号
    policy.instanceNoString-インスタンス作成時に付与された契約番号
    policy.sourceAddressList[]Array-出発地 Address情報
    policy.sourceAddressList[].addressNoInteger-Addressに付与された固有番号
    policy.sourceAddressList[].memberNoString-ユーザーの NAVERクラウドプラットフォーム会員番号
    policy.sourceAddressList[].instanceNoString-インスタンス作成時に付与された契約番号
    policy.sourceAddressList[].nameString-Addressの名前
    policy.sourceAddressList[].ipString-IPアドレス
    policy.sourceAddressList[].portString-ポート番号
    • addressZonedbtypefqdnの場合に表示
    policy.sourceAddressList[].typeString-Addressタイプ情報
    • ipmask | fqdn
      • ipmask: IPアドレスとサブネットマスクで定義されたアドレス
      • fqdn: Fully qualified domain name(完全修飾ドメイン名)
    policy.sourceAddressList[].addressZoneString-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[].fqdnString-完全修飾ドメイン名(FQDN)
    policy.sourceAddressList[].dbAddressZoneBoolean-DB Address Zoneかどうか
    policy.sourceAddressList[].maskBitInteger-サブネットマスクのビット値
    • Secure Zone Advancedタイプの場合に表示
    policy.sourceAddressGroupList[]Array-出発地 Address Group情報
    policy.sourceAddressGroupList[].addressGroupNoInteger-Address Groupに付与された固有番号
    policy.sourceAddressGroupList[].addressGroupNameString-Address Groupの名前
    policy.sourceAddressGroupList[].descriptionString-Address Groupの説明
    policy.sourceAddressGroupList[].memberNoString-ユーザーの NAVERクラウドプラットフォーム会員番号
    policy.sourceAddressGroupList[].instanceNoString-インスタンス作成時に付与された契約番号
    policy.sourceAddressGroupList[].addressList[].addressNoInteger-Addressに付与された固有番号
    policy.sourceAddressGroupList[].addressList[].memberNoString-ユーザーの NAVERクラウドプラットフォーム会員番号
    policy.sourceAddressGroupList[].addressList[].instanceNoString-インスタンス作成時に付与された契約番号
    policy.sourceAddressGroupList[].addressList[].nameString-Addressの名前
    policy.sourceAddressGroupList[].addressList[].ipString-IPアドレス
    policy.sourceAddressGroupList[].addressList[].portString-ポート番号
    • addressZonedbtypefqdnの場合に表示
    policy.sourceAddressGroupList[].addressList[].typeString-Addressタイプ情報
    • ipmask | fqdn
      • ipmask: IPアドレスとサブネットマスクで定義されたアドレス
      • fqdn: Fully qualified domain name(完全修飾ドメイン名)
    policy.sourceAddressGroupList[].addressList[].addressZoneString-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[].fqdnString-完全修飾ドメイン名(FQDN)
    policy.sourceAddressGroupList[].addressList[].dbAddressZoneBoolean-DB Address Zoneかどうか
    policy.sourceAddressGroupList[].addressList[].maskBitInteger-サブネットマスクのビット値
    • Secure Zone Advancedタイプの場合に表示
    policy.sourceAddressGroupList[].addressZoneString-出発地 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[].associatedPoliciesCountInteger-使用しない
    policy.sourceAddressGroupList[].objectStorageBoolean-Object Storageの使用有無
    • true | false
      • true: Object Storageを使用
      • false: Object Storageを使用しない
    policy.destinationAddressList[]Array-目的地 Address情報
    policy.destinationAddressList[].addressNoInteger-Addressに付与された固有番号
    policy.destinationAddressList[].memberNoString-ユーザーの NAVERクラウドプラットフォーム会員番号
    policy.destinationAddressList[].instanceNoString-インスタンス作成時に付与された契約番号
    policy.destinationAddressList[].nameString-Addressの名前
    policy.destinationAddressList[].ipString-IPアドレス
    policy.destinationAddressList[].portString-ポート番号
    • addressZonedbtypefqdnの場合に表示
    policy.destinationAddressList[].typeString-Addressタイプ情報
    • ipmask | fqdn
      • ipmask: IPアドレスとサブネットマスクで定義されたアドレス
      • fqdn: Fully qualified domain name(完全修飾ドメイン名)
    policy.destinationAddressList[].addressZoneString-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[].fqdnString-完全修飾ドメイン名(FQDN)
    policy.destinationAddressList[].dbAddressZoneBoolean-DB Address Zoneかどうか
    policy.destinationAddressList[].maskBitInteger-サブネットマスクのビット値
    • Secure Zone Advancedタイプの場合に表示
    policy.destinationAddressGroupList[]Array-目的地 Address Group情報
    policy.destinationAddressGroupList[].addressGroupNoInteger-Address Groupに付与された固有番号
    policy.destinationAddressGroupList[].addressGroupNameString-Address Groupの名前
    policy.destinationAddressGroupList[].descriptionString-Address Groupの説明
    policy.destinationAddressGroupList[].memberNoString-ユーザーの NAVERクラウドプラットフォーム会員番号
    policy.destinationAddressGroupList[].instanceNoString-インスタンス作成時に付与された契約番号
    policy.destinationAddressGroupList[].addressList[].addressNoInteger-Addressに付与された固有番号
    policy.destinationAddressGroupList[].addressList[].memberNoString-ユーザーの NAVERクラウドプラットフォーム会員番号
    policy.destinationAddressGroupList[].addressList[].instanceNoString-インスタンス作成時に付与された契約番号
    policy.destinationAddressGroupList[].addressList[].nameString-Addressの名前
    policy.destinationAddressGroupList[].addressList[].ipString-IPアドレス
    policy.destinationAddressGroupList[].addressList[].portString-ポート番号
    • addressZonedbtypefqdnの場合に表示
    policy.destinationAddressGroupList[].addressList[].typeString-Addressタイプ情報
    • ipmask | fqdn
      • ipmask: IPアドレスとサブネットマスクで定義されたアドレス
      • fqdn: Fully qualified domain name(完全修飾ドメイン名)
    policy.destinationAddressGroupList[].addressList[].addressZoneString-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[].fqdnString-完全修飾ドメイン名(FQDN)
    policy.destinationAddressGroupList[].addressList[].dbAddressZoneBoolean-DB Address Zoneかどうか
    policy.destinationAddressGroupList[].addressList[].maskBitInteger-サブネットマスクのビット値
    • Secure Zone Advancedタイプの場合に表示
    policy.destinationAddressGroupList[].addressZoneString-目的地 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[].associatedPoliciesCountInteger-使用しない
    policy.destinationAddressGroupList[].objectStorageBoolean-Object Storageの使用有無
    • true | false
      • true: Object Storageを使用
      • false: Object Storageを使用しない
    policy.sourceAddressZoneString-ポリシーの出発地 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.destinationAddressZoneString-ポリシーの目的地 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[].serviceNoInteger-ファイアウォールサービス番号
    policy.serviceList[].serviceNameString-ファイアウォールサービス名
    policy.serviceList[].protocolString-ファイアウォールサービスのプロトコル
    policy.serviceList[].portString-ファイアウォールサービスのポート番号
    policy.serviceList[].memberNoString-ユーザーの NAVERクラウドプラットフォーム会員番号
    policy.serviceList[].instanceNoString-インスタンス作成時に付与された契約番号
    policy.firewallPolicyIdInteger-ファイアウォールポリシーに付与された ID
    policy.firewallOrderInteger-ファイアウォールポリシーの順序

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

    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
        }
    }
    

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

    What's Next
    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.