Documentation Powered by ReDoc

monitorings API (1.0)

Download OpenAPI specification:Download

URL: https://sdpf.ntt.com/ License: (c) 2023 NTT DOCOMO BUSINESS, Inc. All Rights Reserved. Terms of Service

概要

本APIでは、docomo business RINKの監視・運用に関する情報の参照・操作が可能です。

alert

警報一覧取得

アラート一覧を取得するAPI

query Parameters
limit
integer [ 1 .. 100 ]
Default: 10
Example: limit=50

ページあたりの表示件数の指定（デフォルト10, 最大100）

offset
integer >= 0
Default: 0
Example: offset=5

表示するページ番号の指定（デフォルト0）

resourceType
string
Enum: "mobile" "ipoe" "vpn" "fic-connection" "guarantee"

リソース種別、複数指定可能。指定なしなら全ての リソースが検索対象

resolved
string
Enum: "true" "false"
Example: resolved=true

回復済みか否かを指定する。指定がない場合は全ての情報を取得する。

terminalId
string ^Z[0-9]{9}$
Example: terminalId=Z123456789

ルーター リソースのID. 指定なしならテナント内のすべての ルーター リソースが検索対象

customerNote
string

customerNoteの部分一致検索

sortKey
string

ソート項目の指定. レスポンスボディの項目から

direction
string
Enum: "asc" "desc"
Example: direction=asc

ソート順の指定. asc: 昇順, desc: 降順

header Parameters
X-Auth-Token
required
string ^[0-9a-f]{32}$
Example: dc03494823a841338430052e9ee95e07

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

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

get/v1/monitorings/alerts
https://api.ntt.com/sdpf-ztgict/v1/monitorings/alerts

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "total": 100,
  • "offset": 0,
  • "alerts":
    [
    ]
}

ステータスごとの警報数取得

指定した期間の、日ごとの発生中のアラート数/回復済みのアラート数を取得するAPI

query Parameters
startDate
string
Example: startDate=2023-01-01

取得期間の開始日。 ISO8601 の形式 (YYYY-MM-DD） デフォルトは27日前。

endDate
string
Example: endDate=2023-01-31

取得期間の終了日。 ISO8601 の形式 (YYYY-MM-DD）。デフォルトは現在日。

terminalId
string

ルーター リソースのID. 指定なしならテナント内のすべての ルーター リソースに紐づく警報が検索対象

header Parameters
X-Auth-Token
required
string ^[0-9a-f]{32}$
Example: dc03494823a841338430052e9ee95e07

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

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

get/v1/monitorings/alerts/count
https://api.ntt.com/sdpf-ztgict/v1/monitorings/alerts/count

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "dates":
    [
    ],
  • "notResolved":
    [
    ],
  • "resolved":
    [
    ]
}

diagnosis

セルフチェック実行

特定のルーターのセルフチェックを実行するAPI

path Parameters
terminalId
required
string Z[0-9]{9}
Example: Z123456789
header Parameters
X-Auth-Token
required
string ^[0-9a-f]{32}$
Example: dc03494823a841338430052e9ee95e07

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

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

get/v1/monitorings/health-diagnosis/{terminalId}
https://api.ntt.com/sdpf-ztgict/v1/monitorings/health-diagnosis/{terminalId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "requestId": "62ec2b62646740b5809f695dea7b2bbf",
  • "completed": false,
  • "requestTime": "2023-12-01T00:00:00+00:00"
}

セルフチェック結果取得

特定のルーターのセルフチェック結果を取得するAPI

path Parameters
requestId
required
string [0-9a-f]{32}
Example: 62ec2b62646740b5809f695dea7b2bbf
terminalId
required
string Z[0-9]{9}
Example: Z123456789
header Parameters
X-Auth-Token
required
string ^[0-9a-f]{32}$
Example: dc03494823a841338430052e9ee95e07

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

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

get/v1/monitorings/health-diagnosis/{terminalId}/get-requests/{requestId}
https://api.ntt.com/sdpf-ztgict/v1/monitorings/health-diagnosis/{terminalId}/get-requests/{requestId}

Response samples

Content type
application/json
Example
レスポンス生成済
Copy
 Expand all Collapse all
{
  • "requestId": "62ec2b62646740b5809f695dea7b2bbf",
  • "completed": true,
  • "requestTime": "2023-12-01T00:00:00+00:00",
  • "completedTime": "2023-12-01T00:00:00+00:00",
  • "responseBody":
    {
    }
}

healthStatus

