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

Download OpenAPI specification:Download

Flexible InterConnect　> Support-Monitoring >　Traffics

概要

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

指定したポートやルータ、コネクション等のトラフィック情報の取得操作に関するAPIドキュメントです。

PortTraffics

Show PortTraffics

指定したポートのトラフィック情報を取得します。

取得可能な統計は最大10,000期間で、from, to, intervalの組み合わせによって超過する場合は400エラーを返却します。

path Parameters

tenantId required	string Example: 7884792c1e07424ba5e8ed44695ebbd4 テナントID (pattern: ^[0-9a-fA-F]{32}$)
portId required	string Example: F0000000000012 ポートID (pattern: ^F[0-9]{12}$)

query Parameters

from required	string <date-time> Example: from=2019-04-02T13:08:43+09:00 集計期間の開始時刻 (未指定の場合はtoの3時間前)
to required	string <date-time> Example: to=2019-04-02T13:18:43+09:00 集計期間の終了時刻 (未指定の場合は現在時刻)
format	string Enum: "json" "csv" Example: format=json フォーマット 'json'または'csv'、デフォルト値:json
interval	number Example: interval=5 集計間隔[m] 5以上の整数を指定する。指定値が5の倍数でない場合は、5の倍数に切り上げられて集計される。　デフォルト値:5

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

500

Internal Server Error 内部サーバーエラー

get/v1/flexible-ic/tenants/{tenantId}/ports/{portId}/counts

https://api.ntt.com/fic-monitoring/v1/flexible-ic/tenants/{tenantId}/ports/{portId}/counts

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"portId": "F010123456789",
"bandwidth": 100000000,
"counts": 
[
{"time": "2019-04-02T04:08:43Z",
"bandwidth": 50000000,
"inBps": 500.23,
"outBps": 145,
"inPps": 10.87,
"outPps": 5.53,
"inMaxBps": 512.11,
"outMaxBps": 148,
"inMaxPps": 15.99,
"outMaxPps": 10.2,
"inErrorRate": 0.02,
"outErrorRate": 0.01
}
]
}

Port-ConnectionTraffics

Show Port-ConnectionTraffics

指定したポートコネクションのトラフィック情報を取得します。

from〜toまでの日数に応じて指定可能なintervalが異なり、有効intervalを下回る指定をした場合400エラーを返却します。。

日数ごとの有効interval

日数 interval

1日(24h)まで 5以上

3日まで 15以上

7日まで 30以上

14日まで 60以上

30日まで 120以上

60日まで 240以上

60日を超過 360以上

日数	interval
1日(24h)まで	5以上
3日まで	15以上
7日まで	30以上
14日まで	60以上
30日まで	120以上
60日まで	240以上
60日を超過	360以上

path Parameters

tenantId required	string Example: 7884792c1e07424ba5e8ed44695ebbd4 テナントID (pattern: ^[0-9a-fA-F]{32}$)
portId required	string Example: F0000000000012 ポートID (pattern: ^F[0-9]{12}$)

query Parameters

from required	string <date-time> Example: from=2019-04-02T13:08:43+09:00 集計期間の開始時刻 (未指定の場合はtoの3時間前)
to required	string <date-time> Example: to=2019-04-02T13:18:43+09:00 集計期間の終了時刻 (未指定の場合は現在時刻)
format	string Enum: "json" "csv" Example: format=json フォーマット 'json'または'csv'、デフォルト値:json
interval	number Example: interval=5 集計間隔[m] 5以上の整数を指定する。指定値が5の倍数でない場合は、5の倍数に切り上げられて集計される。デフォルト値:5

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

500

Internal Server Error 内部サーバーエラー

get/v1/flexible-ic/tenants/{tenantId}/ports/{portId}/connections/counts

