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

Download OpenAPI specification:Download

Flexible InterConnect

概要

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

NAT情報の取得・変更等の操作と、アクティベート実行・ディアクティベート実行に加え、グローバルIPアドレスセット情報の取得・購入・変更・廃止等の操作に関するAPIドキュメントです。

NAT-Component

List NATs

指定したルーターのNAT情報の一覧を取得します。

path Parameters

router_id

required

any

UUID

query Parameters

id	string ^F[0-9]{12}$ Example: id=F050123456789 NAT 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}/nats

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

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"nats": 
[
{"id": "F050123456789",
"tenantId": "080f290761484afabbec22938adc6a2e",
"redundant": false,
"isActivated": true,
"operationStatus": "Processing",
"sourceNaptRules": 
[
{"from": 
["group_1"
],
"to": "group_2",
"entries": 
[
{"then": 
["src-set-01",
"src-set-02",
"src-set-03",
"src-set-04"
]
}
]
},
{"from": 
["group_2"
],
"to": "group_1",
"entries": 
[
{"then": 
["src-set-05",
"src-set-06",
"src-set-07",
"src-set-08"
]
}
]
}
],
"destinationNatRules": 
[
{"from": "group_1",
"to": "group_2",
"entries": 
[
{"match": 
{"destinationAddress": "dst-set-01"
},
"then": "192.168.0.1/32"
},
{"match": 
{"destinationAddress": "dst-set-02"
},
"then": "192.168.0.2/32"
}
]
},
{"from": "group_2",
"to": "group_1",
"entries": 
[
{"match": 
{"destinationAddress": "dst-set-03"
},
"then": "192.168.0.3/32"
},
{"match": 
{"destinationAddress": "dst-set-04"
},
"then": "192.168.0.4/32"
}
]
}
],
"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 NAT

指定したNATの詳細情報を取得します。

path Parameters

nat_id required	string
router_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}/nats/{nat_id}

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

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"nat": 
{"id": "F050123456789",
"tenantId": "080f290761484afabbec22938adc6a2e",
"redundant": false,
"isActivated": true,
"operationStatus": "Processing",
"sourceNaptRules": 
[
{"from": 
["group_1"
],
"to": "group_2",
"entries": 
[
{"then": 
["src-set-01",
"src-set-02",
"src-set-03",
"src-set-04"
]
}
]
},
{"from": 
["group_2"
],
"to": "group_1",
"entries": 
[
{"then": 
["src-set-05",
"src-set-06",
"src-set-07",
"src-set-08"
]
}
]
}
],
"destinationNatRules": 
[
{"from": "group_1",
"to": "group_2",
"entries": 
[
{"match": 
{"destinationAddress": "dst-set-01"
},
"then": "192.168.0.1/32"
},
{"match": 
{"destinationAddress": "dst-set-02"
},
"then": "192.168.0.2/32"
}
]
},
{"from": "group_2",
"to": "group_1",
"entries": 
[
{"match": 
{"destinationAddress": "dst-set-03"
},
"then": "192.168.0.3/32"
},
{"match": 
{"destinationAddress": "dst-set-04"
},
"then": "192.168.0.4/32"
}
]
}
],
"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 NAT

指定したNATを変更します。

path Parameters

nat_id required	string
router_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

nat

required

object

Responses

202

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

400

Bad Request リクエストが不正

401

Unauthorized 認証エラー

404

Not Found 未検出エラー

409

Conflict 競合エラー

put/v1/routers/{router_id}/nats/{nat_id}

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

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"nat": 
{"sourceNaptRules": 
[
{"from": 
["group_1"
],
"to": "group_2",
"entries": 
[
{"then": 
["src-set-01",
"src-set-02",
"src-set-03",
"src-set-04"
]
}
]
},
{"from": 
["group_2"
],
"to": "group_1",
"entries": 
[
{"then": 
["src-set-05",
"src-set-06",
"src-set-07",
"src-set-08"
]
}
]
}
],
"destinationNatRules": 
[
{"from": "group_1",
"to": "group_2",
"entries": 
[
{"match": 
{"destinationAddress": "dst-set-01"
},
"then": "192.168.0.1/32"
},
{"match": 
{"destinationAddress": "dst-set-02"
},
"then": "192.168.0.2/32"
}
]
},
{"from": "group_2",
"to": "group_1",
"entries": 
[
{"match": 
{"destinationAddress": "dst-set-03"
},
"then": "192.168.0.3/32"
},
{"match": 
{"destinationAddress": "dst-set-04"
},
"then": "192.168.0.4/32"
}
]
}
]
}
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"nat": 
{"id": "F050123456789",
"tenantId": "080f290761484afabbec22938adc6a2e",
"redundant": false,
"isActivated": true,
"operationStatus": "Processing",
"sourceNaptRules": 
[
{"from": 
["group_1"
],
"to": "group_2",
"entries": 
[
{"then": 
["src-set-01",
"src-set-02",
"src-set-03",
"src-set-04"
]
}
]
},
{"from": 
["group_2"
],
"to": "group_1",
"entries": 
[
{"then": 
["src-set-05",
"src-set-06",
"src-set-07",
"src-set-08"
]
}
]
}
],
"destinationNatRules": 
[
{"from": "group_1",
"to": "group_2",
"entries": 
[
{"match": 
{"destinationAddress": "dst-set-01"
},
"then": "192.168.0.1/32"
},
{"match": 
{"destinationAddress": "dst-set-02"
},
"then": "192.168.0.2/32"
}
]
},
{"from": "group_2",
"to": "group_1",
"entries": 
[
{"match": 
{"destinationAddress": "dst-set-03"
},
"then": "192.168.0.3/32"
},
{"match": 
{"destinationAddress": "dst-set-04"
},
"then": "192.168.0.4/32"
}
]
}
],
"userIpAddresses": 
["192.168.0.0/30",
"192.168.0.4/30",
"192.168.0.8/30",
"192.168.0.12/30"
],
"operationId": "f6a4b449b40d4660aa3aae7985dfe2a6",
"resourceGroup": 
{"component": "FW01-jpeast01"
}
}
}

Activate NAT

指定したルーターでNATのアクティベートを実行します。

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

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

path Parameters

router_id required	any UUID
nat_id required	any UUID

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

nat

required

object

Responses

202

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

400

Bad Request リクエストが不正

401

Unauthorized 認証エラー

404

Not Found 未検出エラー

409

Conflict 競合エラー

post/v1/routers/{router_id}/nats/{nat_id}/activate

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

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"nat": 
{"userIpAddresses": 
["192.168.0.0/30",
"192.168.0.4/30",
"192.168.0.8/30",
"192.168.0.12/30"
],
"globalIpAddressSets": 
[
{"name": "src-set-01",
"type": "sourceNapt",
"numOfAddresses": 5
},
{"name": "dst-set-01",
"type": "destinationNat",
"numOfAddresses": 1
}
]
}
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"nat": 
{"id": "F050123456789",
"tenantId": "080f290761484afabbec22938adc6a2e",
"redundant": false,
"isActivated": true,
"operationStatus": "Processing",
"sourceNaptRules": [ ],
"destinationNatRules": [ ],
"userIpAddresses": 
["192.168.0.0/30",
"192.168.0.4/30",
"192.168.0.8/30",
"192.168.0.12/30"
],
"globalIpAddressSets": 
[
{"id": "4033447dc8c548e3afb5432f7deaf0cf",
"name": "src-set-01",
"type": "sourceNapt",
"natComponentId": "F050123456789",
"operationStatus": "Processing",
"tenantId": "080f290761484afabbec22938adc6a2e",
"numOfAddresses": 5,
"addresses": 
["100.131.66.79",
"100.131.66.80",
"100.131.66.81",
"100.131.66.82",
"100.131.66.83"
]
},
{"id": "2754efba42f84ae99095b4cdd654896a",
"name": "dst-set-01",
"type": "destinationNat",
"natComponentId": "F050123456789",
"operationStatus": "Processing",
"tenantId": "080f290761484afabbec22938adc6a2e",
"numOfAddresses": 1,
"addresses": 
["100.131.65.2"
]
}
],
"operationId": "a0d04c09a7b6487699467dd5970865dc",
"resourceGroup": 
{"component": null
}
}
}

