Documentation Powered by ReDoc

Monitorings - Super OCN Flexible Connect API リファレンス (1.1.0-BGP-1)

Download OpenAPI specification:Download

URL: https://sdpf.ntt.com/ License: (c) 2020 NTT Communications Corporation All Rights Reserved. Terms of Service

概要

本APIでは、 NTT Communications Super OCN Flexible Connect の監視・運用に関する情報の参照・操作が可能です。

monitorings

リソース利用状況や健全性など, モニタリングに関する API カテゴリ

Routings Traffic bps Trend API

Routings リソースの トラフィックトレンド を取得する API

レポート期間と粒度の指定の注意点

  • レポート期間: startTime 以上, endTime 未満のデータをレポート対象とする
  • 指定したレポート期間の範囲が古すぎる or 新しすぎる場合はエラー
  • 万が一途中にデータ欠損した時間帯が含まれてもエラーとはならない一方、ゼロ埋め等の補正も行われない
  • データ発生時間からそれがレポートされるまでにはシステム制約によりタイムラグが発生する
path Parameters
tenantId
required
string ^[0-9a-f]{32}$
Example: 550e8400e29b41d4a716446655440000

SDPF のテナントに一意に与えられる ID. UUID 形式

query Parameters
routingId
string ^ox[0-9]{10}$
Example: routingId=ox1234567890

Routings リソースのID.

  • 指定なしならテナント内のすべての Routings リソースが検索対象
  • キーバリューペアを繰り返し指定することで複数の Routings リソースを指定可能 (例: routingId=ox1234567890&routingId=ox1234567891)
startTime
string <date-time>
Example: startTime=2019-07-31T18:00:00+09:00

レポート期間の開始時刻

  • ISO8601 の拡張形式 (YYYY-MM-DDThh:mm:ss+hh:mm)
  • この時間を含むそれ以後のタイムスタンプのデータが集計される
  • 指定がなければ UTC で前日の 00:00:00
  • 計測されていない期間がある場合、それを除く期間内で存在するデータのみ返却
  • 指定した開始時刻が、新しすぎる場合はエラー
  • データ粒度（インターバル）ごとの保持期間
    • 5分間隔: 93日間
    • 1日間隔: 366日間
  • レポート期間を長く設定するとレスポンスが長くなるためご注意ください
endTime
string <date-time>
Example: endTime=2019-07-31T18:00:00+09:00

レポート期間の終了時刻

  • ISO8601 の拡張形式 (YYYY-MM-DDThh:mm:ss+hh:mm)
  • この時間を含まないそれより過去のタイムスタンプのデータが集計される
  • 指定がなければ UTC で当日の 00:00:00
  • 計測されていない期間がある場合、それを除く期間内で存在するデータのみ返却
  • 指定した終了時刻が、古すぎる場合はエラー
  • データ粒度（インターバル）ごとの保持期間
    • 5分間隔: 93日間
    • 1日間隔: 366日間
  • レポート期間を長く設定するとレスポンスが長くなるためご注意ください
interval
string
Default: "5m"
Enum: "5m" "1d"

データ粒度

  • インターバルで表現する
    • 5m : 5分間隔のデータ
    • 1d : 1日間隔のデータ
  • レポート対象期間に指定の粒度のデータがない場合、それより粗い粒度のデータでレポートされる
header Parameters
X-Auth-Token
required
string ^[0-9a-f]{32}$
Example: dc03494823a841338430052e9ee95e07

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

Responses

200

OK

get/v1/tenants/{tenantId}/monitorings/traffic-trends/routings
http://api.ntt.com/ocnx-transit/v1/tenants/{tenantId}/monitorings/traffic-trends/routings

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "tenantId": "550e8400e29b41d4a716446655440000",
  • "trends":
    [
    ]
}

Aggregated Routings Traffic bps Trend API

Routings リソースの テナント内合計トラフィックトレンド を取得する API

レポート期間と粒度の指定の注意点

  • レポート期間: startTime 以上, endTime 未満のデータをレポート対象とする
  • 指定したレポート期間の範囲が古すぎる or 新しすぎる場合はエラー
  • 指定したインターバルに対してレポート期間範囲が整合しない場合もエラー
  • 万が一途中にデータ欠損した時間帯が含まれてもエラーとはならない一方、ゼロ埋め等の補正も行われない
  • データ発生時間からそれがレポートされるまでにはシステム制約によりタイムラグが発生する