健全性一覧取得（FICリソース以外）

全てのリソースのセルフチェック一覧（FICリソース以外）を取得するAPI

query Parameters
limit
integer [ 1 .. 100 ]
Default: 10
Example: limit=50

ページあたりの表示件数の指定（デフォルト10, 最大100）

offset
integer >= 0
Default: 0
Example: offset=5

表示するページ番号の指定（デフォルト0）

terminalId
string <= 100 characters ^Z[0-9]{9}$
Example: terminalId=Z123456789

ルーター リソースのID. 指定なしならテナント内のすべての ルーター リソースが検索対象

customerNote
string

customerNoteの部分一致検索

sortKey
string

ソート項目の指定. レスポンスボディの項目から

direction
string
Enum: "asc" "desc"

ソート順の指定. asc: 昇順, desc: 降順

header Parameters
X-Auth-Token
required
string ^[0-9a-f]{32}$
Example: dc03494823a841338430052e9ee95e07

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

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

get/v1/monitorings/health-status
https://api.ntt.com/sdpf-ztgict/v1/monitorings/health-status

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "total": 100,
  • "offset": 0,
  • "healthStatuses":
    [
    ]
}

FICの健全性一覧取得

FICリソースのセルフチェック一覧を取得するAPI

header Parameters
X-Auth-Token
required
string ^[0-9a-f]{32}$
Example: dc03494823a841338430052e9ee95e07

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

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

get/v1/monitorings/fic-health-status
https://api.ntt.com/sdpf-ztgict/v1/monitorings/fic-health-status

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "ficHealthStatuses":
    [
    ]
}

FIC 経路取得

FIC から受信している経路を取得するリクエストを実行する API

path Parameters
ficConnectionId
required
string Z[0-9]{9}
Example: Z123456789

FIC接続リソースID

header Parameters
X-Auth-Token
required
string ^[0-9a-f]{32}$
Example: dc03494823a841338430052e9ee95e07

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

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

get/v1/monitorings/fic-routes/{ficConnectionId}
https://api.ntt.com/sdpf-ztgict/v1/monitorings/fic-routes/{ficConnectionId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "requestId": "62ec2b62646740b5809f695dea7b2bbf",
  • "completed": false,
  • "requestTime": "2023-12-01T00:00:00+00:00"
}

FIC 経路取得

FIC から受信している経路を取得する API

path Parameters
ficConnectionId
required
string Z[0-9]{9}
Example: Z123456789

FIC接続リソースID

requestId
required
string ^[0-9a-f]{32}$
Example: 62ec2b62646740b5809f695dea7b2bbf
header Parameters
X-Auth-Token
required
string ^[0-9a-f]{32}$
Example: dc03494823a841338430052e9ee95e07

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

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

get/v1/monitorings/fic-routes/{ficConnectionId}/get-requests/{requestId}
https://api.ntt.com/sdpf-ztgict/v1/monitorings/fic-routes/{ficConnectionId}/get-requests/{requestId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "requestId": "62ec2b62646740b5809f695dea7b2bbf",
  • "completed": true,
  • "requestTime": "2023-12-01T00:00:00+00:00",
  • "completedTime": "2023-12-01T00:00:00+00:00",
  • "responseBody":
    {
    }
}

ステータスごとのルーター数取得

正常なルーター数、異常が発生しているルーター数を取得するAPI

header Parameters
X-Auth-Token
required
string ^[0-9a-f]{32}$
Example: dc03494823a841338430052e9ee95e07

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

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

get/v1/monitorings/health-status/count
https://api.ntt.com/sdpf-ztgict/v1/monitorings/health-status/count

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "total": 10,
  • "ok": 9,
  • "ng": 1
}

news

お知らせ一覧取得

全てのお知らせ一覧を取得するAPI

query Parameters
limit
integer [ 1 .. 100 ]
Default: 10
Example: limit=5

ページあたりの表示件数の指定（デフォルト10, 最大100）

offset
integer >= 0 characters >= 0
Default: 0
Example: offset=5

表示するページ番号の指定（デフォルト0）

subject
string <= 100 characters

お知らせの件名の部分一致検索

sortKey
string

ソート項目の指定. レスポンスボディの項目から

direction
string
Enum: "asc" "desc"

ソート順の指定. asc: 昇順, desc: 降順

header Parameters
X-Auth-Token
required
string ^[0-9a-f]{32}$
Example: dc03494823a841338430052e9ee95e07

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

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