Deactivate NAT

指定したNATのディアクティベートを実行します。

path Parameters

router_id required	string
nat_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}/nats/{nat_id}/deactivate

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

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"nat": 
{"id": "F050123456789",
"tenantId": "080f290761484afabbec22938adc6a2e",
"redundant": false,
"isActivated": false,
"operationStatus": "Processing",
"sourceNaptRules": [ ],
"destinationNatRules": [ ],
"userIpAddresses": 
["192.168.0.0/30",
"192.168.0.4/30",
"192.168.0.8/30",
"192.168.0.12/30"
],
"operationId": "c7c902cdb0784f7895379e6c665e6bb2",
"resourceGroup": 
{"component": "FW01-jpeast01"
}
}
}

NAT-Global-IP

List NAT Global IPs

指定したNATのグローバルIPアドレスセット情報の一覧を取得します。

path Parameters

router_id required	string
nat_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}/nats/{nat_id}/global-ip-address-sets

https://api.ntt.com/fic-eri/v1/routers/{router_id}/nats/{nat_id}/global-ip-address-sets

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"globalIpAddressSets": 
[
{"id": "4033447dc8c548e3afb5432f7deaf0cf",
"name": "src-set-01",
"type": "sourceNapt",
"natComponentId": "F050123456789",
"operationStatus": "Processing",
"tenantId": "080f290761484afabbec22938adc6a2e",
"numOfAddresses": 5,
"addresses": 
["100.131.66.79",
"100.131.66.80",
"100.131.66.81",
"100.131.66.82",
"100.131.66.83"
]
},
{"id": "2754efba42f84ae99095b4cdd654896a",
"name": "dst-set-01",
"type": "destinationNat",
"natComponentId": "F050123456789",
"operationStatus": "Processing",
"tenantId": "080f290761484afabbec22938adc6a2e",
"numOfAddresses": 1,
"addresses": 
["100.131.65.2"
]
}
]
}

