Arcstar Universal One 回線アラームAPI

Overview

本APIはArcstrar Universal Oneで発生中の回線アラームを取得するAPIです。
最大過去90日前から発生中のアラームを取得することができます。

Resource URL

グローバル共通ドメインの利用、または個別リージョンドメインをご利用ください。

グローバル共通ドメインを利用する場合、お客様のご利用箇所の状況に応じて、
一番近いAPIゲートウェイに接続します。

1.Base Path(Global Load Balance)

https://api.ntt.com/v1/circuitalarms

2.Base Path(Region)

https://{region}.api.ntt.com/v1/circuitalarms

• region is jp|us|uk
• e.g. https://us.api.ntt.com/v1/circuitalarms
• 指定できるregionは、将来拡充予定

Resource Information

回線アラーム情報参照

GET /v1/circuitalarms/alarms

Example Request

GET https://api.ntt.com//v1/circuitalarms/alarms
HEADER Authorization: Bearer [YOUR_ACCESS_TOKEN]*
* トークンの取得についてはOAuth APIのページをご参照ください。

Response Parameters

Example Result

{
"value": [
    {
        "plannedOutage": false, 
        "originalAlarmName": BGPDown, 
        "noManageReason": false, 
        "alarmDiscription": "BGPDown was detected", 
        "vpnGroupId": "V********",
        "contractId":"N********", 
        "originalEventTime": "2016-11-14T04:01:57Z", 
    }, 
    {
        "plannedOutage":false,
        "originalAlarmName":"AccessDown(UNI)",
        "noManageReason":true,
        "alarmDescription":"Link down was detected from LAN side of customer Optical Network Unit",
        "rootCauseDescription":"Link down of customer connecting port of our unit may caused by customer work",
        "contractId":"N********"",
        "requestDescription":"Please check a state of the power failure or customer work, or make inquires to us",
        "vpnGroupId":"V********",
        "originalEventTime":"2016-11-15T06:08:11Z"
    }
], 
"@odata.count": 2
}

Query Parameters

GETリクエストURLのクエリに設定できるパラメータは以下の通り。

なお、取得できるアラームについて、10件表示を標準仕様としているため、
11件以上の情報取得にはサーバサイドのページング制御が必要となる。
使用例は次の通り。

11件目以降を取得する場合
　GET /v1/circuitalarms/alarms?$skip=10
21件目以降を取得する場合
　GET /v1/circuitalarms/alarms?$skip=20
ページングを無効にする場合
　GET /v1/circuitalarms/alarms?odata.maxpagesize=0
上位5件を取得する場合
　GET /v1/circuitalarms/alarms?$top=5

比較演算子

[左辺値] [演算子] [右辺値] の形式で取得する対象レコードの絞り込みを行うことができる。
以下の比較演算子を利用することができる。

セキュリティ上の理由により、左辺値は必ずプロパティ名, 右辺値はリテラルではなればならない。

リテラル

Null型

検索対象のプロパティが null かどうかを調べるために Null型を使うことができる
指定方法は eq null もしくは ne null である。

Boolean型

検索対象のプロパティが Boolean型の場合
nullを許容するデータに対するオペレータは次の通り。booleanValueというnullを許容するBoolean型があると想定した評価パターンは以下の通り

String型

検索対象のプロパティがString型の場合、シングルクォートで囲んで設定する(完全一致)。
検索対象文字列のエンコーディングはUTF-8でなければならない。また、セキュリティ上ASCIIコントロールコードを含めることはできない。
シングルクォート(')を含んだ文字列を検索したい場合、連続するシングルクォートにより指定することができる
検索対象文字列が長さゼロの文字列かどうか評価する場合に eq '' もしくは ne '' による検索を行うことはできない。代わりに eq null もしくは ne null を使用する。

DatetimeOffset型

検索対象のプロパティがDateTimeOffset型の場合、次のように指定する
時刻はかならずUTCで指定しなければならない。
時刻指定はマイクロ秒の精度まで指定することができる(ただし、検索対象のDateTimeOffset型プロパティがマイクロ秒まで保持しているとは限らない)

論理演算子

以下の論理演算子を用いることができる。

演算子の優先順位、グルーピング

演算子の優先順位は not > gt,ge,lt,le,eq,ne > and > or の順序となる。
括弧を使うことにより論理演算の優先順位を制御することができる。

$select

$select クエリパラメータにカンマ区切りでプロパティ名を指定することで、取得するプロパティを制限することができる。
$select クエリパラメータを省略した場合、$select=* が指定された場合と等価になる

$orderby

$orderby クエリパラメータに [プロパティ名] [asc/desc] を指定することで、取得順序を制御することができる。
[asc/desc] 指定を省略すると、asc(昇順)が指定されたこととなる
カンマ区切りで連続してソート順序に優先度を持たせることができる。
$orderby クエリパラメータを省略した場合、$orderby=lastModificationTime desc が指定された場合と等価になる。
データベースの性能上の問題により $orderby に指定可能なプロパティには制限があり、指定不可能なプロパティを設定するとエラーになる。

正常系応答

リクエストが正しく処理され、正常な応答が得られた場合に 200 OK が返却される。
正常系の応答は 200 OK のみであり、その他のステータスコードはすべて異常系である。
検索の結果、件数が0件だった場合においてもステータスコードは 200 OK である。

返却される応答のjsonフォーマットは以下

オブジェクトが未定義もしくはデータが null の場合、"キー": null 表記ではなく、キー自体の出力を省略する
jsonの仕様上、オブジェクト内のキーの出現順序には決まりがない

異常系応答

400 Bad Request

リクエストURIが不正な場合

405 Method Not Allowed

リクエストに GET 以外のメソッドが使われた場合

500 Internal Server Error

サーバ内部の予期しないエラーが発生した場合

503 Service Unavailable

何らかの原因によりAPIサーバがデータベースにアクセスできなかった場合

参考: エラーメッセージ一覧