get/v1/monitorings/news
https://api.ntt.com/sdpf-ztgict/v1/monitorings/news

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "total": 100,
  • "offset": 0,
  • "newsList":
    [
    ]
}

お知らせ取得

特定のお知らせを取得するAPI

path Parameters
newsId
required
string
header Parameters
X-Auth-Token
required
string ^[0-9a-f]{32}$
Example: dc03494823a841338430052e9ee95e07

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

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

get/v1/monitorings/news/{newsId}
https://api.ntt.com/sdpf-ztgict/v1/monitorings/news/{newsId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "newsId": "4a2ad3c6455441658016a8815b62e0ce",
  • "timestamp": "2019-05-21T10:05:50+09:00",
  • "subject": "NW輻輳レポート2023年1月分",
  • "message": "# NW輻輳レポート2023年1月分 ## 以下のような状況です - 1月は○○でした。",
  • "readFlag": false
}

トラフィック一覧取得

回線のトラフィックを取得するAPI

query Parameters
limit
integer [ 1 .. 100 ]
Default: 10
Example: limit=5

ページあたりの表示件数の指定（デフォルト10, 最大10）

offset
integer >= 0 characters >= 0
Default: 0
Example: offset=5

表示するページ番号の指定（デフォルト0）

startTime
string <date-time>
Example: startTime=2019-05-21T10:05:50+09:00

取得期間の開始時刻。ISO8601 の拡張形式 (YYYY-MM-DDThh:mm:ss+hh:mm)。この時間を含むそれ以後のタイムスタンプのデータが集計される。指定がなければ 現在時刻の24時間前。endTimeの指定があり、startTimeの指定がない場合は、endTimeの24時間前。期間は90日間まで指定可。

endTime
string <date-time>
Example: endTime=2019-05-21T10:05:50+09:00

取得期間の終了時刻。ISO8601 の拡張形式 (YYYY-MM-DDThh:mm:ss+hh:mm)。この時間を含まないそれより過去のタイムスタンプのデータが集計される。指定がなければ 現在時刻。期間は90日間まで指定可。

terminalId
string ^Z[0-9]{9}$
Example: terminalId=Z123456789

ルーター リソースのID. 指定なしならテナント内のすべての ルーター リソースに紐づく回線が検索対象。複数指定可能。(例: ルーターId=Z123456789&ルーターId=Z123456788)

interval
string
Default: "15m"
Enum: "1d" "15m" "5m"
Example: interval=15m

データ粒度。15m: 15分間隔のデータ 5m: ギャランティ接続の場合の粒度 1d: 1日間隔のデータ。期間が7日間を超える場合は1日間隔のみ指定可。

header Parameters
X-Auth-Token
required
string ^[0-9a-f]{32}$
Example: dc03494823a841338430052e9ee95e07

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

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

get/v1/monitorings/circuit-traffic-trends
https://api.ntt.com/sdpf-ztgict/v1/monitorings/circuit-traffic-trends

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "total": 100,
  • "offset": 0,
  • "trafficTrends":
    [
    ]
}

トラフィックサマリ取得

指定した期間の、回線リソースごとのトラフィックのサマリを取得するAPI

query Parameters
startDate
string
Example: startDate=2023-01-01

