FIC-Premium Router - Flexible InterConnect API リファレンス (17.0)

Download OpenAPI specification:Download

概要

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

FIC-Premium Routerの購入・参照・変更・廃止等の操作に関するAPIドキュメントです。

ルーターを作成すると、Firewallコンポーネント・NATコンポーネントのIDも同時に払い出されます。 Firewall、NAT は、activate をすると、課金が開始されます。 Routerの学習経路数の上限を変更する事が可能です。

Premium Router

List FIC-Premium Routers

プレミアムルーター情報の一覧を取得します。

query Parameters

id	string ^F[0-9]{12}$ Example: id=F920123456789 ルーターID
name	string [ 1 .. 64 ] characters Example: name=YourRouterName ルーター名半角英数及び一部記号&()-_ 64文字
tenantId	string <uuid> ^[0-9a-f]{32}$ Example: tenantId=db8b0e40743f460685040c46167cf19e テナントID 半角英数32文字
area	string Enum: "JPEAST" "JPWEST" Example: area=JPEAST エリア名 'JPEAST'または'JPWEST'
isPublicServiceEndpoint	boolean Example: isPublicServiceEndpoint=true XaaS事業者対応フラグ 'false'(対応なし)または'true'(対応あり) (Keyなしで送る場合はサーバ側でfalseとして扱われる)
resourceGroup	string Example: resourceGroup=PFW01-jpeast02 故障やメンテナンスにて影響を受ける範囲毎に割り当てられたグループ

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 認証エラー

409

Conflict 競合エラー

get/v1/premium-routers

https://api.ntt.com/fic-eri/v1/premium-routers

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"premiumRouters": 
[
{"id": "F920123456789",
"name": "YourRouterName",
"redundant": true,
"tenantId": "db8b0e40743f460685040c46167cf19e",
"area": "JPEAST",
"operationStatus": "Completed",
"userIpAddress": "192.168.0.0/27",
"isPublicServiceEndpoint": false,
"firewalls": 
[
{"id": "F940123456789",
"isActivated": false
}
],
"nats": 
[
{"id": "F950123456789",
"isActivated": false
}
],
"routingGroups": 
[
{"name": "group_1"
},
{"name": "group_2"
},
{"name": "group_3"
},
{"name": "group_4"
},
{"name": "group_5"
},
{"name": "group_6"
},
{"name": "group_7"
},
{"name": "group_8"
}
],
"config": 
{"permitNewConnection": true
},
"maxprefix": 4000,
"resourceGroup": 
{"component": "PFW01-jpeast02"
}
}
]
}

Create FIC-Premium Router

プレミアムルーターを購入します。

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

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

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

premiumRouter

required

object

Responses

202

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

400

Bad Request リクエストが不正

401

Unauthorized 認証エラー

409

Conflict 競合エラー

post/v1/premium-routers

https://api.ntt.com/fic-eri/v1/premium-routers

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"premiumRouter": 
{"name": "YourRouterName",
"redundant": true,
"area": "JPEAST",
"userIpAddress": "192.168.0.0/27",
"isPublicServiceEndpoint": false
}
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"premiumRouter": 
{"id": "F920123456789",
"name": "YourRouterName",
"redundant": true,
"tenantId": "db8b0e40743f460685040c46167cf19e",
"area": "JPEAST",
"operationStatus": "Processing",
"userIpAddress": "192.168.0.0/27",
"isPublicServiceEndpoint": false,
"firewalls": 
[
{"id": "F940123456789",
"isActivated": false
}
],
"nats": 
[
{"id": "F950123456789",
"isActivated": false
}
],
"routingGroups": 
[
{"name": "group_1"
},
{"name": "group_2"
},
{"name": "group_3"
},
{"name": "group_4"
},
{"name": "group_5"
},
{"name": "group_6"
},
{"name": "group_7"
},
{"name": "group_8"
}
],
"config": 
{"permitNewConnection": true
},
"maxprefix": 4000,
"resourceGroup": 
{"component": null
},
"operationId": "2fb5baa5a5834e0b952d3f0d93c3e64a"
}
}

Show FIC-Premium Router

指定したプレミアムルーターの詳細情報を取得します。

path Parameters

required

string ^F[0-9]{12}$

Example: F920123456789

対象ルーターID

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/premium-routers/{id}

https://api.ntt.com/fic-eri/v1/premium-routers/{id}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"premiumRouter": 
{"id": "F920123456789",
"name": "YourRouterName",
"redundant": true,
"tenantId": "db8b0e40743f460685040c46167cf19e",
"area": "JPEAST",
"operationStatus": "Completed",
"userIpAddress": "192.168.0.0/27",
"isPublicServiceEndpoint": false,
"firewalls": 
[
{"id": "F940123456789",
"isActivated": false
}
],
"nats": 
[
{"id": "F950123456789",
"isActivated": false
}
],
"routingGroups": 
[
{"name": "group_1"
},
{"name": "group_2"
},
{"name": "group_3"
},
{"name": "group_4"
},
{"name": "group_5"
},
{"name": "group_6"
},
{"name": "group_7"
},
{"name": "group_8"
}
],
"config": 
{"permitNewConnection": true
},
"maxprefix": 4000,
"resourceGroup": 
{"component": "PFW01-jpeast02"
}
}
}

