LOA - Flexible InterConnect API リファレンス (2.0.0)
Download OpenAPI specification:Download
本APIでは、Flexible InterConnectが提供するリソースの参照・操作が可能です。
LOA(Letter of Authorization)の参照操作に関するAPIドキュメントです。
List LOAs
LOA(Letter of Authorization)情報の一覧を取得します。
query Parameters
id | string <uuid> ^[0-9a-f]{32}$ Example: id=e1efcf1bb88a43c98785ec4906ee3140 LOA-ID |
portId | string ^F[0-9]{12}$ Example: portId=F010123456789 ポートID |
area | string Enum: "JPEAST" "JPWEST" Example: area=JPEAST エリア名 ‘JPEAST’または’JPWEST’ |
location | string Example: location=NTT Com Tokyo (NW1) PATCH-PANEL データセンター名 |
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/loas
https://api.ntt.com/fic-eri/v1/loas
Response samples
- 200
Content type
application/json
Copy
Expand all Collapse all {- "loas": [
- {
- "id": "e1efcf1bb88a43c98785ec4906ee3140",
- "portId": "F010123456789",
- "portName": "YourPortName",
- "tenantId": "b9c91cfeda8e48579c573305f0dcddf0",
- "area": "JPEAST",
- "location": "NW1",
- "address": "Tokyo Japan",
- "rack": "B1-ED1-0001",
- "patchPanel": "lxea01comnw1.01",
- "patchPanelPort": "11,12",
- "circuitType": "single mode LC",
- "issueDate": "2020-07-24",
- "ifType": "10GBASE-LR"
}
]
}
Show LOA
指定したLOA(Letter of Authorization)の詳細情報を取得します。
path Parameters
id required | string 対象LOA-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/loas/{id}
https://api.ntt.com/fic-eri/v1/loas/{id}
Response samples
- 200
Content type
application/json
Copy
Expand all Collapse all {- "loa": {
- "id": "e1efcf1bb88a43c98785ec4906ee3140",
- "portId": "F010123456789",
- "portName": "YourPortName",
- "tenantId": "b9c91cfeda8e48579c573305f0dcddf0",
- "area": "JPEAST",
- "location": "NW1",
- "address": "Tokyo Japan",
- "rack": "B1-ED1-0001",
- "patchPanel": "lxea01comnw1.01",
- "patchPanelPort": "11,12",
- "circuitType": "single mode LC",
- "issueDate": "2020-07-24",
- "ifType": "10GBASE-LR"
}
}