Component-FW - Flexible InterConnect API リファレンス (2.0.0)

Download OpenAPI specification:Download

Flexible InterConnect

概要

本APIでは、Flexible InterConnectが提供するリソースの参照・操作が可能です。

ファイアウォール情報の取得・変更・廃止等の操作と、アクティベート実行・ディアクティベート実行に関するAPIドキュメントです。

Firewall-Component

List Firewalls

指定したルーターのファイアウォール情報の一覧を取得します。

path Parameters

router_id

required

string

query Parameters

id	string <uuid> ^F[0-9]{12}$ Example: id=F040123456789 ファイアウォールID
resourceGroup	string Example: resourceGroup=FW01-jpeast01 故障やメンテナンスにて影響を受ける範囲毎に割り当てられたグループ

header Parameters

Content-Type required	string Value: "application/json"
X-Auth-Token required	string ^[0-9a-f]{32}$ Example: dc03494823a841338430052e9ee95e07 クライアントが Keystone を利用して取得した認証 Token

Responses

200

OK 成功しました

400

Bad Request リクエストが不正

401

Unauthorized 認証エラー

404

Not Found 未検出エラー

409

Conflict 競合エラー

get/v1/routers/{router_id}/firewalls

https://api.ntt.com/fic-eri/v1/routers/{router_id}/firewalls

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"firewalls": 
[
{"id": "F040123456789",
"tenantId": "080f290761484afabbec22938adc6a2e",
"redundant": false,
"isActivated": true,
"operationStatus": "Completed",
"customApplications": 
[
{"name": "google-drive-web",
"protocol": "tcp",
"destinationPort": "443"
}
],
"applicationSets": 
[
{"name": "app_set_1",
"applications": 
["google-drive-web",
"pre-defined-ftp"
]
}
],
"routingGroupSettings": 
[
{"groupName": "group_1",
"addressSets": 
[
{"name": "group1_addset_1",
"addresses": 
["172.18.1.0/24"
]
}
]
},
{"groupName": "group_2",
"addressSets": 
[
{"name": "group2_addset_1",
"addresses": 
["192.168.1.0/24"
]
}
]
},
{"groupName": "group_3",
"addressSets": [ ]
},
{"groupName": "group_4",
"addressSets": [ ]
}
],
"rules": 
[
{"from": "group_1",
"to": "group_2",
"entries": 
[
{"name": "rule-01",
"match": 
{"sourceAddressSets": 
["group1_addset_1"
],
"destinationAddressSets": 
["group2_addset_1"
],
"application": "app_set_1"
},
"action": "permit"
}
]
}
],
"userIpAddresses": 
["192.168.0.0/30",
"192.168.0.4/30",
"192.168.0.8/30",
"192.168.0.12/30"
],
"resourceGroup": 
{"component": "FW01-jpeast01"
}
}
]
}

Show Firewall

指定したファイアウォールの詳細情報を取得します。

path Parameters

router_id required	string
firewall_id required	string

header Parameters

Content-Type required	string Value: "application/json"
X-Auth-Token required	string ^[0-9a-f]{32}$ Example: dc03494823a841338430052e9ee95e07 クライアントが Keystone を利用して取得した認証 Token

Responses

200

OK 成功しました

400

Bad Request リクエストが不正

401

Unauthorized 認証エラー

404

Not Found 未検出エラー

409

Conflict 競合エラー

get/v1/routers/{router_id}/firewalls/{firewall_id}

