getAddressGroup

Classic環境で利用できます。

Address Groupの中で特定のグループの情報を照会します。

リクエスト

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

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

リクエストヘッダ

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

リクエストボディ

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

フィールド	タイプ	必須の有無	説明
`addressGroupName`	String	Conditional	Address Group名 getAddressGroupListを通じて確認 `addressGroupNo`が指定されていない場合、必須両方とも指定されていない場合、デフォルトは nullに設定
`addressGroupNo`	Integer	Conditional	Address Groupに付与された固有番号 getAddressGroupListを通じて確認 `addressGroupName`が指定されていない場合、必須両方とも指定されていない場合、デフォルトは nullに設定
`countPerPage`	Integer	Optional	ページごとの項目数 20(デフォルト)
`page`	Integer	Optional	ページインデックス 1(デフォルト)

リクエスト例

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

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

レスポンス

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

レスポンスボディ

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

フィールド	タイプ	必須の有無	説明
`action`	String	-	リクエストタイプ
`returnCode`	Integer	-	レスポンスコード
`returnMessage`	String	-	レスポンスメッセージ
`addressGroup`	List<String>	-	照会対象の Address Group情報
`addressGroup.addressGroupNo`	Integer	-	Address Groupに付与された固有番号
`addressGroup.addressGroupName`	String	-	Address Group名
`addressGroup.description`	String	-	Address Groupの説明
`addressGroup.memberNo`	String	-	ユーザーの NAVERクラウドプラットフォーム会員番号
`addressGroup.instanceNo`	String	-	インスタンス作成時に付与された契約番号
`addressGroup.addressList[]`	Array	-	Address Groupに属する Address情報
`addressGroup.addressList[].addressNo`	Integer	-	Addressに付与された固有番号
`addressGroup.addressList[].memberNo`	String	-	ユーザーの NAVERクラウドプラットフォーム会員番号
`addressGroup.addressList[].instanceNo`	String	-	インスタンス作成時に付与された契約番号
`addressGroup.addressList[].name`	String	-	Addressの名前
`addressGroup.addressList[].ip`	String	-	IPアドレス
`addressGroup.addressList[].port`	Integer	-	ポート番号 `addressZone`が`db`で`type`が`fqdn`の場合に表示
`addressGroup.addressList[].type`	String	-	Addressタイプ情報 `ipmask` \| `fqdn` `ipmask`: IPアドレスとサブネットマスクで定義されたアドレス `fqdn`: Fully qualified domain name(完全修飾ドメイン名)
`addressGroup.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ゾーン
`addressGroup.addressList[].fqdn`	String	-	完全修飾ドメイン名(FQDN) `type`が`fqdn`の場合に表示
`addressGroup.addressList[].dbAddressZone`	Boolean	-	DB Address Zoneかどうか
`addressGroup.addressList[].maskBit`	Integer	-	サブネットマスクのビット値 Secure Zone Advancedタイプの場合に表示
`addressGroup.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ゾーン
`addressGroup.associatedPoliciesCount`	Integer	-	使用しない
`addressGroup.objectStorage`	Boolean	-	Object Storageの使用有無 `true` \| `false` `true`: Object Storageを使用 `false`: Object Storageを使用しない

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

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

レスポンス例

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

{
    "action": "getAddressGroup",
    "returnCode": 0,
    "returnMessage": "success",
    "addressGroup": {
        "addressGroupNo": 5452,
        "addressGroupName": "dbgroup",
        "description": "",
        "memberNo": "27***85",
        "instanceNo": "25****11",
        "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
    }
}