Update FIC-Premium Router

指定したプレミアムルーターを変更します。

path Parameters

required

string ^F[0-9]{12}$

Example: F920123456789

対象ルーターID

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

premiumRouter

required

object

Responses

202

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

400

Bad Request リクエストが不正

401

Unauthorized 認証エラー

404

Not Found 未検出エラー

409

Conflict 競合エラー

patch/v1/premium-routers/{id}

https://api.ntt.com/fic-eri/v1/premium-routers/{id}

Request samples

Payload

Content type

application/json

Example

Copy

Expand all Collapse all


{"premiumRouter": 
{"name": "YourRouterNameUpdate"
}
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"premiumRouter": 
{"id": "F920123456789",
"name": "YourRouterName",
"redundant": true,
"tenantId": "db8b0e40743f460685040c46167cf19e",
"area": "JPEAST",
"operationStatus": "Processing",
"userIpAddress": "192.168.0.0/27",
"isPublicServiceEndpoint": false,
"firewalls": 
[
{"id": "F940123456789",
"isActivated": false
}
],
"nats": 
[
{"id": "F950123456789",
"isActivated": false
}
],
"routingGroups": 
[
{"name": "group_1"
},
{"name": "group_2"
},
{"name": "group_3"
},
{"name": "group_4"
},
{"name": "group_5"
},
{"name": "group_6"
},
{"name": "group_7"
},
{"name": "group_8"
}
],
"config": 
{"permitNewConnection": true
},
"maxprefix": 4000,
"resourceGroup": 
{"component": "PFW01-jpeast02"
},
"operationId": "2fb5baa5a5834e0b952d3f0d93c3e64a"
}
}

Delete FIC-Premium Router

指定したプレミアムルーターを廃止します。ただし、コネクションで使用されている場合や、FW/NATがactivateされている場合は廃止出来ません。

path Parameters

required

string ^F[0-9]{12}$

Example: F920123456789

対象ルーターID

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 競合エラー

delete/v1/premium-routers/{id}

https://api.ntt.com/fic-eri/v1/premium-routers/{id}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"premiumRouter": 
{"id": "F920123456789",
"name": "YourRouterName",
"redundant": true,
"tenantId": "db8b0e40743f460685040c46167cf19e",
"area": "JPEAST",
"operationStatus": "Processing",
"userIpAddress": "192.168.0.0/27",
"isPublicServiceEndpoint": false,
"firewalls": 
[
{"id": "F940123456789",
"isActivated": false
}
],
"nats": 
[
{"id": "F950123456789",
"isActivated": false
}
],
"routingGroups": 
[
{"name": "group_1"
},
{"name": "group_2"
},
{"name": "group_3"
},
{"name": "group_4"
},
{"name": "group_5"
},
{"name": "group_6"
},
{"name": "group_7"
},
{"name": "group_8"
}
],
"config": 
{"permitNewConnection": true
},
"maxprefix": 4000,
"resourceGroup": 
{"component": "PFW01-jpeast02"
},
"operationId": "2fb5baa5a5834e0b952d3f0d93c3e64a"
}
}

コネクション新設制限解除リクエスト

ユーザがコネクション新設制限解除リクエストを行うためのAPI。

このAPI実行時に、Premium Routerの経路数が設定された上限経路数を下回っていた場合、コネクション新設制限が解除されます。

path Parameters

required

string ^F[0-9]{12}$

Example: F920123456789

対象ルーターID

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 競合エラー

patch/v1/premium-routers/{id}/restriction-release-request

https://api.ntt.com/fic-eri/v1/premium-routers/{id}/restriction-release-request

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"premiumRouter": 
{"id": "F920123456789",
"name": "YourRouterName",
"redundant": true,
"tenantId": "db8b0e40743f460685040c46167cf19e",
"area": "JPEAST",
"operationStatus": "Processing",
"userIpAddress": "192.168.0.0/27",
"isPublicServiceEndpoint": false,
"firewalls": 
[
{"id": "F940123456789",
"isActivated": false
}
],
"nats": 
[
{"id": "F950123456789",
"isActivated": false
}
],
"routingGroups": 
[
{"name": "group_1"
},
{"name": "group_2"
},
{"name": "group_3"
},
{"name": "group_4"
},
{"name": "group_5"
},
{"name": "group_6"
},
{"name": "group_7"
},
{"name": "group_8"
}
],
"config": 
{"permitNewConnection": true
},
"maxprefix": 4000,
"resourceGroup": 
{"component": "PFW01-jpeast02"
},
"operationId": "2fb5baa5a5834e0b952d3f0d93c3e64a"
}
}