https://api.ntt.com/fic-monitoring/v1/flexible-ic/tenants/{tenantId}/ports/{portId}/connections/counts

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"portId": "F010123456789",
"counts": 
[
{"time": "2019-04-02T04:08:43.001Z",
"portContractBandwidth": 100000000,
"connectionContractBandwidthTotal": 100000000,
"connections": 
[
{"connectionId": "total",
"inBps": 4000,
"outBps": 1160,
"inPps": 44,
"outPps": 44,
"inMaxBps": 4000,
"outMaxBps": 1160,
"inMaxPps": 44,
"outMaxPps": 44
},
{"connectionId": "F030123456789",
"inBps": 500.23,
"outBps": 145,
"inPps": 10.87,
"outPps": 5.53,
"inMaxBps": 512.11,
"outMaxBps": 148,
"inMaxPps": 15.99,
"outMaxPps": 10.2
}
]
}
]
}

ConnectionTraffics

Show ConnectionTraffics

指定したコネクションのトラフィック情報を取得します。

取得可能な統計は最大666期間で、from, to, intervalの組み合わせによって超過する場合は400エラーを返却します。

path Parameters

tenantId required	string Example: 7884792c1e07424ba5e8ed44695ebbd4 テナントID (pattern: ^[0-9a-fA-F]{32}$)
connectionId required	string Example: F0000000000012 コネクションID (pattern: ^F[0-9]{12}$)

query Parameters

from required	string <date-time> Example: from=2019-04-02T13:08:43+09:00 集計期間の開始時刻 (未指定の場合はtoの3時間前)
to required	string <date-time> Example: to=2019-04-02T13:18:43+09:00 集計期間の終了時刻 (未指定の場合は現在時刻)
format	string Enum: "json" "csv" Example: format=json フォーマット 'json'または'csv'、デフォルト値:json
interval	number Example: interval=5 集計間隔[m] 5以上の整数を指定する。指定値が5の倍数でない場合は、5の倍数に切り上げられて集計される。デフォルト値:5

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

500

Internal Server Error 内部サーバーエラー

get/v1/flexible-ic/tenants/{tenantId}/connections/{connectionId}/counts

https://api.ntt.com/fic-monitoring/v1/flexible-ic/tenants/{tenantId}/connections/{connectionId}/counts

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"connectionId": "F030123456789",
"directionA": 
{"source": 
["F123456789021",
"F123456789022"
],
"destination": 
["aws-tokyo"
]
},
"directionB": 
{"source": 
["aws-tokyo"
],
"destination": 
["F123456789021",
"F123456789022"
]
},
"bandwidth": 100000000,
"counts": 
[
{"time": "2019-04-02T04:08:43Z",
"bandwidth": 50000000,
"total": 
{"bpsA": 500.23,
"bpsB": 233.09,
"ppsA": 9.89,
"ppsB": 2.11,
"maxBpsA": 510.1,
"maxBpsB": 256.56,
"maxPpsA": 13.11,
"maxPpsB": 5.55
},
"primary": 
{"bpsA": 500.23,
"bpsB": 233.09,
"ppsA": 9.89,
"ppsB": 2.11,
"maxBpsA": 510.1,
"maxBpsB": 256.56,
"maxPpsA": 13.11,
"maxPpsB": 5.55
},
"secondary": 
{"bpsA": 500.23,
"bpsB": 233.09,
"ppsA": 9.89,
"ppsB": 2.11,
"maxBpsA": 510.1,
"maxBpsB": 256.56,
"maxPpsA": 13.11,
"maxPpsB": 5.55
}
}
]
}

RouterTraffics

Show RouterTraffics

指定したルーターのトラフィック情報を取得します。

from〜toまでの日数に応じて指定可能なintervalが異なり、有効intervalを下回る指定をした場合400エラーを返却します。

日数ごとの有効interval

日数 interval

1日(24h)まで 5以上

3日まで 15以上

7日まで 30以上

14日まで 60以上

30日まで 120以上

60日まで 240以上

60日を超過 360以上

日数	interval
1日(24h)まで	5以上
3日まで	15以上
7日まで	30以上
14日まで	60以上
30日まで	120以上
60日まで	240以上
60日を超過	360以上

path Parameters

tenantId required	string Example: 7884792c1e07424ba5e8ed44695ebbd4 テナントID (pattern: ^[0-9a-fA-F]{32}$)
routerId required	string Example: F000000000041 ルーターID (pattern: ^F[0-9]{12}$)

query Parameters

