Documentation Powered by ReDoc

Flow Monitoring - Flexible InterConnect API リファレンス (1.0.0)

Download OpenAPI specification:Download

URL: https://sdpf.ntt.com/ License: © NTT Communications Corporation All Rights Reserved.

Flexible InterConnect

概要

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

Flow Traffic・Raw Flow情報の参照操作に関するAPIドキュメントです。

提供エリアはJapan Eastのみとなります。

Flow log spaceの新規申込および変更・廃止等についてはGUIからの申し込みとさせていただいております。

・Flow log spaceの申し込みの際に、[月間の取込みデータ量 目安値]をパラメータとして設定いただきます。取込み量が[月間の取込みデータ量 目安値]を超過した場合、[月間の取込みデータ量 目安値]と当月の取込み量の比較後に取込み機能は停止します。[月間の取込みデータ量 目安値]を変更することで、取込み量の課金を停止・制限することができます。

・フローデータの量は、実際に流れるトラフィックの特性に依存します。そのため、取込み量を算出する際は、Flow monitoringをご利用のうえ、取込み量の実績値をご確認いただくことを推奨します。

・お客様にて確認いただいた単位時間あたりの取込み量を1ヶ月に換算することで、おおよその月間の取込み量を予測することが可能です。

Flow monitoringにおける想定料金に関しての詳細はこちらをご参照ください。

また、ご利用料金の詳細に関してはこちらをご参照ください。

※2024年3月31日までは、100GBを超過した取込み量も無料となります。

Flow-Traffic

List Flow Traffic

Flow Trafficの時系列情報を取得します。

Traffic量の多い上位Flow Trafficを指定して取得するなどクエリ条件の指定が可能です。

path Parameters
flowLogId
required
string ^F[0-9]{12}$
Example: F412300000001

FlowLogを一意に識別するID

tenantId
required
string ^[A-z0-9]{32}$
Example: 7884792c1e07424ba5e8ed44695ebbd4

テナントID

query Parameters
direction
required
string
Example: direction=in

取得するフロートラフィックの方向。"in"、"out"のいずれかを指定する。"in"はUpstream(destination→source方向)で、"out"は逆方向

from
required
string <date-time>
Example: from=2024-01-01T00:00:00Z

トラフィック情報を取得する期間の始点日時

to
required
string <date-time>
Example: to=2024-01-01T01:00:00Z

トラフィック情報を取得する期間の終点日時

rankBy
required
string
Example: rankBy=src_ip

本パラメータで指定した項目の値別にトラフィックを集計する。トラフィック量の上位10件までおよびその他の計11系列について、時系列のトラフィック値を返す。src_ip, dst_ip, src_port ,dst_port, src_ip_port, dst_ip_port, protocol, app_idのいずれかから選択する

sourceIpAddress
required
Array of strings
Example: sourceIpAddress=192.168.0.1,192.168.0.2

Souce IP addressによるクエリ。指定したIPアドレスから送信されるフローのみをトラフィックの対象とする

destinationIpAddress
required
Array of strings
Example: destinationIpAddress=100.0.0.1,100.0.0.2

Destination IP addressによるクエリ。指定したIPアドレス宛に送信されるフローのみをトラフィックの対象とする

protocol
required
integer <int32>
Example: protocol=6,17

IPプロトコル番号によるクエリ。指定したIPプロトコル番号のフローのみをトラフィックの対象とする

sourcePort
required
integer
Example: sourcePort=55001, 55002

Source Port番号によるクエリ。指定したポート番号から送信されるフローのみをトラフィックの対象とする

destinationPort
required
integer

Destination Port番号によるクエリ。指定したポート番号宛に送信されるフローのみをトラフィックの対象とする

applicationId
required
Array of strings
Example: applicationId=youtube, amazon

Application ID によるクエリ。指定したApplication ID(Cisco NBARにて定義される )のフローのみをトラフィックの対象とする

showQuerySize
required
string
Default: "false"

trueの場合クエリは実行せずに、実行時のクエリサイズを返す。本クエリパラメータを設定することにより、実際のクエリ実行に先立って実行時の処理クエリ量を確認することができる。クエリ実行量に対して課金されるサービスであるため、指定期間が長い場合など膨大なクエリ実行量となり得る場合は事前確認を行うことが推奨される

interval
required
string

集計を行う単位時間。1m, 5m, 15m, 30m, 1h, 2hの中から1つを指定。

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/fic-monitoring/v1/flexible-ic/tenants/{tenantId}/flowLogs/{flowLogId}/flowTraffic
https://api.ntt.com/fic-monitoring/v1/flexible-ic/tenants/{tenantId}/flowLogs/{flowLogId}/flowTraffic

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "tenantId": "7884792c1e07424ba5e8ed44695ebbd4",
  • "flowLogId": "F412300000001",
  • "from": "2022-01-01T00:00:00Z",
  • "to": "2022-01-01T00:00:00Z",
  • "rankBy": "src_ip",
  • "totalBytesProcessed": 100000,
  • "traffics":
    [
    ]
}

Flow-Traffic-Statistics

List Flow Traffic Statistics

Flow Trafficの統計情報を取得します。

Traffic量の多い上位Flow Trafficを指定して取得するなどクエリ条件の指定が可能です。

path Parameters
flowLogId
required
string ^F[0-9]{12}$
Example: F412300000001