https://api.ntt.com/fic-eri/v1/routers/{router_id}/firewalls/{firewall_id}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"firewall": 
{"id": "F040123456789",
"tenantId": "080f290761484afabbec22938adc6a2e",
"redundant": false,
"isActivated": true,
"operationStatus": "Processing",
"customApplications": 
[
{"name": "google-drive-web",
"protocol": "tcp",
"destinationPort": "443"
}
],
"applicationSets": 
[
{"name": "app_set_1",
"applications": 
["google-drive-web",
"pre-defined-ftp"
]
}
],
"routingGroupSettings": 
[
{"groupName": "group_1",
"addressSets": 
[
{"name": "group1_addset_1",
"addresses": 
["172.18.1.0/24"
]
}
]
},
{"groupName": "group_2",
"addressSets": 
[
{"name": "group2_addset_1",
"addresses": 
["192.168.1.0/24"
]
}
]
},
{"groupName": "group_3",
"addressSets": [ ]
},
{"groupName": "group_4",
"addressSets": [ ]
}
],
"rules": 
[
{"from": "group_1",
"to": "group_2",
"entries": 
[
{"name": "rule-01",
"match": 
{"sourceAddressSets": 
["group1_addset_1"
],
"destinationAddressSets": 
["group2_addset_1"
],
"application": "app_set_1"
},
"action": "permit"
}
]
}
],
"userIpAddresses": 
["192.168.0.0/30",
"192.168.0.4/30",
"192.168.0.8/30",
"192.168.0.12/30"
],
"resourceGroup": 
{"component": "FW01-jpeast01"
}
}
}

Update Firewall

指定したファイアウォールを変更します。

path Parameters

router_id required	string
firewall_id required	string

header Parameters

Content-Type required	string Value: "application/json"
X-Auth-Token required	string ^[0-9a-f]{32}$ Example: dc03494823a841338430052e9ee95e07 クライアントが Keystone を利用して取得した認証 Token

Request Body schema: application/json

firewall

required

object

Responses

202

Accepted 要求は受け付けられました

400

Bad Request リクエストが不正

401

Unauthorized 認証エラー

404

Not Found 未検出エラー

409

Conflict 競合エラー

put/v1/routers/{router_id}/firewalls/{firewall_id}

https://api.ntt.com/fic-eri/v1/routers/{router_id}/firewalls/{firewall_id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"firewall": 
{"rules": 
[
{"from": "group_1",
"to": "group_2",
"entries": 
[
{"name": "rule-01",
"match": 
{"sourceAddressSets": 
["group1_addset_1"
],
"destinationAddressSets": 
["group2_addset_1"
],
"application": "app_set_1"
},
"action": "permit"
}
]
}
],
"customApplications": 
[
{"name": "google-drive-web",
"protocol": "tcp",
"destinationPort": "443"
}
],
"applicationSets": 
[
{"name": "app_set_1",
"applications": 
["google-drive-web",
"pre-defined-ftp"
]
}
],
"routingGroupSettings": 
[
{"groupName": "group_1",
"addressSets": 
[
{"name": "group1_addset_1",
"addresses": 
["172.18.1.0/24"
]
}
]
},
{"groupName": "group_2",
"addressSets": 
[
{"name": "group2_addset_1",
"addresses": 
["192.168.1.0/24"
]
}
]
},
{"groupName": "group_3",
"addressSets": [ ]
},
{"groupName": "group_4",
"addressSets": [ ]
}
]
}
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"firewall": 
{"id": "F040123456789",
"tenantId": "080f290761484afabbec22938adc6a2e",
"redundant": false,
"isActivated": true,
"operationStatus": "Processing",
"customApplications": 
[
{"name": "google-drive-web",
"protocol": "tcp",
"destinationPort": "443"
}
],
"applicationSets": 
[
{"name": "app_set_1",
"applications": 
["google-drive-web",
"pre-defined-ftp"
]
}
],
"routingGroupSettings": 
[
{"groupName": "group_1",
"addressSets": 
[
{"name": "group1_addset_1",
"addresses": 
["172.18.1.0/24"
]
}
]
},
{"groupName": "group_2",
"addressSets": 
[
{"name": "group2_addset_1",
"addresses": 
["192.168.1.0/24"
]
}
]
},
{"groupName": "group_3",
"addressSets": [ ]
},
{"groupName": "group_4",
"addressSets": [ ]
}
],
"rules": 
[
{"from": "group_1",
"to": "group_2",
"entries": 
[
{"name": "rule-01",
"match": 
{"sourceAddressSets": 
["group1_addset_1"
],
"destinationAddressSets": 
["group2_addset_1"
],
"application": "app_set_1"
},
"action": "permit"
}
]
}
],
"userIpAddresses": 
["192.168.0.0/30",
"192.168.0.4/30",
"192.168.0.8/30",
"192.168.0.12/30"
],
"operationId": "2fb5baa5a5834e0b952d3f0d93c3e64a",
"resourceGroup": 
{"component": "FW01-jpeast01"
}
}
}