取得期間の開始日。 ISO8601 の形式 (YYYY-MM-DD）。デフォルトは7日前の日付。

endDate
string
Example: endDate=2023-01-31

取得期間の終了日。 ISO8601 の形式 (YYYY-MM-DD）。デフォルトは1日前の日付

limit
integer [ 1 .. 100 ]
Default: 10
Example: limit=50

ページあたりの表示件数の指定（デフォルト10, 最大10）

offset
integer >= 0
Default: 0
Example: offset=5

表示するページ番号の指定（デフォルト0）

terminalId
string ^Z[0-9]{9}$
Example: terminalId=Z123456789

ルーター リソースのID. 指定なしならテナント内のすべての ルーター リソースに紐づく回線が検索対象.複数指定可能。(例: ルーターId=Z123456789&ルーターId=Z123456788)

customerNote
string

customerNoteの部分一致検索

sortKey
string
Enum: "terminalId" "customerNote"

ソート項目の指定. レスポンスボディの項目から

direction
string
Enum: "asc" "desc"
Example: direction=asc

ソート順の指定. asc: 昇順, desc: 降順

circuitType
string
Enum: "ipoe" "guarantee"

回線種別の指定. 指定しない場合は全回線タイプ。

header Parameters
X-Auth-Token
required
string ^[0-9a-f]{32}$
Example: dc03494823a841338430052e9ee95e07

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

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

get/v1/monitorings/circuit-traffic-trends/summary
https://api.ntt.com/sdpf-ztgict/v1/monitorings/circuit-traffic-trends/summary

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "total": 100,
  • "offset": 0,
  • "trafficTrends":
    [
    ]
}

traffic-flow

トラフィックフローデータ保存量参照API

  • フローコレクター契約中のルーターのフローデータ保存量を参照するAPI
  • 指定期間に保存されたフローデータの総量と1日ごとの値を返却する
  • フローコレクターを契約している場合利用可能
query Parameters
limit
integer [ 1 .. 100 ]
Default: 10
Example: limit=50

ページあたりの表示件数の指定（デフォルト10, 最大100）

offset
integer >= 0
Default: 0
Example: offset=5

表示するページ番号の指定（デフォルト0）

terminalId
string ^[ZV][0-9]{9}$
Example: terminalId=Z123456789

ルーターリソースのID

  • 指定なしならテナント内のフローコレクタープランを利用するすべてのルーターリソースが検索対象(flowCollectorPlanが3monthsか6monthsか12monthsのルーターリソースが対象)
  • 複数指定可能。(例: terminalId=Z123456789&terminalId=Z123456788)
startDate
string
Example: startDate=2023-01-01

取得期間の開始日。 ISO8601 の形式 (YYYY-MM-DD） 指定がない場合は参照月1日。366日前まで指定可

endDate
string
Example: endDate=2023-01-15

取得期間の終了日。 ISO8601 の形式 (YYYY-MM-DD）。デフォルトは参照日の前日。

header Parameters
X-Auth-Token
required
string ^[0-9a-f]{32}$
Example: dc03494823a841338430052e9ee95e07

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

Responses

200

ok

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

get/v1/monitorings/circuit-traffic-flow/usage
https://api.ntt.com/sdpf-ztgict/v1/monitorings/circuit-traffic-flow/usage

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "limit": 10,
  • "offset": 0,
  • "total": 1,
  • "flowUsages":
    [
    ]
}

traffic-flow-rank

トラフィックフローランキング取得

回線リソースのトラフィックフローを取得するAPI

  • rankbyで指定した項目の値別にトラフィックを集計する
  • sourceIpAddress,destinationIpAddress,protocol,sourcePort,destinationPort,applicationIdは複数指定が可能
    • 同一種類のパラメータを複数指定した場合はor条件で取得する
    • 異なる種類のパラメータを複数指定した場合はand条件で取得する
  • トラフィックレポート（フロー分析）を契約していない(noSubscription)端末は本APIを利用不可
  • トラフィックレポート（フロー分析）5GBプランを契約している端末をterminalIdに指定する場合、他パラメータの指定に制限あり。詳細は各パラメータのdescriptionに記載する
query Parameters
terminalId
required
string ^Z[0-9]{9}$
Example: terminalId=Z123456789

端末リソースのID。トラフィックレポート（フロー分析）を利用していないリソースを指定した場合エラーとなる。複数指定不可

startTime
string <date-time>
Example: startTime=2019-05-21T10:05:50+09:00

取得期間の開始時刻。ISO8601 の拡張形式 (YYYY-MM-DDThh:mm:ss+hh:mm)。この時間を含むそれ以後のタイムスタンプのデータが集計される。

  • 指定がなければ 現在時刻の24時間前。endTimeの指定があり、startTimeの指定がない場合は、endTimeの24時間前。
  • 期間は184日前まで指定可。startTimeとendTimeの間隔は上限92日間とする
  • トラフィックレポート（フロー分析）5GBプランの場合、期間は31日前まで指定可。startTimeとendTimeの間隔は上限31日間とする
endTime
string <date-time>
Example: endTime=2019-05-21T10:05:50+09:00

取得期間の終了時刻。ISO8601 の拡張形式 (YYYY-MM-DDThh:mm:ss+hh:mm)。この時間を含まないそれより過去のタイムスタンプのデータが集計される。

  • 指定がなければ 現在時刻。
  • startTimeとendTimeの間隔は上限92日間とする
  • トラフィックレポート（フロー分析）5GBプランの場合、startTimeとendTimeの間隔は上限31日間とする
top
integer
Default: 10
Enum: 10 100

ランキング数

  • 10:TOP10,100:TOP100。指定がない場合はTOP10とする。
  • トラフィックレポート（フロー分析）5GBプランではTOP10のみ指定可
interval
string
Enum: "1d" "15m" "5m"
Example: interval=15m

取得するフローデータの粒度

  • 15m: 15分間隔 5m: 5分間隔 1d: 1日間隔
  • top=10の場合は、指定がなければデフォルト15minとする
  • top=100の場合はデータの集計期間により集計間隔は固定される。以下の組み合わせ以外はエラーとなる
    • 期間≦7日=5min, 7日＜期間≦14日=15min, 14日＜期間=1day
direction
string
Default: "both"
Enum: "in" "out" "both"

通信方向。in:下り,out:上り,both:上り下り両方(合算はされない)

rankBy
required
string
Enum: "sourceIpAddress" "destinationIpAddress" "sourcePort" "destinationPort" "protocol" "applicationId"
Example: rankBy=applicationId

本パラメータで指定した項目の値別にトラフィックを集計する。トラフィック量の上位10(100)件までおよびその他の計11(101)系列について、時系列のトラフィック値を返す。︎ トラフィックレポート（フロー分析）5GBプランではapplicationIdのみ指定可

  • sourceIpAddress:送信元IP
  • destinationIpAddress:宛先IP
  • sourcePort:送信元ポート
  • destinationPort:宛先ポート
  • protocol:プロトコル
  • applicationId:アプリケーション
sourceIpAddress
string
Example: sourceIpAddress=192.168.0.1

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

  • 複数指定可能。(例: sourceIpAddress=192.168.0.1&sourceIpAddress=192.168.0.2) 複数指定した場合はor条件となる
  • NWアドレスでの指定が可能。記号"/"についてはURLエンコード"%2F"により表記する(例: 192.168.0.0%2F24)
  • トラフィックレポート（フロー分析）5GBプランでは指定不可
destinationIpAddress
string
Example: destinationIpAddress=100.0.0.1

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

  • 複数指定可能。(例: destinationIpAddress=192.168.0.1&destinationIpAddress=192.168.0.2) 複数指定した場合はor条件となる
  • NWアドレスでの指定が可能。記号"/"についてはURLエンコード"%2F"により表記する(例: 192.168.0.0%2F24)
  • トラフィックレポート（フロー分析）5GBプランでは指定不可
protocol
string
Example: protocol=6

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

  • 複数指定可能。(例: protocol=6&protocol=7) 複数指定した場合はor条件となる
  • トラフィックレポート（フロー分析）5GBプランでは指定不可
sourcePort
string
Example: sourcePort=55001

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

  • 複数指定可能。(例: sourcePort=55001&sourcePort=55002) 複数指定した場合はor条件となる
  • トラフィックレポート（フロー分析）5GBプランでは指定不可
destinationPort
string
Example: destinationPort=55001

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

  • 複数指定可能。(例: destinationPort=55001&destinationPort=55002) 複数指定した場合はor条件となる
  • トラフィックレポート（フロー分析）5GBプランでは指定不可
applicationId
string
Example: applicationId=1234

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

  • 複数指定可能。(例: applicationId=1234&applicationId=5678) 複数指定した場合はor条件となる
  • トラフィックレポート（フロー分析）5GBプランでは/v1/monitorings/circuit-traffic-flow/applicationIdでbreakOut:trueで返却されるapplicationIdのみ指定可
filterId
string
Example: filterId=550e8400e29b41d4a716446655440000

/v1/monitorings/circuit-traffic-flow-rank/filterで保存済のfilterIdを指定可能。保存済みのフィルタ内容を適用しトラフィックフローを取得する

  • トラフィックレポート（フロー分析）5GBプランでは指定不可
header Parameters
X-Auth-Token
required
string ^[0-9a-f]{32}$
Example: dc03494823a841338430052e9ee95e07

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

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

get/v1/monitorings/circuit-traffic-flow-rank
https://api.ntt.com/sdpf-ztgict/v1/monitorings/circuit-traffic-flow-rank

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "trafficFlows":
    [
    ]
}

トラフィックフローフィルタ保存

  • /v1/monitorings/circuit-traffic-flow-rankのクエリパラメータで指定するフィルタ設定を保存するAPI
  • フィルタの保存件数上限は10件
header Parameters
X-Auth-Token
required
string ^[0-9a-f]{32}$
Example: dc03494823a841338430052e9ee95e07

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

Request Body schema: application/json
customerNote
required
string <= 64 characters

顧客が任意で付与できる識別子 (全角・半角・記号許容)

filter
required
Array of objects
  • 本パラメータで指定した項目の値別にトラフィックを集計する。トラフィック量の上位10件までおよびその他の計11系列について、時系列のトラフィック値を返す。︎
    • 送信元IP, 宛先IP, 送信元ポート, 宛先ポート, プロトコル, アプリケーションの中から選択

Responses

200

ok

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

post/v1/monitorings/circuit-traffic-flow-rank/filter
https://api.ntt.com/sdpf-ztgict/v1/monitorings/circuit-traffic-flow-rank/filter

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "customerNote": "フィルタA",
  • "filter":
    [
    ]
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "filterId": "550e8400e29b41d4a716446655440000",
  • "customerNote": "フィルタA",
  • "filter":
    [
    ]
}

