ConnectionsList - Flexible InterConnect API リファレンス (2.0.0)
Download OpenAPI specification:Download
本APIでは、Flexible InterConnectが提供するリソースの参照・操作が可能です。
指定したPort/Routerに紐づくコネクション情報の参照操作に関するAPIドキュメントです。
List Connections to Port
指定したポートに紐づくすべてのコネクション情報の一覧と、割り当て済み帯域の合計値を取得します。 Query ParamsのsrcPortIdとdstPortIdは同時指定はできません。
path Parameters
portId required | string 対象ポートID |
query Parameters
portId | string <uuid> ^F[0-9]{12}$ Example: portId=F030123456789 ポートID portId、portName、srcPortId、dstPortIdのいずれか必須 |
portName | string Example: portName=YourConnectionName1 ポート名 半角英数及び一部記号&()-_ 64文字 portId、portName、srcPortId、dstPortIdのいずれか必須 |
srcPortId | string ^F[0-9]{12}$ Example: srcPortId=F010123456789 接続元ポートID portId、portName、srcPortId、dstPortIdのいずれか必須 |
dstPortId | string ^F[0-9]{12}$ Example: dstPortId=F019876543210 接続先ポートID portId、portName、srcPortId、dstPortIdのいずれか必須 |
toPublicService | boolean Example: toPublicService=true XaaS接続フラグ |
header Parameters
Content-Type required | string Value: "application/json" |
X-Auth-Token required | string ^[0-9a-f]{32}$ Example: dc03494823a841338430052e9ee95e07 クライアントが Keystone を利用して取得した認証 Token |
Responses
OK 成功しました
Bad Request リクエストが不正
Unauthorized 認証エラー
Not Found 未検出エラー
Conflict 競合エラー
Response samples
- 200
{- "connections": [
- {
- "id": "F030123456789",
- "name": "YourConnectionName",
- "bandwidth": "100M",
- "source": {
- "primary": {
- "tenantId": "db8b0e40743f460685040c46167cf19e",
- "portId": "F010123456789",
- "vlan": 113
}
}, - "destination": {
- "publicServiceKey": null,
- "publicServiceId": "X002100000016",
- "publicServiceName": "TEST20210129",
- "primary": {
- "tenantId": "9d6a6682f0044660beae9701624e5dc4",
- "portId": "F019876543210",
- "vlan": 114
}
}, - "toPublicService": true
}
], - "allocatedBandwidth": "5G"
}
List Connections to Router
指定したルーターに紐づくすべてのコネクション情報の一覧と、割り当て済み帯域の合計値を取得します。
path Parameters
routerId required | string 対象ルーターID |
query Parameters
routerId | string <uuid> ^F[0-9]{12}$ Example: routerId=F030123456789 ルーターID routerId、routerNameのどちらか必須 |
routerName | string Example: routerName=YourConnectionName1 ルーター名 半角英数及び一部記号&()-_ 64文字 portId、portName、srcPortId、dstPortIdのいずれか必須 |
header Parameters
Content-Type required | string Value: "application/json" |
X-Auth-Token required | string ^[0-9a-f]{32}$ Example: dc03494823a841338430052e9ee95e07 クライアントが Keystone を利用して取得した認証 Token |
Responses
OK 成功しました
Bad Request リクエストが不正
Unauthorized 認証エラー
Not Found 未検出エラー
Conflict 競合エラー
Response samples
- 200
{- "connections": [
- {
- "id": "F030123456789",
- "name": "YourConnectionName1",
- "bandwidth": "100M",
- "source": {
- "tenantId": "87e89b8f075a4ee1aa209f6ca6ce242c",
- "routerId": "F020123456789",
- "groupName": "group_31",
- "routeFilter": {
- "in": "noRoute"
}
}
}, - {
- "id": "F039876543210",
- "name": "YourConnectionName2",
- "bandwidth": "100M",
- "source": {
- "tenantId": "87e89b8f075a4ee1aa209f6ca6ce242c",
- "routerId": "F029876543210",
- "groupName": "group_1",
- "routeFilter": {
- "in": "fullRoute"
}
}
}
], - "allocatedBandwidth": "200M"
}