path Parameters
tenantId
required
string ^[0-9a-f]{32}$
Example: 550e8400e29b41d4a716446655440000

SDPF のテナントに一意に与えられる ID. UUID 形式

query Parameters
startTime
string <date-time>
Example: startTime=2019-07-31T18:00:00+09:00

レポート期間の開始時刻

  • ISO8601 の拡張形式 (YYYY-MM-DDThh:mm:ss+hh:mm)
  • この時間を含むそれ以後のタイムスタンプのデータが集計される
  • 指定がなければ UTC で前日の 00:00:00
  • 計測されていない期間がある場合、それを除く期間内で存在するデータのみ返却
  • 指定した開始時刻が、新しすぎる場合はエラー
  • データ粒度（インターバル）ごとの保持期間
    • 5分間隔: 93日間
    • 1日間隔: 366日間
  • レポート期間を長く設定するとレスポンスが長くなるためご注意ください
endTime
string <date-time>
Example: endTime=2019-07-31T18:00:00+09:00

レポート期間の終了時刻

  • ISO8601 の拡張形式 (YYYY-MM-DDThh:mm:ss+hh:mm)
  • この時間を含まないそれより過去のタイムスタンプのデータが集計される
  • 指定がなければ UTC で当日の 00:00:00
  • 計測されていない期間がある場合、それを除く期間内で存在するデータのみ返却
  • 指定した終了時刻が、古すぎる場合はエラー
  • データ粒度（インターバル）ごとの保持期間
    • 5分間隔: 93日間
    • 1日間隔: 366日間
  • レポート期間を長く設定するとレスポンスが長くなるためご注意ください
interval
string
Default: "5m"
Enum: "5m" "1d"

データ粒度

  • インターバルで表現する
    • 5m : 5分間隔のデータ
    • 1d : 1日間隔のデータ
  • レポート対象期間に指定の粒度のデータがない場合、それより粗い粒度のデータでレポートされる
header Parameters
X-Auth-Token
required
string ^[0-9a-f]{32}$
Example: dc03494823a841338430052e9ee95e07

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

Responses

200

OK

get/v1/tenants/{tenantId}/monitorings/traffic-trends/routings/aggregated
http://api.ntt.com/ocnx-transit/v1/tenants/{tenantId}/monitorings/traffic-trends/routings/aggregated

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "tenantId": "550e8400e29b41d4a716446655440000",
  • "timestamp":
    [
    ],
  • "bpsIn":
    [
    ],
  • "bpsOut":
    [
    ]
}

Routings Traffic bps Forecast API

Routings リソースの トラフィック予測 を取得する API

レポート期間の指定の注意点

  • レポート期間: 現在時刻 以上, endTime 未満のデータをレポート対象とする
  • endTimeを現在時刻から366日以降の日時を指定した場合はエラー
  • 最低1日平均データが2つ存在していれば、出力される
  • 万が一途中にデータ欠損した時間帯が含まれてもエラーとはならない一方、ゼロ埋め等の補正も行われない
path Parameters
tenantId
required
string ^[0-9a-f]{32}$
Example: 550e8400e29b41d4a716446655440000

SDPF のテナントに一意に与えられる ID. UUID 形式

query Parameters
routingId
string ^ox[0-9]{10}$
Example: routingId=ox1234567890

Routings リソースのID.

  • 指定なしならテナント内のすべての Routings リソースが検索対象
  • キーバリューペアを繰り返し指定することで複数の Routings リソースを指定可能 (例: routingId=ox1234567890&routingId=ox1234567891)
endTime
string <date-time>
Example: endTime=2019-07-31T18:00:00+09:00

レポート期間の終了時刻

  • ISO8601 の拡張形式 (YYYY-MM-DDThh:mm:ss+hh:mm)
  • この時間を含まないそれより過去のタイムスタンプのデータが出力される
  • 指定がなければ UTC で366日後の 00:00:00
  • 予測値がない期間がある場合、それを除く期間内で存在するデータのみ返却
  • 指定した値が、現在時刻から366日後の当該時刻以外を指定した場合はエラー
  • タイムゾーン指定子によりレスポンスボディのtimestampのタイムゾーンが指定可能
  • 保持期間
    • 1日間隔: 366日間
  • レポート期間を長く設定するとレスポンスが長くなるためご注意ください