トラフィックフローフィルタ一覧取得

  • /v1/monitorings/circuit-traffic-flow-rankのクエリパラメータで指定するフィルタ設定一覧を取得するAPI
header Parameters
X-Auth-Token
required
string ^[0-9a-f]{32}$
Example: dc03494823a841338430052e9ee95e07

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

Responses

200

ok

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

get/v1/monitorings/circuit-traffic-flow-rank/filter
https://api.ntt.com/sdpf-ztgict/v1/monitorings/circuit-traffic-flow-rank/filter

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "flowFilters":
    [
    ]
}

トラフィックフローフィルタ削除

  • /v1/monitorings/circuit-traffic-flow-rankのクエリパラメータで指定するフィルタ設定を削除するAPI
path Parameters
filterId
required
string ^[0-9a-f]{32}$
Example: dc03494823a841338430052e9ee95e07

フィルタID. uuid形式

header Parameters
X-Auth-Token
required
string ^[0-9a-f]{32}$
Example: dc03494823a841338430052e9ee95e07

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

Responses

202

ok

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

delete/v1/monitorings/circuit-traffic-flow-rank/filter/{filterId}
https://api.ntt.com/sdpf-ztgict/v1/monitorings/circuit-traffic-flow-rank/filter/{filterId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "filterId": "550e8400e29b41d4a716446655440000",
  • "customerNote": "フィルタA",
  • "filter":
    [
    ]
}