Activate Firewall

指定したルーターでファイアウォールのアクティベートを実行します。

サービス概要や、注意事項等の詳細情報に関しましてはこちらをご参照下さい。

事前にお客様にご準備いただくものや、画面での操作に関しましてはこちらをご参照下さい。

path Parameters

router_id required	string
firewall_id required	string

header Parameters

Content-Type required	string Value: "application/json"
X-Auth-Token required	string ^[0-9a-f]{32}$ Example: dc03494823a841338430052e9ee95e07 クライアントが Keystone を利用して取得した認証 Token

Request Body schema: application/json

firewall

object

[optional] 借用アドレス。FW や NAT などの接続で使う。NAT を activate していない場合、指定必須。 NAT を activate している場合、指定不可。 router が single なら /30 x 4、paired なら /30 x 8。同じアドレスの指定は不可

Responses

202

Accepted 要求は受け付けられました

400

Bad Request リクエストが不正

401

Unauthorized 認証エラー

404

Not Found 未検出エラー

409

Conflict 競合エラー

post/v1/routers/{router_id}/firewalls/{firewall_id}/activate

https://api.ntt.com/fic-eri/v1/routers/{router_id}/firewalls/{firewall_id}/activate

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"firewall": 
{"userIpAddresses": 
["192.168.0.0/30",
"192.168.0.4/30",
"192.168.0.8/30",
"192.168.0.12/30"
]
}
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"firewall": 
{"id": "F040123456789",
"tenantId": "080f290761484afabbec22938adc6a2e",
"redundant": false,
"isActivated": true,
"operationStatus": "Processing",
"customApplications": [ ],
"applicationSets": [ ],
"routingGroupSettings": [ ],
"rules": [ ],
"userIpAddresses": 
["192.168.0.0/30",
"192.168.0.4/30",
"192.168.0.8/30",
"192.168.0.12/30"
],
"operationId": "4c7b0bfc17e84e9eae7b4d779f30dea1",
"resourceGroup": 
{"component": null
}
}
}

Deactivate Firewall

指定したファイアウォールのディアクティベートを実行します。

path Parameters

router_id required	string
firewall_id required	string

header Parameters

Content-Type required	string Value: "application/json"
X-Auth-Token required	string ^[0-9a-f]{32}$ Example: dc03494823a841338430052e9ee95e07 クライアントが Keystone を利用して取得した認証 Token

Responses

202

Accepted 要求は受け付けられました

400

Bad Request リクエストが不正

401

Unauthorized 認証エラー

404

Not Found 未検出エラー

409

Conflict 競合エラー

post/v1/routers/{router_id}/firewalls/{firewall_id}/deactivate

https://api.ntt.com/fic-eri/v1/routers/{router_id}/firewalls/{firewall_id}/deactivate

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"firewall": 
{"id": "F040123456789",
"tenantId": "080f290761484afabbec22938adc6a2e",
"redundant": false,
"isActivated": false,
"operationStatus": "Processing",
"customApplications": [ ],
"applicationSets": [ ],
"routingGroupSettings": [ ],
"rules": [ ],
"userIpAddresses": [ ],
"operationId": "d40999c03a7642c6b86158889c7bebc9",
"resourceGroup": 
{"component": "FW01-jpeast01"
}
}
}