FIC-Connection 新規購入事前判定 - Flexible InterConnect API リファレンス (23.0)

Download OpenAPI specification:Download

Flexible InterConnect

概要

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

FIC-Connectionの新規購入事前判定に関するAPIドキュメントです。

事前判定機能はArcstar Universal Oneのみです。

UNO-Connection-Check

List Arcstar Universal One Connections Check

事前判定履歴情報の一覧を取得します。

query Parameters

orderId	string ^B[0-9]{12}$ Example: orderId=B002500000001 オーダーID
status	string Enum: "OK" "Allocated resource shortage(UNO Connection)" "Invalid Contract Information(parentContractNumber or vpnNumber)" "Invalid connectedNwAddress(Duplicated)" "Contract Management System Error" "System Unexpected Response" Example: status=OK 事前判定の判定結果
offset	integer ( 0 .. 10000 ) Example: offset=10000 オフセット（0～10000まで）デフォルト値:0
limit	integer ( 1 .. 100 ) Example: limit=100 リミット（1～100まで）デフォルト値:100

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/uno-connection-checks

https://api.ntt.com/fic-eri/v1/uno-connection-checks

Response samples

Content type

application/json

Example

Copy

Expand all Collapse all


{"unoConnectionChecks": 
[
{"orderId": "B002500000001",
"isPremium": false,
"tenantId": "db8b0e40743f460685040c46167cf19e",
"operationStatus": "Completed",
"cNumber": "C1234567890",
"vpnNumber": "V12345678",
"parentContractNumber": "N123456789",
"connectedNwAddress": "10.10.10.0",
"bandwidth": "100M",
"interconnect": "Interconnect-Tokyo-1",
"receptionDatetime": "2025-04-03T06:37:37Z",
"status": "OK",
"errorReason": [ ]
}
]
}

Create Arcstar Universal One Connection Check

新規購入事前判定を行います。

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

unoConnectionCheck

required

object

Responses

202

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

400

Bad Request リクエストが不正

401

Unauthorized 認証エラー

409

Conflict 競合エラー

post/v1/uno-connection-checks

https://api.ntt.com/fic-eri/v1/uno-connection-checks

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"unoConnectionCheck": 
{"isPremium": false,
"cNumber": "C1234567890",
"vpnNumber": "V12345678",
"parentContractNumber": "N123456789",
"connectedNwAddress": "10.10.10.0",
"bandwidth": "100M",
"interconnect": "Interconnect-Tokyo-1"
}
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"unoConnectionCheck": 
{"orderId": "B002500000001",
"isPremium": false,
"tenantId": "db8b0e40743f460685040c46167cf19e",
"operationStatus": "Processing",
"cNumber": "C1234567890",
"vpnNumber": "V12345678",
"parentContractNumber": "N123456789",
"connectedNwAddress": "10.10.10.0",
"bandwidth": "100M",
"interconnect": "Interconnect-Tokyo-1",
"receptionDatetime": null,
"status": null,
"errorReason": [ ]
}
}

Show Arcstar Universal One Connection Check

指定した事前判定履歴の詳細情報を取得します。

path Parameters

required

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

Example: B002500000001

対象オーダー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/uno-connection-checks/{id}

https://api.ntt.com/fic-eri/v1/uno-connection-checks/{id}

Response samples

Content type

application/json

Example

Copy

Expand all Collapse all


{"unoConnectionCheck": 
{"orderId": "B002500000001",
"isPremium": false,
"tenantId": "db8b0e40743f460685040c46167cf19e",
"operationStatus": "Completed",
"cNumber": "C1234567890",
"vpnNumber": "V12345678",
"parentContractNumber": "N123456789",
"connectedNwAddress": "10.10.10.0",
"bandwidth": "100M",
"interconnect": "Interconnect-Tokyo-1",
"receptionDatetime": "2025-04-03T06:37:37Z",
"status": "OK",
"errorReason": [ ]
}
}