getAddressGroupList
- 印刷する
- PDF
getAddressGroupList
- 印刷する
- PDF
記事の要約
この要約は役に立ちましたか?
ご意見ありがとうございます
Classic環境で利用できます。
Address Groupリストを照会します。
リクエスト
リクエスト形式を説明します。リクエスト形式は次の通りです。
メソッド | URI |
---|---|
POST | /{type}/{zone}/getAddressGroupList |
リクエストヘッダ
Secure Zone APIで共通して使用されるヘッダの詳細は、Secure Zoneのリクエストヘッダをご参照ください。
リクエストパスパラメータ
パラメータの説明は次の通りです。
フィールド | タイプ | 必須の有無 | 説明 |
---|---|---|---|
type | String | Required | Secure Zoneで提供するファイアウォールタイプ
|
zone | String | Required | Secure Zoneを構成したゾーン
|
リクエストボディ
リクエストボディの説明は次の通りです。
フィールド | タイプ | 必須の有無 | 説明 |
---|---|---|---|
addressGroupName | String | Optional | Address Groupの名前 |
addressGroupNo | Integer | Optional | Address Groupに付与された固有番号 |
addressZone | String | Optional | Addressが属するゾーンに関する情報
|
countPerPage | Integer | Optional | ページごとの項目数
|
page | Integer | Optional | ページインデックス
|
リクエスト例
リクエストのサンプルコードは次の通りです。
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
}'
レスポンス
レスポンス形式を説明します。
レスポンスボディ
レスポンスボディの説明は次の通りです。
フィールド | タイプ | 必須の有無 | 説明 |
---|---|---|---|
action | String | - | リクエストタイプ |
returnCode | Integer | - | レスポンスコード |
returnMessage | String | - | レスポンスメッセージ |
totalCount | Integer | - | Address Groupの総数 |
addressGroupList[] | Array | - | 照会対象の Address Groupリスト |
addressGroupList[].addressGroupNo | Integer | - | Address Groupに付与された固有番号 |
addressGroupList[].addressGroupName | String | - | Address Group名 |
addressGroupList[].description | String | - | Address Groupの説明 |
addressGroupList[].memberNo | String | - | ユーザーの NAVERクラウドプラットフォーム会員番号 |
addressGroupList[].instanceNo | String | - | インスタンス作成時に付与された契約番号 |
addressGroupList[].addressList[] | Array | - | Address Groupに属する Address情報 |
addressGroupList[].addressList[].addressNo | Integer | - | Addressに付与された固有番号 |
addressGroupList[].addressList[].memberNo | String | - | ユーザーの NAVERクラウドプラットフォーム会員番号 |
addressGroupList[].addressList[].instanceNo | String | - | インスタンス作成時に付与された契約番号 |
addressGroupList[].addressList[].name | String | - | Addressの名前 |
addressGroupList[].addressList[].ip | String | - | IPアドレス |
addressGroupList[].addressList[].port | Integer | - | ポート番号
|
addressGroupList[].addressList[].type | String | - | Addressタイプ情報
|
addressGroupList[].addressList[].addressZone | String | - | Addressが属するゾーンに関する情報
|
addressGroupList[].addressList[].fqdn | String | - | 完全修飾ドメイン名(FQDN)
|
addressGroupList[].addressList[].dbAddressZone | Boolean | - | DB Address Zoneかどうか |
addressGroupList[].addressList[].maskBit | Integer | - | サブネットマスクのビット値
|
addressGroupList[].addressZone | String | - | Addressが属するゾーンに関する情報
|
addressGroupList[].associatedPoliciesCount | Integer | - | 使用しない |
addressGroupList[].objectStorage | Boolean | - | 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
}
]
}
この記事は役に立ちましたか?