header Parameters
X-Auth-Token
required
string ^[0-9a-f]{32}$
Example: dc03494823a841338430052e9ee95e07

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

Responses

200

OK

get/v1/tenants/{tenantId}/monitorings/traffic-forecast/routings
http://api.ntt.com/ocnx-transit/v1/tenants/{tenantId}/monitorings/traffic-forecast/routings

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "tenantId": "550e8400e29b41d4a716446655440000",
  • "forecasts":
    [
    ]
}

Aggregated Routings Traffic bps Forecast API

Routings リソースの テナント内合計トラフィック予測 を取得する API

レポート期間の指定の注意点

  • レポート期間: 現在時刻 以上, endTime 未満のデータをレポート対象とする
  • endTimeを現在時刻から366日以降の日時を指定した場合はエラー
  • 最低1日平均データが2つ存在していれば、出力される
  • 万が一途中にデータ欠損した時間帯が含まれてもエラーとはならない一方、ゼロ埋め等の補正も行われない
path Parameters
tenantId
required
string ^[0-9a-f]{32}$
Example: 550e8400e29b41d4a716446655440000

SDPF のテナントに一意に与えられる ID. UUID 形式

query Parameters
endTime
string <date-time>
Example: endTime=2019-07-31T18:00:00+09:00

レポート期間の終了時刻

  • ISO8601 の拡張形式 (YYYY-MM-DDThh:mm:ss+hh:mm)
  • この時間を含まないそれより過去のタイムスタンプのデータが出力される
  • 指定がなければ UTC で366日後の 00:00:00
  • 予測値がない期間がある場合、それを除く期間内で存在するデータのみ返却
  • 指定した値が、現在時刻から366日後の当該時刻以外を指定した場合はエラー
  • タイムゾーン指定子によりレスポンスボディのtimestampのタイムゾーンが指定可能
  • 保持期間
    • 1日間隔: 366日間
  • レポート期間を長く設定するとレスポンスが長くなるためご注意ください
header Parameters
X-Auth-Token
required
string ^[0-9a-f]{32}$
Example: dc03494823a841338430052e9ee95e07

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

Responses

200

OK

get/v1/tenants/{tenantId}/monitorings/traffic-forecast/routings/aggregated
http://api.ntt.com/ocnx-transit/v1/tenants/{tenantId}/monitorings/traffic-forecast/routings/aggregated

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "tenantId": "550e8400e29b41d4a716446655440000",
  • "timestamp":
    [
    ],
  • "bpsInUpper":
    [
    ],
  • "bpsOutUpper":
    [
    ],
  • "bpsInLower":
    [
    ],
  • "bpsOutLower":
    [
    ],
  • "bpsOut":
    [
    ],
  • "bpsIn":
    [
    ]
}

Routings Traffic Peak Mbps API

Routings リソースの 課金指標値と同等のピークトラフィック量を取得する API

注意点

  • 計算ロジック
    • テナント内の全 Routings リソースのトラフィックを 5分毎に合計する (in, out それぞれ)
    • in, out の総トラフィックトレンドの 1ヶ月単位で 95 パーセンタイル値 を算出し、より大きい値を採用
    • 単位は Mbps で、小数点以下は切り上げ
    • ピーク値は当月を含む過去6ヶ月分を保持する (UTC基準)
path Parameters
tenantId
required
string ^[0-9a-f]{32}$
Example: 550e8400e29b41d4a716446655440000

SDPF のテナントに一意に与えられる ID. UUID 形式

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

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

Responses

200

OK

get/v1/tenants/{tenantId}/monitorings/traffic-peaks/routings
http://api.ntt.com/ocnx-transit/v1/tenants/{tenantId}/monitorings/traffic-peaks/routings

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "tenantId": "550e8400e29b41d4a716446655440000",
  • "months":
    [
    ],
  • "peaks":
    [
    ]
}

Routings Current Health Status API

