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

Download OpenAPI specification:Download

Flexible InterConnect

概要

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

指定したPort/Routerに紐づくコネクション情報の参照操作に関するAPIドキュメントです。

Connections-to-Port

List Connections to Port

指定したポートに紐づくすべてのコネクション情報の一覧と、割り当て済み帯域の合計値を取得します。 Query ParamsのsrcPortIdとdstPortIdは同時指定はできません。

path Parameters

portId

required

string

query Parameters

portId	string <uuid> ^F[0-9]{12}$ Example: portId=F030123456789 ポートID　portId、portName、srcPortId、dstPortIdのいずれか必須
portName	string Example: portName=YourConnectionName1 ポート名　portId、portName、srcPortId、dstPortIdのいずれか必須
srcPortId	string ^F[0-9]{12}$ Example: srcPortId=F030123456789 接続元ポートID　portId、portName、srcPortId、dstPortIdのいずれか必須
dstPortId	string ^F[0-9]{12}$ Example: dstPortId=F030123456789 接続先ポート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

200

OK 成功しました

400

Bad Request リクエストが不正

401

Unauthorized 認証エラー

404

Not Found 未検出エラー

409

Conflict 競合エラー

get/v1/port-connections?portId={portId}

https://api.ntt.com/fic-eri/v1/port-connections?portId={portId}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"allocatedBandwidth": "5G",
"connections": 
[
{"id": "F031900000001",
"name": "port-to-public-port-1",
"source": 
{"primary": 
{"tenantId": "db8b0e40743f460685040c46167cf19e",
"portId": "F011900000001",
"vlan": 113
}
},
"destination": 
{"publicServiceKey": null,
"publicServiceId": "X002100000016",
"publicServiceName": "TEST20210129",
"primary": 
{"tenantId": "9d6a6682f0044660beae9701624e5dc4",
"portId": "F012100000069",
"vlan": 337
}
},
"bandwidth": "100M",
"toPublicService": true
}
]
}

Connections-to-Router

List Connections to Router

指定したルーターに紐づくすべてのコネクション情報の一覧と、割り当て済み帯域の合計値を取得します。