FlowLogを一意に識別するID

tenantId
required
string ^[A-z0-9]{32}$
Example: 7884792c1e07424ba5e8ed44695ebbd4

テナントID

query Parameters
direction
required
string
Example: direction=in

取得するフロートラフィックの方向。"in"、"out"のいずれかを指定する。"in"はUpstream(destination→source方向)で、"out"は逆方向

from
required
string <date-time>
Example: from=2024-01-01T00:00:00Z

トラフィック情報を取得する期間の始点日時

to
required
string <date-time>
Example: to=2024-01-01T01:00:00Z

トラフィック情報を取得する期間の終点日時

rankBy
required
string
Example: rankBy=src_ip

本パラメータで指定した項目の値別にトラフィックを集計する。トラフィック量の上位10件までおよびその他の計11系列について、時系列のトラフィック値を返す。src_ip, dst_ip, src_port ,dst_port, src_ip_port, dst_ip_port, protocol, app_idのいずれかから選択する

sourceIpAddress
required
Array of strings
Example: sourceIpAddress=192.168.0.1,192.168.0.2

Souce IP addressによるクエリ。指定したIPアドレスから送信されるフローのみをトラフィックの対象とする

destinationIpAddress
required
Array of strings
Example: destinationIpAddress=100.0.0.1,100.0.0.2

Destination IP addressによるクエリ。指定したIPアドレス宛に送信されるフローのみをトラフィックの対象とする

protocol
required
integer <int32>
Example: protocol=6,17

IPプロトコル番号によるクエリ。指定したIPプロトコル番号のフローのみをトラフィックの対象とする

sourcePort
required
integer
Example: sourcePort=55001, 55002

Source Port番号によるクエリ。指定したポート番号から送信されるフローのみをトラフィックの対象とする

destinationPort
required
integer

Destination Port番号によるクエリ。指定したポート番号宛に送信されるフローのみをトラフィックの対象とする

applicationId
required
Array of strings
Example: applicationId=youtube, amazon

Application ID によるクエリ。指定したApplication ID(Cisco NBARにて定義される )のフローのみをトラフィックの対象とする

showQuerySize
required
string
Default: "false"

trueの場合クエリは実行せずに、実行時のクエリサイズを返す。本クエリパラメータを設定することにより、実際のクエリ実行に先立って実行時の処理クエリ量を確認することができる。クエリ実行量に対して課金されるサービスであるため、指定期間が長い場合など膨大なクエリ実行量となり得る場合は事前確認を行うことが推奨される

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/fic-monitoring/v1/flexible-ic/tenants/{tenantId}/flowLogs/{flowLogId}/flowTrafficStat
https://api.ntt.com/fic-monitoring/v1/flexible-ic/tenants/{tenantId}/flowLogs/{flowLogId}/flowTrafficStat

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "tenantId": "7884792c1e07424ba5e8ed44695ebbd4",
  • "flowLogId": "F412300000001",
  • "from": "2022-01-01T00:00:00Z",
  • "to": "2022-01-01T00:00:00Z",
  • "direction": "in",
  • "rankBy": "src_ip",
  • "totalBytesProcessed": 100000,
  • "trafficStatistics":
    [
    ]
}

Raw-Flow

List Raw Flow

Raw Flowの情報を取得します。

path Parameters
tenantId
required
string ^[A-z0-9]{32}$
Example: 7884792c1e07424ba5e8ed44695ebbd4

テナントID

flowLogId
required
string ^F[0-9]{12}$
Example: F412300000001

FlowLogを一意に識別するID

query Parameters
from
required
string <date-time> ^\d{4}-\d{2}-\d{2}T$\d{2}:\d{2}:\d{2}Z$
Example: from=2023/01/01T00:00:00+09:00

データ開始日時

to
required
string <date-time> ^\d{4}-\d{2}-\d{2}T$\d{2}:\d{2}:\d{2}Z$
Example: to=2023/01/01T00:00:00+09:00

データ終了日時

ipv4SrcAddr
Array of strings
Example: ipv4SrcAddr=192.168.0.1

送信元IPv4アドレス

l4SrcPort
Array of integers
Example: l4SrcPort=35525

送信元ポート番号

ipv4DstAddr
Array of strings
Example: ipv4DstAddr=10.0.0.1

送信先IPv4アドレス

l4DstPort
Array of integers
Example: l4DstPort=443

送信先ポート番号

protocol
Array of integers
Example: protocol=6

IPプロトコル番号

appId
Array of strings
Example: appId=13:495

NBARアプリケーションID

direction
required
string
Example: direction=in

取得するフローの方向。"in"、"out"のいずれかを指定する。"in"はUpstream(destination→source方向)で、"out"は逆方向

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/fic-monitoring/v1/flexible-ic/tenants/{tenantId}/flowLogs/{flowLogId}/rawFlow
https://api.ntt.com/fic-monitoring/v1/flexible-ic/tenants/{tenantId}/flowLogs/{flowLogId}/rawFlow

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "tenantId": "7884792c1e07424ba5e8ed44695ebbd4",
  • "flowLogId": "F412300000001",
  • "count": 10000,
  • "from": "2022-01-01T00:00:00Z",
  • "to": "2022-01-01T00:00:00Z",
  • "rawFlow":
    [
    ]
}