Routings リソースの 最新の健全性情報を取得する API

path Parameters
tenantId
required
string ^[0-9a-f]{32}$
Example: 550e8400e29b41d4a716446655440000

SDPF のテナントに一意に与えられる ID. UUID 形式

query Parameters
routingId
string ^ox[0-9]{10}$
Example: routingId=ox1234567890

Routings リソースのID.

  • 指定なしならテナント内のすべての Routings リソースが検索対象
  • キーバリューペアを繰り返し指定することで複数の Routings リソースを指定可能 (例: routingId=ox1234567890&routingId=ox1234567891)
header Parameters
X-Auth-Token
required
string ^[0-9a-f]{32}$
Example: dc03494823a841338430052e9ee95e07

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

Responses

200

OK

get/v1/tenants/{tenantId}/monitorings/health-statuses/routings
http://api.ntt.com/ocnx-transit/v1/tenants/{tenantId}/monitorings/health-statuses/routings

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "tenantId": "550e8400e29b41d4a716446655440000",
  • "statuses":
    [
    ]
}

Health Events API

全リソースの健全性に関するイベント履歴を一覧情報を取得する API。

path Parameters
tenantId
required
string ^[0-9a-f]{32}$
Example: 550e8400e29b41d4a716446655440000

SDPF のテナントに一意に与えられる ID. UUID 形式

query Parameters
routingId
string
Example: routingId=ox1234567890

Routings リソースのID.

  • 指定なしならテナント内のすべての Routings リソースが検索対象
  • キーバリューペアを繰り返し指定することで複数の Routings リソースを指定可能 (例: routingId=ox1234567890&routingId=ox1234567891)
header Parameters
X-Auth-Token
required
string ^[0-9a-f]{32}$
Example: dc03494823a841338430052e9ee95e07

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

Responses

200

OK

get/v1/tenants/{tenantId}/monitorings/health-events
http://api.ntt.com/ocnx-transit/v1/tenants/{tenantId}/monitorings/health-events

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "tenantId": "550e8400e29b41d4a716446655440000",
  • "events":
    [
    ]
}

BGP stats list API

OCN 装置から見た BGP 送受信経路数を一覧参照する API

path Parameters
tenantId
required
string ^[0-9a-f]{32}$
Example: 550e8400e29b41d4a716446655440000

SDPF のテナントに一意に与えられる ID. UUID 形式

query Parameters
routingId
string ^ox[0-9]{10}$
Example: routingId=ox1234567890

Routings リソースのID.

  • 指定なしならテナント内のすべての Routings リソースが検索対象
  • キーバリューペアを繰り返し指定することで複数の Routings リソースを指定可能 (例: routingId=ox1234567890&routingId=ox1234567891)
header Parameters
X-Auth-Token
required
string ^[0-9a-f]{32}$
Example: dc03494823a841338430052e9ee95e07

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

Responses

200

OK

get/v1/tenants/{tenantId}/monitorings/bgp-stats
http://api.ntt.com/ocnx-transit/v1/tenants/{tenantId}/monitorings/bgp-stats

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "tenantId": "550e8400e29b41d4a716446655440000",
  • "stats":
    [
    ]
}

BGP sessions list API

BGP セッションリセットの実行結果を一覧参照する API

path Parameters
tenantId
required
string ^[0-9a-f]{32}$
Example: 550e8400e29b41d4a716446655440000

SDPF のテナントに一意に与えられる ID. UUID 形式

query Parameters
routingId
string ^ox[0-9]{10}$
Example: routingId=ox1234567890

Routings リソースのID.

  • 指定なしならテナント内のすべての Routings リソースが検索対象
  • キーバリューペアを繰り返し指定することで複数の Routings リソースを指定可能 (例: routingId=ox1234567890&routingId=ox1234567891)
header Parameters
X-Auth-Token
required
string ^[0-9a-f]{32}$
Example: dc03494823a841338430052e9ee95e07

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

Responses

200

OK

get/v1/tenants/{tenantId}/monitorings/bgp-sessions
http://api.ntt.com/ocnx-transit/v1/tenants/{tenantId}/monitorings/bgp-sessions

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "tenantId": "550e8400e29b41d4a716446655440000",
  • "sessions":
    [
    ]
}