getAddressGroupList
    • PDF

    getAddressGroupList

    • PDF

    記事の要約

    Classic環境で利用できます。

    Address Groupリストを照会します。

    リクエスト

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

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

    リクエストヘッダ

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

    リクエストボディ

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

    フィールドタイプ必須の有無説明
    addressGroupNameStringOptionalAddress Groupの名前
    addressGroupNoIntegerOptionalAddress Groupに付与された固有番号
    addressZoneStringOptionalAddressが属するゾーンに関する情報
    • 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ゾーン
    countPerPageIntegerOptionalページごとの項目数
    • 20(デフォルト)
    pageIntegerOptionalページインデックス
    • 1(デフォルト)

    リクエスト例

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

    curl --location --request POST 'https://securezonefirewall.apigw.ntruss.com/api/v2/szfw/kr2/getAddressGroupList'
    --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
    }'
    

    レスポンス

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

    レスポンスボディ

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

    フィールドタイプ必須の有無説明
    actionString-リクエストタイプ
    returnCodeInteger-レスポンスコード
    returnMessageString-レスポンスメッセージ
    totalCountInteger-Address Groupの総数
    addressGroupList[]Array-照会対象の Address Groupリスト
    addressGroupList[].addressGroupNoInteger-Address Groupに付与された固有番号
    addressGroupList[].addressGroupNameString-Address Group名
    addressGroupList[].descriptionString-Address Groupの説明
    addressGroupList[].memberNoString-ユーザーの NAVERクラウドプラットフォーム会員番号
    addressGroupList[].instanceNoString-インスタンス作成時に付与された契約番号
    addressGroupList[].addressList[]Array-Address Groupに属する Address情報
    addressGroupList[].addressList[].addressNoInteger-Addressに付与された固有番号
    addressGroupList[].addressList[].memberNoString-ユーザーの NAVERクラウドプラットフォーム会員番号
    addressGroupList[].addressList[].instanceNoString-インスタンス作成時に付与された契約番号
    addressGroupList[].addressList[].nameString-Addressの名前
    addressGroupList[].addressList[].ipString-IPアドレス
    addressGroupList[].addressList[].portInteger-ポート番号
    • addressZonedbtypefqdnの場合に表示
    addressGroupList[].addressList[].typeString-Addressタイプ情報
    • ipmask | fqdn
      • ipmask: IPアドレスとサブネットマスクで定義されたアドレス
      • fqdn: Fully qualified domain name(完全修飾ドメイン名)
    addressGroupList[].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ゾーン
    addressGroupList[].addressList[].fqdnString-完全修飾ドメイン名(FQDN)
    • typefqdnの場合に表示
    addressGroupList[].addressList[].dbAddressZoneBoolean-DB Address Zoneかどうか
    addressGroupList[].addressList[].maskBitInteger-サブネットマスクのビット値
    • Secure Zone Advancedタイプの場合に表示
    addressGroupList[].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ゾーン
    addressGroupList[].associatedPoliciesCountInteger-使用しない
    addressGroupList[].objectStorageBoolean-Object Storageの使用有無
    • true | false
      • true: Object Storageを使用
      • false: Object Storageを使用しない

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

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

    レスポンス例

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

    {
        "action": "getAddressGroupList",
        "returnCode": 0,
        "returnMessage": "success",
        "totalCount": 2,
        "addressGroupList": [
            {
                "addressGroupNo": 5452,
                "addressGroupName": "dbgroup",
                "description": "",
                "memberNo": "2795985",
                "instanceNo": "25200511",
                "addressList": [
                    {
                        "addressNo": 3646,
                        "memberNo": "27***85",
                        "instanceNo": "25****11",
                        "name": "test-db-001",
                        "ip": "***.***.***.***",
                        "port": "3306",
                        "type": "fqdn",
                        "addressZone": "db",
                        "fqdn": "db-****.cdb.ntruss.com"
                    }
                ],
                "addressZone": "db",
                "associatedPoliciesCount": 0,
                "objectStorage": false
            },
            {
                "addressGroupNo": 5438,
                "addressGroupName": "grp1",
                "description": "",
                "memberNo": "27***85",
                "instanceNo": "25****11",
                "addressList": [
                    {
                        "addressNo": 3644,
                        "memberNo": "27***85",
                        "instanceNo": "25****11",
                        "name": "s1906cf93f79",
                        "ip": "***.***.***.***",
                        "type": "ipmask",
                        "addressZone": "sz"
                    }
                ],
                "addressZone": "sz",
                "associatedPoliciesCount": 0,
                "objectStorage": false
            }
        ]
    }
    

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

    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.