トラフィックフローランキングデータ保存量参照API

  • トラフィックレポート（フロー分析）契約中のルーターのフローデータ保存量を参照するAPI
  • 指定期間に保存されたフローデータの総量と1日ごとの値を返却する
  • トラフィックレポート（フロー分析）を契約している場合利用可能
query Parameters
limit
integer [ 1 .. 100 ]
Default: 10
Example: limit=50

ページあたりの表示件数の指定（デフォルト10, 最大100）

offset
integer >= 0
Default: 0
Example: offset=5

表示するページ番号の指定（デフォルト0）

terminalId
string ^[ZV][0-9]{9}$
Example: terminalId=Z123456789

ルーターリソースのID

  • 指定なしならテナント内のトラフィックレポート（フロー分析）プランを利用するすべてのルーターリソースが検索対象(trafficReportFlowAnalyzerPlanがnoSubscription以外のルーターリソースが対象)
  • 複数指定可能。(例: terminalId=Z123456789&terminalId=Z123456788)
startDate
string
Example: startDate=2023-01-01

取得期間の開始日。 ISO8601 の形式 (YYYY-MM-DD） 指定がない場合は参照月1日。366日前まで指定可

endDate
string
Example: endDate=2023-01-15

取得期間の終了日。 ISO8601 の形式 (YYYY-MM-DD）。デフォルトは参照日の前日。

header Parameters
X-Auth-Token
required
string ^[0-9a-f]{32}$
Example: dc03494823a841338430052e9ee95e07

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

Responses

200

ok

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

get/v1/monitorings/circuit-traffic-flow-rank/usage
https://api.ntt.com/sdpf-ztgict/v1/monitorings/circuit-traffic-flow-rank/usage

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "limit": 10,
  • "offset": 0,
  • "total": 1,
  • "flowUsages":
    [
    ]
}

アプリケーションID一覧取得

CIsco NBAR で定義されたアプリケーションIDとアプリケーション名の紐づけとブレイクアウト対象かどうかを取得するAPI

header Parameters
X-Auth-Token
required
string ^[0-9a-f]{32}$
Example: dc03494823a841338430052e9ee95e07

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

Responses

200

ok

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

get/v1/monitorings/applicationId
https://api.ntt.com/sdpf-ztgict/v1/monitorings/applicationId

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "applications":
    [
    ]
}