monitorings API (1.0)

Download OpenAPI specification:Download

概要

本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

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": 
[
{"terminalId": "Z123456789",
"customerNote": "東京支店",
"timestamp": "2019-05-21T10:05:50+09:00",
"resolvedTime": "2019-05-21T10:05:50+09:00",
"resourceType": "mobile",
"resourceId": "Z123456789",
"alertName": "pingDown",
"info": "string",
"resolved": true
}
]
}

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

指定した期間の、日ごとの発生中のアラート数/回復済みのアラート数を取得する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

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": 
["2025-02-19"
],
"notResolved": 
[0
],
"resolved": 
[0
]
}

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

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

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": 
{"terminalId": "Z123456789",
"currentDatetime": "2019-05-21T10:05:50+09:00",
"lastBootDatetime": "2019-05-21T10:05:50+09:00",
"operatingTime": "194days 01:17:22",
"lanPorts": 
[
{"name": "Port1",
"status": "up",
"autoNegotiation": "on",
"ethernetType": "10base-t",
"linkMode": "full"
}
],
"wanPorts": 
[
{"type": "ethernet",
"name": "Port1",
"status": "up",
"signalStrength": "strong",
"area": "lte",
"situation": "main",
"autoNegotiation": "on",
"ethernetType": "10base-t",
"linkMode": "full"
}
],
"communicationStatus": 
[
{"circuitType": "mobile",
"situation": "main",
"status": "ok"
}
],
"customerEquipmentStatus": "ok",
"terminalStatus": "ok",
"mobileWanStatus": "ok",
"ipoeOnuStatus": "ok",
"ipoeWanStatus": "ok",
"guaranteeOnuStatus": "ok",
"guaranteeWanStatus": "ok",
"internetStatus": "ok",
"vpnStatus": "ok",
"ficRouterStatus": "ok",
"diagnosisResults": 
["terminalApiNg"
]
}
}

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

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": 
[
{"terminal": 
{"terminalId": "Z123456789",
"customerNote": "東京支店ルーター",
"terminalStatus": "ok"
},
"mobile": 
{"mobileId": "Z123456789",
"mobileSituation": "main",
"mobileStatus": "ok"
},
"ipoe": 
{"ipoeId": "Z123456789",
"ipoeSituation": "backup",
"ipoeStatus": "ok"
},
"guarantee": 
{"guaranteeId": "Z123456789",
"guaranteeSituation": "backup",
"guaranteeStatus": "ok"
},
"guaranteeBgp": 
{"guaranteeId": "Z123456789",
"internetBgpStatus": 
{"act": "ok",
"sby": "ok"
},
"vpnBgpStatus": 
{"act": "ok",
"sby": "ok"
}
},
"vpn": 
{"vpnId": "V123456789",
"vpnStatus": "ok"
}
}
]
}

FICの健全性一覧取得

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

header Parameters

X-Auth-Token

required

string ^[0-9a-f]{32}$

Example: dc03494823a841338430052e9ee95e07

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

Responses

200

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": 
[
{"vpnId": "Z123456789",
"ficId": "Z123456789",
"ficStatus": "ok"
}
]
}

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

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

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": 
{"ficId": "Z123456789",
"activeRouterReceiveRoutes": 
[
{"prefix": "1.1.1.0/24",
"nextHop": "1.1.1.1",
"asPath": "30 10",
"med": "100"
}
],
"standbyRouterReceiveRoutes": 
[
{"prefix": "1.1.1.0/24",
"nextHop": "1.1.1.1",
"asPath": "30 10",
"med": "100"
}
]
}
}

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

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

header Parameters

X-Auth-Token

required

string ^[0-9a-f]{32}$

Example: dc03494823a841338430052e9ee95e07

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

Responses

200

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

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": 
[
{"newsId": "4a2ad3c6455441658016a8815b62e0ce",
"timestamp": "2019-05-21T10:05:50+09:00",
"subject": "NW輻輳レポート2023年1月分",
"message": "# NW輻輳レポート2023年1月分 ## 以下のような状況です - 1月は○○でした。",
"readFlag": false
}
]
}

お知らせ取得

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

path Parameters

newsId

required

string

header Parameters

X-Auth-Token

required

string ^[0-9a-f]{32}$

Example: dc03494823a841338430052e9ee95e07

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

Responses

200

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

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
}

traffic-trends

トラフィック一覧取得

回線のトラフィックを取得する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

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": 
[
{"terminalId": "Z123456789",
"cutomerNote": "東京支店端末",
"circuits": 
[
{"circuitType": "guarantee",
"circuitId": "Z123456789",
"accessType": "internet",
"rateLimit": "50M",
"timestamp": 
["2019-05-21T10:00:00+00:00"
],
"bitPerSecIn": 
[120
],
"bytePerSecIn": 
[960
],
"bitPerSecOut": 
[88
],
"bytePerSecOut": 
[704
]
},
{"circuitType": "guarantee",
"circuitId": "Z123456789",
"accessType": "vpn",
"rateLimit": "50M",
"timestamp": 
["2019-05-21T10:00:00+00:00"
],
"bitPerSecIn": 
[120
],
"bytePerSecIn": 
[960
],
"bitPerSecOut": 
[88
],
"bytePerSecOut": 
[704
]
},
{"circuitType": "guarantee",
"circuitId": "Z123456789",
"accessType": "internet+vpn",
"rateLimit": "100M",
"timestamp": 
["2019-05-21T10:00:00+00:00"
],
"bitPerSecIn": 
[240
],
"bytePerSecIn": 
[1920
],
"bitPerSecOut": 
[176
],
"bytePerSecOut": 
[1408
]
},
{"circuitType": "ipoe",
"circuitId": "Z123456789",
"timestamp": 
["2019-05-21T10:00:00+00:00"
],
"bitPerSecIn": 
[20
],
"bytePerSecIn": 
[160
],
"bitPerSecOut": 
[10
],
"bytePerSecOut": 
[80
]
}
]
}
]
}

トラフィックサマリ取得

指定した期間の、回線リソースごとのトラフィックのサマリを取得する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

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": 
[
{"terminalId": "Z123456789",
"cutomerNote": "東京支店端末",
"circuits": 
[
{"circuitType": "guarantee",
"circuitId": "Z123456789",
"accessType": "internet",
"rateLimit": "50M",
"average": "180.5",
"maxBpsList": 
[
{"date": "2022-02-01",
"max": "201"
}
]
},
{"circuitType": "guarantee",
"circuitId": "Z123456789",
"accessType": "vpn",
"rateLimit": "50M",
"average": "140.5",
"maxBpsList": 
[
{"date": "2022-02-01",
"max": "151"
}
]
},
{"circuitType": "guarantee",
"circuitId": "Z123456789",
"accessType": "internet+vpn",
"rateLimit": "100M",
"average": "321",
"maxBpsList": 
[
{"date": "2022-02-01",
"max": "352"
}
]
},
{"circuitType": "ipoe",
"circuitId": "Z123456789",
"average": "180.5",
"maxBpsList": 
[
{"date": "2022-02-01",
"max": "201"
}
]
}
]
}
]
}