from required	string <date-time> Example: from=2019-04-02T13:08:43+09:00 集計期間の開始時刻 (未指定の場合はtoの3時間前)
to required	string <date-time> Example: to=2019-04-02T13:18:43+09:00 集計期間の終了時刻 (未指定の場合は現在時刻)
format	string Enum: "json" "csv" Example: format=json フォーマット 'json'または'csv'、デフォルト値:json
interval	number Example: interval=5 集計間隔[m] 5以上の整数を指定する。指定値が5の倍数でない場合は、5の倍数に切り上げられて集計される。デフォルト値:5

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

500

Internal Server Error 内部サーバーエラー

get/v1/flexible-ic/tenants/{tenantId}/routers/{routerId}/routingGroups/counts

https://api.ntt.com/fic-monitoring/v1/flexible-ic/tenants/{tenantId}/routers/{routerId}/routingGroups/counts

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"routerId": "F020123456789",
"counts": 
[
{"time": "2019-04-02T04:08:43.001Z",
"routingGroups": 
[
{"routingGroup": "total",
"inBps": 4001.84,
"outBps": 1160,
"inPps": 86.96,
"outPps": 44.24,
"inMaxBps": 5000,
"outMaxBps": 1200,
"inMaxPps": 90,
"outMaxPps": 50
},
{"routingGroup": "group_1",
"inBps": 500.23,
"outBps": 145,
"inPps": 10.87,
"outPps": 5.53,
"inMaxBps": 512.11,
"outMaxBps": 148,
"inMaxPps": 15.99,
"outMaxPps": 10.2
}
]
}
]
}

RoutingGroupTraffics

Show RoutingGroupTraffics

指定したルーティンググループのトラフィック情報を取得します。

from〜toまでの日数に応じて指定可能なintervalが異なり、有効intervalを下回る指定をした場合400エラーを返却します。

日数ごとの有効interval

日数 interval

1日(24h)まで 5以上

3日まで 15以上

7日まで 30以上

14日まで 60以上

30日まで 120以上

60日まで 240以上

60日を超過 360以上

日数	interval
1日(24h)まで	5以上
3日まで	15以上
7日まで	30以上
14日まで	60以上
30日まで	120以上
60日まで	240以上
60日を超過	360以上

path Parameters

tenantId required	string Example: 7884792c1e07424ba5e8ed44695ebbd4 テナントID (pattern: ^[0-9a-fA-F]{32}$)
routerId required	string Example: F000000000041 ルーターID (pattern: ^F[0-9]{12}$)
routingGroup required	string Example: group_1 ルーティンググループ (pattern: ^group_[1-8]$)

query Parameters

from required	string <date-time> Example: from=2019-04-02T13:08:43+09:00 集計期間の開始時刻 (未指定の場合はtoの3時間前)
to required	string <date-time> Example: to=2019-04-02T13:18:43+09:00 集計期間の終了時刻 (未指定の場合は現在時刻)
format	string Enum: "json" "csv" Example: format=json フォーマット 'json'または'csv'、デフォルト値:json
interval	number Example: interval=5 集計間隔[m] 5以上の整数を指定する。指定値が5の倍数でない場合は、5の倍数に切り上げられて集計される。デフォルト値:5

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

500

Internal Server Error 内部サーバーエラー

get/v1/flexible-ic/tenants/{tenantId}/routers/{routerId}/routingGroups/{routingGroup}/connections/counts

https://api.ntt.com/fic-monitoring/v1/flexible-ic/tenants/{tenantId}/routers/{routerId}/routingGroups/{routingGroup}/connections/counts

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"routerId": "F020123456789",
"routingGroup": "group_1",
"counts": 
[
{"time": "2019-04-02T04:08:43.001Z",
"connections": 
[
{"connectionId": "total",
"inBps": 500.23,
"outBps": 145,
"inPps": 10.87,
"outPps": 5.53,
"inMaxBps": 512.11,
"outMaxBps": 148,
"inMaxPps": 15.99,
"outMaxPps": 10.2
},
{"connectionId": "F030123456789",
"inBps": 500.23,
"outBps": 145,
"inPps": 10.87,
"outPps": 5.53,
"inMaxBps": 512.11,
"outMaxBps": 148,
"inMaxPps": 15.99,
"outMaxPps": 10.2
}
]
}
]
}