Create NAT Global IP

指定したNATでグローバルIPアドレスセットを購入します。

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

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

path Parameters

router_id required	string
nat_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

globalIpAddressSet

required

object

Source NAPTの場合最大数8、Destination NATの場合最大数30

Responses

200

OK 成功しました

400

Bad Request リクエストが不正

401

Unauthorized 認証エラー

404

Not Found 未検出エラー

409

Conflict 競合エラー

post/v1/routers/{router_id}/nats/{nat_id}/global-ip-address-sets

https://api.ntt.com/fic-eri/v1/routers/{router_id}/nats/{nat_id}/global-ip-address-sets

Request samples

Payload

Content type

Copy

Expand all Collapse all


{"globalIpAddressSet": 
{"name": "src-set-02",
"type": "sourceNapt",
"numOfAddresses": 5
}
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"globalIpAddressSet": 
{"id": "2d9ae7b27152408f94caf5442ca9b73b",
"name": "src-set-02",
"type": "sourceNapt",
"natComponentId": "F050123456789",
"operationStatus": "Completed",
"tenantId": "080f290761484afabbec22938adc6a2e",
"numOfAddresses": 5,
"addresses": 
["100.131.66.12",
"100.131.66.13",
"100.131.66.14",
"100.131.66.15",
"100.131.66.16"
],
"operationId": "b70562414a5242d8ab556afae976ca47"
}
}

Show NAT Global IP

指定したグローバルIPアドレスセットの詳細情報を取得します。

path Parameters

router_id required	string
nat_id required	string
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}/nats/{nat_id}/global-ip-address-sets/{id}

https://api.ntt.com/fic-eri/v1/routers/{router_id}/nats/{nat_id}/global-ip-address-sets/{id}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"globalIpAddressSet": 
{"id": "2d9ae7b27152408f94caf5442ca9b73b",
"name": "src-set-02",
"type": "sourceNapt",
"natComponentId": "F050123456789",
"operationStatus": "Completed",
"tenantId": "080f290761484afabbec22938adc6a2e",
"numOfAddresses": 5,
"addresses": 
["100.131.66.12",
"100.131.66.13",
"100.131.66.14",
"100.131.66.15",
"100.131.66.16"
]
}
}

Delete NAT Global IP

指定したNATでグローバルIPアドレスセットを廃止します。ただし、アドレスセット数が0になる廃止や、NATルールが設定されているGIPは廃止出来ません

path Parameters

router_id required	string
nat_id required	string
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 競合エラー

delete/v1/routers/{router_id}/nats/{nat_id}/global-ip-address-sets/{id}

https://api.ntt.com/fic-eri/v1/routers/{router_id}/nats/{nat_id}/global-ip-address-sets/{id}

Response samples

Content type

Copy

Expand all Collapse all


{"globalIpAddressSet": 
{"id": "2d9ae7b27152408f94caf5442ca9b73b",
"operationId": "4d8c8e79b9fd488488435d7da7f9befd",
"operationStatus": "Completed"
}
}