Documentation Powered by ReDoc

RouteInfoCsv - Flexible InterConnect API リファレンス (1.5.0)

Download OpenAPI specification:Download

URL: https://sdpf.ntt.com/ License: © NTT DOCOMO BUSINESS, Inc. All Rights Reserved.

Flexible InterConnect > Support-Monitoring > RouteInfoCsv

概要

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

Router/L3Connectionの経路情報CSVの作成の要求・作成状況の取得・ダウンロード等の操作に関するAPIドキュメントです。

L3connections RouteInfoCsv

Create L3connections RouteInfoCsv

L3Connectionの経路情報CSVの作成を要求します。

path Parameters
id
required
string <uuid> ^[0-9a-f]{32}$
Example: db8b0e40743f460685040c46167cf19e

対象テナントID

id
required
string ^F[0-9]{12}$
Example: F030123456789

対象コネクションID

header Parameters
Content-Type
required
string
Value: "application/json"
X-Auth-Token
required
string ^[0-9a-f]{32}$
Example: dc03494823a841338430052e9ee95e07

クライアントが Keystone を利用して取得した認証 Token

Responses

201

Created リソースは作成されました

400

Bad Request リクエストが不正

404

Not Found 未検出エラー

500

Internal Server Error サーバーエラー

post/v1/flexible-ic/tenants/{id}/l3connections/{id}/routeInfoCsv
https://api.ntt.com/fic-monitoring/v1/flexible-ic/tenants/{id}/l3connections/{id}/routeInfoCsv

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "routeInfoCsvId": "20200807170012"
}

Download L3connections RouteInfoCsv

L3Connectionの経路情報CSVをダウンロードします。

path Parameters
id
required
string <uuid> ^[0-9a-f]{32}$
Example: db8b0e40743f460685040c46167cf19e

対象テナントID

id
required
string ^F[0-9]{12}$
Example: F030123456789

対象コネクションID

id
required
string
Example: 20200807170012

対象経路情報CSVID

header Parameters
Content-Type
required
string
Value: "application/json"
X-Auth-Token
required
string ^[0-9a-f]{32}$
Example: dc03494823a841338430052e9ee95e07

クライアントが Keystone を利用して取得した認証 Token

Content-Disposition
required
string
Value: "attachment; filename={connectionId}_{YYYYMMDDhhmmss}.csv"

Responses

204

No Content 成功しました(CSVのファイル名のタイムスタンプはダウンロード時刻(UTC)とします)

400

Bad Request リクエストが不正

404

Not Found 未検出エラー

500

Internal Server Error サーバーエラー

get/v1/flexible-ic/tenants/{id}/l3connections/{id}/routeInfoCsv/{id}
https://api.ntt.com/fic-monitoring/v1/flexible-ic/tenants/{id}/l3connections/{id}/routeInfoCsv/{id}

Response samples

Content type
text/csv
Copy
FIC-Resource,Type,Route,Primary/Secondary,Group,Protocol,Next hop,AS Path,Community,MED
FIC-Connection-Paired,Receiving,10.100.1.184/30,Primary,Group1,BGP,10.100.255.2,65001 I,2708.444444,10

Show L3connections RouteInfoCsv Status

L3Connectionの経路情報CSVの作成状況を取得します。

path Parameters
id
required
string <uuid> ^[0-9a-f]{32}$
Example: db8b0e40743f460685040c46167cf19e

対象テナントID

id
required
string ^F[0-9]{12}$
Example: F030123456789

対象コネクションID

id
required
string
Example: 20200807170012

対象経路情報CSVID

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 リクエストが不正

404

Not Found 未検出エラー

500

Internal Server Error サーバーエラー

get/v1/flexible-ic/tenants/{id}/l3connections/{id}/routeInfoCsv/{id}/status
https://api.ntt.com/fic-monitoring/v1/flexible-ic/tenants/{id}/l3connections/{id}/routeInfoCsv/{id}/status

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "status": "inProgress"
}

RouteInfoCsv

Create RouteInfoCsv

Routerの経路情報CSVの作成を要求します。

path Parameters
id
required
string <uuid> ^[0-9a-f]{32}$
Example: db8b0e40743f460685040c46167cf19e

対象テナントID

id
required
string ^F[0-9]{12}$
Example: F020123456789

対象ルーター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 リクエストが不正

404

Not Found 未検出エラー

500

Internal Server Error サーバーエラー

post/v1/flexible-ic/tenants/{id}/routers/{id}/routeInfoCsv
https://api.ntt.com/fic-monitoring/v1/flexible-ic/tenants/{id}/routers/{id}/routeInfoCsv

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "routeInfoCsvId": "20200807170012"
}

Download RouteInfoCsv

Routerの経路情報CSVをダウンロードします。

path Parameters
id
required
string <uuid> ^[0-9a-f]{32}$
Example: db8b0e40743f460685040c46167cf19e

対象テナントID

id
required
string ^F[0-9]{12}$
Example: F020123456789

対象ルーターID

id
required
string
Example: 20200807170012

対象経路情報CSVID

header Parameters
Content-Type
required
string
Value: "application/json"
Content-Disposition
required
string
Value: "attachment; filename={connectionId}_{YYYYMMDDhhmmss}.csv"
X-Auth-Token
required
string ^[0-9a-f]{32}$
Example: dc03494823a841338430052e9ee95e07

クライアントが Keystone を利用して取得した認証 Token

Responses

200

OK 成功しました(CSVのファイル名のタイムスタンプはダウンロード時刻(UTC)とする)

400

Bad Request リクエストが不正

404

Not Found 未検出エラー

500

Internal Server Error サーバーエラー

get/v1/flexible-ic/tenants/{id}/routers/{id}/routeInfoCsv/{id}
https://api.ntt.com/fic-monitoring/v1/flexible-ic/tenants/{id}/routers/{id}/routeInfoCsv/{id}

Response samples

Content type
text/csv
Copy
FIC-Resource,Route,Group,Protocol,Next hop,AS Path,Community,MED
FIC-Router,10.100.254.0/30,Group1,Direct,,,,

Show RouteInfoCsv Status

Routerの経路情報CSVの作成状況を取得します。

path Parameters
id
required
string <uuid> ^[0-9a-f]{32}$
Example: db8b0e40743f460685040c46167cf19e

対象テナントID

id
required
string ^F[0-9]{12}$
Example: F020123456789

対象ルーターID

id
required
string
Example: 20200807170012

対象経路情報CSVID

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 リクエストが不正

404

Not Found 未検出エラー

500

Internal Server Error サーバーエラー

get/v1/flexible-ic/tenants/{id}/routers/{id}/routeInfoCsv/{id}/status
https://api.ntt.com/fic-monitoring/v1/flexible-ic/tenants/{id}/routers/{id}/routeInfoCsv/{id}/status

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "status": "inProgress"
}