Arcstar Universal One API

概要

 ■ Arcstar Universal One(国内回線)に関連し、下記のAPIを提供します。
  ・Arcstar Universal One 契約詳細情報取得API
  ・Arcstar Universal One 設備情報取得API
  ・Arcstar Universal One トラフィック情報取得API
  ・Arcstar Universal One 回線アラーム情報取得API
  ・Arcstar Universal One ギャランティ 工事情報取得API
   ‐ ギャランティ 工事情報更新一覧取得API
   ‐ ギャランティ 工事詳細情報取得API
  ・Arcstar Universal One ベストエフォート 工事情報取得API
  ・Arcstar Universal One 回線監視停止情報API
   ‐ 回線監視停止情報取得API
   ‐ 回線監視停止情報登録API
   ‐ 回線監視停止情報更新API
   ‐ 回線監視停止情報削除API
  ・Arcstar Universal One 回線調査API

 ■ 本APIのご利用に際して
   当該APIサービスを導入していただくため、
   詳細仕様、利用条件(制約等)、利用開始予定日等について
   弊社当該サービス担当者より別途、ご案内させて頂きますので、
   事前にinfo-uno-api@ntt.com宛にてご連絡頂きますようお願い致します。

 【件名】
   (問合せ)Arcstar Universal One APIの利用について

 【記載必要項目】
   - 利用者情報(会社名、組織名、ご担当者名等)
   - 利用開始希望日
   - 利用用途
   - 連絡先(電話番号、メールアドレス等)

Resource URL

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

1.Base Path(Global Load Balance)

https://api.ntt.com/v4/uno

2.Base Path(Region)

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

Resource Information  

Key Value
レスポンスフォーマット JSON
認証(OAuth) YES
帯域制御#1 YES

契約詳細情報取得

 VPNグループID及び契約ID(N番)を指定し、契約詳細情報をJSON形式にて返却するAPIです。

 * 国内回線のみ対象です。

契約詳細情報取得

GET /v4/uno/contracts/{vpnGroupId}/{contractId}  

Request Parameters [path variable]

Name Description Type Mandatory
vpnGroupId VPNグループIDを指定
VPNグループID:'V'+8桁の数字
String Yes
contractId 契約ID(N番)を指定
契約ID(N番):'N'+9桁の数字
String Yes

Example Request

Host: api.ntt.com  
GET /v4/uno/contracts/V12345678/N123456789 
HEADER Authorization: Bearer [YOUR_ACCESS_TOKEN]*
* トークンの取得についてはOAuth APIのページをご参照ください。  

Response Parameters

No Name Description Type Mandatory
1 addressInfo 住所情報 array No
1-1 addressType 住所区分
住所を住所情報に保持するにあたり、住所種別を判別する区分
KYS:契約者住所 STB:設置場所住所
String No
1-2 postalNumber 郵便番号 Int No
1-3 address 住所
日本語/英語表記の住所情報
String No
1-4 addressCode 住所コード
住所を特定するコード
String No
1-5 banchi1 番地等1
番地情報1
String No
1-6 banchi2 番地等2
番地情報2
String No
1-7 banchi3 番地等3
番地情報3
String No
1-8 building1 建物等1
建物の情報1
String No
1-9 building2 建物等2
建物の情報2
String No
1-10 building3 建物等3
建物の情報3
String No
1-11 samakata 様方等
様方に関する情報
String No
2 productInfo 商品情報 array Yes
2-1 productName 商品名
商品コードの名称
String No
2-2 productTypeName 商品種別名
商品種別コードの名称
String No
2-3 productDetailInfo 契約商品詳細情報 array No
2-3-1 itemNameProduct 項目名 契約商品詳細
項目ID 契約商品詳細の名称
String No
2-3-2 detailItemValue 詳細項目値
詳細項目の値
String No

Example Result

{
    "addressInfo": [
    {
        "addressType": "KYS",
        "postalNumber": "1000011",
        "address": "東京都千代田●●1丁目",
        "addressCode": "12345678901",
        "banchi1": "1番6号",
        "banchi2": "",
        "banchi3": "",
        "building1": "●●●日比谷ビル",
        "building2": "",
        "building3": "",
        "samakata": ""
    },{
        "addressType": "STB",
        "postalNumber": "1000011",
        "address": "東京都千代田区●●1丁目",
        "addressCode": "12345678901",
        "banchi1": "1番6号",
        "banchi2": "",
        "banchi3": "",
        "building1": "●●●日比谷ビル",
        "building2": "1F",
        "building3": "",
        "samakata": ""
    }],
    "productInfo": [
    {
        "productName": "Universal One",
        "productTypeName": "サービス",
        "productDetailInfo": []
    },{
        "productName": "L2",
        "productTypeName": "レイヤー",
        "productDetailInfo": []
    },{
        "productName": "ギャランティ",
        "productTypeName": "プラン",
        "productDetailInfo": []
    },{
        "productName": "メイン(主回線)",
        "productTypeName": "回線利用用途",
        "productDetailInfo": [
        {
            "itemNameProduct": "冗長化グループ番号",
            "detailItemValue": ""
        },{
            "itemNameProduct": "VPN番号",
            "detailItemValue": "V12345678"
        }]
    },{
        "productName": "ギャランティアクセス",
        "productTypeName": "アクセス",
        "productDetailInfo": []
    },{
        "productName": "イーサタイプ(NTTCom光アクセス)",
        "productTypeName": "タイプ",
        "productDetailInfo": []
    },{
        "productName": "Ether",
        "productTypeName": "イーサネット種別",
        "productDetailInfo": []
    },{
        "productName": "全二重",
        "productTypeName": "通信方式",
        "productDetailInfo": []
    },{
        "productName": "10M",
        "productTypeName": "品目",
        "productDetailInfo": []
    },{
        "productName": "設置場所情報",
        "productTypeName": "部材",
        "productDetailInfo": [
        {
            "itemNameProduct": "設置場所事業所名",
            "detailItemValue": "●●●日比谷ビル"
        }]
    },{
        "productName": "L2 設置無",
        "productTypeName": "UNO-T",
        "productDetailInfo": []
    }]
}

設備情報取得

 VPNグループID、契約ID(N番)、処理種別と情報種別を指定し、設備情報をJSON形式にて返却するAPIです。

設備情報取得

GET /v4/uno/nwInfo/{vpnGroupId}/{contractId}?ifType=20&infoType=vUnoapiUnoMain

Request Parameters [path variable]

Name Description Type Mandatory
vpnGroupId VPNグループIDを指定
VPNグループID:'V'+8桁の数字
String Yes
contractId サービスの契約ID(N番)を指定
契約ID(N番):'N'+9桁の数字
String Yes

Request Parameters [query argument]

Name Description Type Mandatory
ifType 取得する情報の種類(本 API では 20 のみ利用)
例: 20 ※個別情報
Int Yes
infoType 取得する情報の種別
代表契約情報:vUnoapiUnoMain
代表契約アドレス情報:vUnoapiUnoMainAddress
V間情報:vUnoapiVcon
V間アドレス情報:vUnoapiVconAddress
V間フィルタ情報:vUnoapiVconFilter
マルチキャスト情報:vUnoapiMcBase
MC送信端末アドレス情報:vUnoapiMcBaseAddress
マルチキャストRPユーザアドレス情報:vUnoapiMcMainAddress
拠点契約情報:vUnoapiUnoBase
拠点契約アドレス情報:vUnoapiUnoBaseAddress
拠点契約DHCPアドレス情報:vUnoapiUnoBaseDhcp
拠点契約IPフィルタリングインターネット向け情報:vUnoapiUnoBaseFilter
拠点契約NAT変換情報:vUnoapiUnoBaseNat
拠点契約ToSビット書き換え情報:vUnoapiUnoBaseTos
ASPMSE利用機能情報:vUnoapiAspmseUtil
ASPMSE利用機能アドレス情報:vUnoapiAspmseUtilAddress
ASPMSE利用機能NATフィルタリング情報:vUnoapiAspmseUtilFilter
ASPMSE利用機能NAT端末情報:vUnoapiAspmseUtilNat

例: vUnoapiUnoMain ※代表契約情報
String Yes

Example Request

Host: api.ntt.com
GET /v4/uno/nwInfo/V12345678/N123456789?ifType=20&infoType=v_unoapi_uno_main     
HEADER Authorization: Bearer [YOUR_ACCESS_TOKEN]*
* トークンの取得についてはOAuth APIのページをご参照ください。

Response Parameters [共通]

No Name Description Type Mandatory
1 ifType リクエストした処理種別を返却 String No
2 contractId リクエストした契約 ID を返却 String No
3 resultCode 異常応答時、エラー種別を表すコードを返却
※ただし、正常応答時は "00000000" を返却
String No

Response Parameters [infoTypeとして 代表契約情報:vUnoapiUnoMain を指定した場合]

No Name Description Type Mandatory
4 vUnoapiUnoMain 代表契約情報 array No
4-1 contractId 契約ID(N番) String No
4-2 addressBorrowingPlan アドレス借用プラン String No
4-3 ipv4PlanFreeExists アドレス設計フリー利用有無(IPv4) String No
4-4 vpnConnectionExists VPN間通信有無 String No
4-5 internetConnectionExists インターネットコネクト有無 String No
4-6 internetConnectBand インターネットコネクト帯域値 String No

Response Parameters [infoTypeとして 代表契約アドレス情報:vUnoapiUnoMainAddress を指定した場合]

No Name Description Type Mandatory
5 vUnoapiUnoMainAddress 代表契約アドレス情報 array No
5-1 contractId 契約ID(N番) String No
5-2 addressCodeKind アドレス種別コード String No
5-3 addressNameKind アドレス種別名 String No
5-4 address アドレス値 String No
5-5 mask アドレスマスク値 String No

Response Parameters [infoTypeとして V間情報:vUnoapiVcon を指定した場合]

No Name Description Type Mandatory
6 vUnoapiVcon V間情報 array No
6-1 contractId 契約ID(N番) String No
6-2 vconContractNumber V間契約番号 String No
6-3 connectMainContractNumber 通信先代表契約番号 String No
6-4 connectContractNumber 通信先契約番号 String No
6-5 connectVpnNumber 通信先VPN番号 String No
6-6 vpnConnectionType V間接続タイプ String No

Response Parameters [infoTypeとして V間アドレス情報:vUnoapiVconAddres を指定した場合]

No Name Description Type Mandatory
7 vUnoapiVconAddres V間アドレス情報 array No
7-1 contractId 契約ID(N番) String No
7-2 addressCodeKind アドレス種別コード String No
7-3 addressNameKind アドレス種別名 String No
7-4 address アドレス値 String No
7-5 mask アドレスマスク値 String No
7-6 vconContractNumber V間契約番号 String No
7-7 connectMainContractNumber 通信先代表契約番号 String No
7-8 connectContractNumber 通信先契約番号 String No

Response Parameters [infoTypeとして V間フィルタ情報:vUnoapiVconFilter を指定した場合]

No Name Description Type Mandatory
8 vUnoapiVconFilter V間フィルタ情報 array No
8-1 contractId 契約ID(N番) String No
8-2 vconContractNumber V間契約番号 String No
8-3 connectMainContractNumber 通信先代表契約番号 String No
8-4 connectContractNumber 通信先契約番号 String No
8-5 filterSerialNumber フィルタ通番 String No
8-6 lanAddress お客様LANアドレス(変換前アドレス) String No
8-7 lanAddressMask お客様LANアドレス(変換前アドレス) マスク String No
8-8 conversionType 変換タイプ String No
8-9 afterConversionAddress 変換後アドレス String No
8-10 afterConversionAddressMask 変換後アドレス マスク String No
8-11 protocol プロトコル String No
8-12 startPortNumber ポート番号(開始) String No
8-13 endPortNumber ポート番号(終了) String No

Response Parameters [infoTypeとして マルチキャスト情報:vUnoapiMcBase を指定した場合]

No Name Description Type Mandatory
9 vUnoapiMcBase マルチキャスト情報 array No
9-1 contractId 契約ID(N番) String No
9-2 multicastBand 送信マルチキャスト帯域 String No

Response Parameters [infoTypeとして MC送信端末アドレス情報:vUnoapiMcBaseAddress を指定した場合]

No Name Description Type Mandatory
10 vUnoapiMcBaseAddress MC送信端末アドレス情報 array No
10-1 contractId 契約ID(N番) String No
10-2 addressCodeKind アドレス種別コード String No
10-3 addressNameKind アドレス種別名 String No
10-4 address アドレス値 String No
10-5 mask アドレスマスク値 String No
10-6 serialNumber 送信端末アドレス通番 String No

Response Parameters [infoTypeとして マルチキャストRPユーザアドレス情報:vUnoapiMcMainAddress を指定した場合]

No Name Description Type Mandatory
11 vUnoapiMcMainAddress マルチキャストRPユーザアドレス情報 array No
11-1 contractId 契約ID(N番) String No
11-2 addressCodeKind アドレス種別コード String No
11-3 addressNameKind アドレス種別名 String No
11-4 address アドレス値 String No
11-5 mask アドレスマスク値 String No

Response Parameters [infoTypeとして 拠点契約情報:vUnoapiUnoBase を指定した場合]

No Name Description Type Mandatory
12 vUnoapiUnoBase 拠点契約情報 array No
12-1 contractId 契約ID(N番) String No
12-2 ipFilterFunctionExists IPフィルタ機能利用有無 String No
12-3 useNatNapt NAT/NAPT利用 String No
12-4 useTosConversion ToS変換利用有無 String No
12-5 baseGrouping 拠点区分 String No
12-6 multcastExists マルチキャスト有無 String No
12-7 unoTerminalExists UniversalOneターミナル有無 String No
12-8 unoTerminalKind UniversalOneターミナル種別 String No
12-9 csExists CS機有無 String No
12-10 ipv4PlanFree お客様LANアドレスv4設計フリー String No
12-11 useTerminalSpeed UNO-T_LAN側インターフェース速度 String No
12-12 asNumber AS番号(WAN側) String No
12-13 maximRoute 申込み上限経路数 String No
12-14 redundancy 冗長種別 String No
12-15 priorityControlExists 優先制御(下り)利用有無(NW) String No
12-16 priorityControlMenu 優先制御(下り)メニュー(NW) String No
12-17 internetConnection インターネット接続 String No

Response Parameters [infoTypeとして 拠点契約アドレス情報:vUnoapiUnoBaseAddress を指定した場合]

No Name Description Type Mandatory
13 vUnoapiUnoBaseAddress 拠点契約アドレス情報 array No
13-1 contractId 契約ID(N番) String No
13-2 addressCodeKind アドレス種別コード String No
13-3 addressNameKind アドレス種別名 String No
13-4 address アドレス値 String No
13-5 mask アドレスマスク値 String No
13-6 serialNumber END-END監視アドレス通番/お客様拠点サマライズ NWアドレス通番v4/お客様拠点NWアドレス通番v4 String No

Response Parameters [infoTypeとして 拠点契約DHCPアドレス情報:vUnoapiUnoBaseDhcp を指定した場合]

No Name Description Type Mandatory
14 vUnoapiUnoBaseDhcp 拠点契約DHCPアドレス情報 array No
14-1 contractId 契約ID(N番) String No
14-2 serialNumber DHCP通番 String No
14-3 startAddressRange DHCPアドレスレンジ始 String No
14-4 endAddressRange DHCPアドレスレンジ終 String No

Response Parameters [infoTypeとして 拠点契約IPフィルタリングインターネット向け情報:vUnoapiUnoBaseFilter を指定した場合]

No Name Description Type Mandatory
15 vUnoapiUnoBaseFilter 拠点契約IPフィルタリングインターネット向け情報 array No
15-1 contractId 契約ID(N番) String No
15-2 priority 優先順位 v4 String No
15-3 senderAddress フィルタ送信元情報 IPアドレス v4 String No
15-4 senderMask フィルタ送信元情報 サブネットマスク v4 String No
15-5 senderPortNumber フィルタ送信元情報 ポート番号 v4 String No
15-6 receiverAddress フィルタ宛先情報 IPアドレス v4 String No
15-7 receiverMask フィルタ宛先情報 サブネットマスク v4 String No
15-8 receiverProtocol フィルタ宛先情報 プロトコル v4 String No
15-9 receiverProtocolNumber フィルタ宛先情報 プロトコル番号 v4 String No
15-10 receiverPortNumber フィルタ宛先情報 ポート番号 v4 String No
15-11 action アクション v4 String No

Response Parameters [infoTypeとして 拠点契約NAT変換情報:vUnoapiUnoBaseNat を指定した場合]

No Name Description Type Mandatory
16 vUnoapiUnoBaseNat 拠点契約NAT変換情報 array No
16-1 contractId 契約ID(N番) String No
16-2 serialNumber NAT通番 String No
16-3 beforeAddressConversion NAT 変換前NWアドレス String No
16-4 afterAddressConversion NAT 変換後NWアドレス String No
16-5 afterMaskConversion NAT 変換後マスク String No
16-6 afterMaskConversion NAT 変換後マスク String No

Response Parameters [infoTypeとして 拠点契約ToSビット書き換え情報:vUnoapiUnoBaseTos を指定した場合]

No Name Description Type Mandatory
17 vUnoapiUnoBaseTos 拠点契約ToSビット書き換え情報 array No
17-1 contractId 契約ID(N番) String No
17-2 serialNumber ToSビット書き換え通番 v4 String No
17-3 tosBit ToSビット v4 String No
17-4 senderAddress ToS書換 送信元情報 IPアドレス v4 String No
17-5 senderMask ToS書換 送信元情報 プレフィックス v4 String No
17-6 senderPortNumber ToS書換 送信元情報 ポート番号 v4 String No
17-7 receiverAddress ToS書換 宛先情報 IPアドレス v4 String No
17-8 receiverMask ToS書換 宛先情報 プレフィックス v4 String No
17-9 receiverProtocol ToS書換 宛先情報 プロトコル v4 String No
17-10 receiverProtocolNumber ToS書換 宛先情報 プロトコル番号 v4 String No
17-11 receiverPortNumber ToS書換 宛先情報 ポート番号 v4 String No

Response Parameters [infoTypeとして ASPMSE利用機能情報:vUnoapiAspmseUtil を指定した場合]

No Name Description Type Mandatory
18 vUnoapiAspmseUtil ASPMSE利用機能情報 array No
18-1 contractId 契約ID(N番) String No
18-2 bgpRouteAdvertisementKind BGP経路広告種別 String No
18-3 bgpFilterEgressDefault BGPフィルタEgress(Default) String No
18-4 vlanNumber ASP側IF VLAN番号 String No

Response Parameters [infoTypeとして ASPMSE利用機能アドレス情報:vUnoapiAspmseUtilAddress を指定した場合]

No Name Description Type Mandatory
19 vUnoapiAspmseUtilAddress ASPMSE利用機能アドレス情報 array No
19-1 contractId 契約ID(N番) String No
19-2 addressCodeKind アドレス種別コード String No
19-3 addressNameKind アドレス種別名 String No
19-4 address アドレス値 String No
19-5 mask アドレスマスク値 String No

Response Parameters [infoTypeとして ASPMSE利用機能NATフィルタリング情報:vUnoapiAspmseUtilFilter を指定した場合]

No Name Description Type Mandatory
20 vUnoapiAspmseUtilFilter ASPMSE利用機能NATフィルタリング情報 array No
20-1 contractId 契約ID(N番) String No
20-2 protocol プロトコル String No
20-3 serialNumber NATフィルタリング通番 String No
20-4 maximumPort ポート上限Dist String No
20-5 minimumPort ポート下限Dist String No

Response Parameters [infoTypeとして ASPMSE利用機能NAT端末情報:vUnoapiAspmseUtilNat を指定した場合]

No Name Description Type Mandatory
21 vUnoapiAspmseUtilNat ASPMSE利用機能NAT端末情報 array No
21-1 contractId 契約ID(N番) String No
21-2 serialNumber NAT端末通番 String No
21-3 natConversionAddressAct NAT変換アドレス String No
21-4 natConversionAddressSby NAT変換アドレス(SBY) String No
21-5 natAddress NAT端末アドレス String No

Example Result

{   
  "ifType": "20",   
  "contractId": "N111288775",   
  "vUnoapiUnoMain": [   
    {   
      "contractId": "N111288775",
      "addressBorrowingPlan": "シンプル",   
      "ipv4PlanFreeExists": "無",    
      "vpnConnectionExists": "無",   
      "internetConnectExists": "無", 
      "internetConnectBand": null   
    }   
  ],    
  "resultCode": "00000000"  
}


* レスポンス形式・項目等はご契約内容によって異なります。
 詳細については別途お問い合わせください。  

トラフィック情報取得

 VPNグループID、契約ID(N番)及びデータ項目(回線使用率/回線情報量)を指定し、JSONもしくはPNGファイル形式にて返却するAPIです。

トラフィック情報取得 

GET /v4/uno/traffic/{vpnGroupId}/{contractId}?dataType={dataType}&from={from}&to={to}&direction={direction}&interval={interval}&format={format}

Request Parameters [path variable]

Name Description Type Mandatory
vpnGroupId VPNグループIDを指定
VPNグループID:'V'+8桁の数字
String Yes
contractId サービスの契約ID(N番)を指定
契約ID(N番):'N'+9桁の数字
String Yes

Request Parameters [query argument]

Name Description Type Mandatory
dataType データ項目を指定
utilization:国内 回線使用率(%)
traffic:国内 回線情報量(bps)
String Yes
from 表示開始日時を指定 #1#2 Date Yes
to 表示終了日時を指定 #1#2 Date Yes
direction データ送受信経路種別を指定
in:上り[受信]、out:下り[送信]、inout:上り[受信]・下り[送信] (両方)
String Yes
interval プロット間隔を指定
realtime:5分 daily:日 
String Yes
format 戻り値フォーマットを指定
json:JSON形式、png:PNG形式グラフ画像
String Yes

 #1.JSTを指定
 #2.realtimeである時のみ有効

Example Request

Host: api.ntt.com 
GET /v4/uno/traffic/V12345678/N123456789?dataType=utilization&from=201808090000&to=201808202359&direction=in&interval=realtime&format=json 
HEADER Authorization: Bearer [YOUR_ACCESS_TOKEN]*
* トークンの取得についてはOAuth APIのページをご参照ください。

Response Parameters

No Name Description Type Mandatory
1 version バージョン String Yes
2 contractState 契約状態 Object Yes
2-1 period 期間 Object Yes
2-1-1 from 期間 (From)
yyyy-MM-dd HH:mm形式
String No
2-1-2 to 期間 (To)
yyyy-MM-dd HH:mm形式
String No
3 utilization / traffic 回線使用率/回線情報量の情報
リクエストパラメータのdataField(データ項目)により切り替えて出力
utilization:dataTypeがutilizationの場合を出力
traffic:dataTypeがtrafficの場合を出力
Object No
3-1 prefecture 都道府県 String No
3-2 companyName 事業者名 String No
3-3 lineUseRateDayMax 回線使用率日最大 Object No
3-3-1 in 受信最大量
リクエストパラメータのdirection(種別)が、in(受信)、inout(受信・送信)の場合のみ出力
String No
3-3-2 out 送信最大量
リクエストパラメータのdirection(種別)が、out(送信)、inout(受信・送信)の場合のみ出力
String No
3-4 lineUseRate / trafficVolume トラフィックデータの種別
リクエストパラメータのdataField(データ項目)により切り替えて出力
lineUseRate:dataTypeがutilizationの場合を出力
trafficVolume:dataTypeがtrafficの場合を出力
Object No
3-4-1 in 回線使用率(%)/回線情報量(bps)
リクエストパラメータのdirection(種別)が、in(受信)、inout(受信・送信)の場合のみ出力
array No
3-4-1-1 datetime 対象年月日時
yyyy-MM-dd HH:mm形式
String No
3-4-1-2 value 回線使用率(%)/回線情報量(bps) String No
3-4-2 out 回線使用率(%)/回線情報量(bps)
リクエストパラメータのdirection(種別)が、out(送信)、inout(受信・送信)の場合のみ出力
array No
3-4-2-1 datetime 対象年月日時
yyyy-MM-dd HH:mm形式
String No
3-4-2-2 value 回線使用率(%)/回線情報量(bps) String No
4 requestDateFrom 表示開始日時 (From)
yyyy-MM-ddTHH:mm+0900形式
String Yes
5 requestDateTo 表示開始日時 (To)
yyyy-MM-ddTHH:mm+0900形式
String Yes

Example Result

{
    "version": "1.00",
    "contractState": {
        "period": {
            "from": "2018-08-31 00:00",
            "to": ""
        }
    },
    "utilization": {
        "prefecture": "神奈川県",
        "companyName": "●●●●",
        "lineUseRateDayMax": {
            "in": "100.0",
            "out": "100.0"
        },
        "lineUseRate": {
            "in": [
            {
                "datetime": "2018-11-01 00:00",
                "value": "0.00466543888888888963"
            },{
                "datetime": "2018-11-02 00:00",
                "value": "0.00938773518518518958"
            },{
                "datetime": "2018-11-03 00:00",
                "value": "0.00471911851851852023"
            }],
            "out": [
            {
                "datetime": "2018-11-01 00:00",
                "value": "0.00544012592592593019"
            },{
                "datetime": "2018-11-02 00:00",
                "value": "0.00545079814814814975"
            },{
                "datetime": "2018-11-03 00:00",
                "value": "5.41481481481481009e-06"
            }]
        }
    },
    "requestDateFrom": "2018-11-01T12:00+0900",
    "requestDateTo": "2018-11-03T13:00+0900"
}

回線アラーム情報取得

  指定されたVPNグループID、契約IDに紐づくArcstrar Universal Oneの回線アラームを取得するAPIです。
  最大過去90日前までのアラーム履歴を取得することができます。

回線アラーム情報取得

GET /v4/uno/circuitalarms/{vpnGroupId}?contractId={contractId}&originalEventTimeFrom={originalEventTimeFrom}&originalEventTimeTo={originalEventTimeTo}&eventTimeFrom={eventTimeFrom}&eventTimeTo={eventTimeTo}&clearanceTimeFrom={clearanceTimeFrom}&clearanceTimeTo={clearanceTimeTo}&lastModificationTimeFrom={lastModificationTimeFrom}&lastModificationTimeTo={lastModificationTimeTo}&clearanceReportFlag={clearanceReportFlag}&top={top}&skip={skip}&maxPageSize={maxPageSize}&orderBy={orderBy}  

Request Parameters [path variable]

Name Description Type Mandatory
vpnGroupId VPNグループIDを指定
VPNグループID:'V'+8桁の数字
String Yes

Request Parameters [query argument]

Name Description Type Mandatory
contractId サービスの契約ID(N番)を指定
契約ID(N番):'N'+9桁の数字
String Yes
originalEventTimeFrom アラーム発生開始日時を指定 #1
日時指定例:201901010000
Date No
originalEventTimeTo アラーム発生終了日時を指定 #1
日時指定例:201912312359
Date No
eventTimeFrom アラーム重要度更新開始日時を指定 #1
日時指定例:201901010000
Date No
eventTimeTo アラーム重要度更新終了日時を指定 #1
日時指定例:201912312359
Date No
clearanceTimeFrom アラーム回復開始日時を指定 #1
日時指定例:201901010000
Date No
clearanceTimeTo アラーム回復終了日時を指定 #1
日時指定例:201912312359
Date No
lastModificationTimeFrom レコード更新開始日時を指定 #1
日時指定例:201901010000
Date No
lastModificationTimeTo レコード更新終了日時を指定 #1
日時指定例:201912312359
Date No
clearanceReportFlag 故障回復フラグを指定 #2
true:故障回復 false:故障発生
Boolean No
top 上位出力件数を指定 #2 Int No
skip 読み飛ばし件数を指定 #2 Int No
maxPageSize 出力件数を指定 #3 Int No
orderBy ソート順を指定 #4
例:originalEventTimeFrom desc
Int No

 #1.JSTを指定
 #2. 指定がない場合、条件の絞り込みはしない
 
#3.別途指定がない場合は0を指定したとみなす**
 #4.別途指定がない場合は10を指定したとみなす
 #5.alarmIdをソート順とKEYとして指定する場合はidとすること

Example Request

GET /v4/uno/circuitalarms/V12345678?contractId=N123456789&originalEventTimeFrom=201901010000&originalEventTimeTo=201901312359&eventTimeFrom=201901010000&eventTimeTo=201901312359&clearanceTimeFrom=201901010000&clearanceTimeTo=201901312359&lastModificationTimeFrom=201901010000&lastModificationTimeTo=20190131&clearanceReportFlag=false&top=10&skip=1&maxPageSize=1&orderBy=alarmName desc,optionService     
HEADER Authorization: Bearer [YOUR_ACCESS_TOKEN]*
* トークンの取得についてはOAuth APIのページをご参照ください。

Response Parameters

No Name Description Type Mandatory
1 hitCount 結果件数 Int Yes
2 value 回線アラーム情報 array Yes
2-1 contractId サービスの契約ID(N番) String Yes
2-2 vpnGroupId VPNグループID String Yes
2-3 originalAlarmName 原アラーム名 String Yes
2-4 originalEventTime アラーム発生時刻(JST)
yyyy-MM-ddTHH:mm+0900形式(JST時間)
String Yes
2-5 alarmDescription アラーム説明 String No
2-6 rootCauseDescription 根本原因説明 String No
2-7 requestDescription お客様対応依頼内容 String No
2-8 plannedOutage 計画工事フラグ
true:計画工事期間内 false:計画工事期間外
Boolean Yes
2-9 plannedOutageDescription 計画工事フラグ説明 String Yes
2-10 noManageReason 静観(お客様工事)フラグ
true:静観期間内 false:静観期間外
Boolean Yes
2-11 noManageReasonDescription 静観(お客様工事)フラグ説明 String Yes
2-12 alarmId アラームID Int Yes
2-13 clearanceReportFlag 故障回復フラグ
true:故障回復 false:故障発生
Boolean Yes
2-14 clearanceReportFlagDescription 故障回復フラグ説明 String Yes
2-15 alarmName アラーム名 String Yes
2-16 originalSeverity 原アラーム重要度
5:Critical 4:Waring 3:Major 2:Minor 1:Indeterminate 0:Clear
Int Yes
2-17 originalSeverityName 原アラーム重要度説明 String Yes
2-18 perceivedSeverity アラーム重要度
 5:Critical 4:Waring 3:Major 2:Minor 1:Indeterminate 0:Clear
Int Yes
2-19 perceivedSeverityName アラーム重要度説明 String Yes
2-20 eventTime アラーム重要度更新時刻(JST)
yyyy-MM-ddTHH:mm+0900形式(JST時間)
String Yes
2-21 clearanceTime アラーム回復時刻(JST)
yyyy-MM-ddTHH:mm+0900形式(JST時間)
String No
2-22 lastModificationTime レコード更新時刻(JST)
yyyy-MM-ddTHH:mm+0900形式(JST時間)
String Yes
* オブジェクト内のデータの並び順は不定です。
* 値がない項目は、レスポンスされません。

Example Result

{
    "hitCount":"1",
    "value": [
    {
        "contractId" : "N123456789",
        "vpnGroupId" : "V12345678",
        "originalAlarmName" : "UNO(L3) eeNMS(WAN_MAIN) Ping_status NG (/) (from:eeNMS)",
        "originalEventTime" : "2019-03-01T18:07:32+0900"
        "alarmDescription" : "There was no ping response from WAN side of UniverasalOne terminal",
        "plannedOutage" : false,
        "plannedOutageDescription" : "計画工事期間外",
        "noManageReason" : false,
        "noManageReasonDescription" : "静観期間外",
        "alarmId" : 10784000,
        "clearanceReportFlag" : false,
        "clearanceReportFlagName" : "故障発生",
        "alarmName" : "UNO(L3) eeNMS(WAN_MAIN) Ping_status NG (/) (from:eeNMS)",
        "originalSeverity" : 5,
        "originalSeverityName" : "Critical",
        "perceivedSeverity" : 5,
        "perceivedSeverityName" : "Critical",
        "eventTime" : "2019-03-02T18:07:32+0900",
        "clearanceTime" : "2019-03-0418:07:32+0900",
        "lastModificationTime" : "2019-03-04T04:00:02+0900"
    }]
}   

ギャランティ工事情報更新一覧取得

  取得対象の工事情報の最終更新日時を指定し、工事情報の更新一覧をJSON形式にて返却します。

ギャランティ工事情報更新一覧取得

GET /v4/uno/maintenance?plan=guarantee&updateTimeFrom={updateTimeFrom}&updateTimeTo={updateTimeTo} 

Request Parameters [query argument]

Name Description Type Mandatory
plan 工事情報プランを指定
固定値:guarantee
String Yes
updateTimeFrom 最終更新日時(from)を指定
日付指定例:20180101
日時指定例:201801010000
Date Yes
updateTimeTo 最終更新日時(to)を指定
日付指定例:20181231
日時指定例:201812312359
Date Yes

Example Request

Host: api.ntt.com 
GET /v2/uno/maintenance?plan=guarantee&updateTimeFrom=20180803&updateTimeTo=20180827
HEADER Authorization: Bearer [YOUR_ACCESS_TOKEN]*
* トークンの取得についてはOAuth APIのページをご参照ください。

Response Parameters

No Name Description Type Mandatory
1 totalCount 検索結果件数 Int Yes
2 pageNumber 検索結果ページの番号 Int No
3 pageSize 検索結果1ページ当たりの総表示件数 Int No
4 prePageNumber 検索結果ページの1ページ前のページ番号 Int No
5 nextPageNumber 検索結果ページの1ページ次のページ番号 Int No
6 firstPageNumber 検索結果ページの1ページ最初のページ番号 Int No
7 lastPageNumber 検索結果ページの1ページ最後のページ番号 Int No
8 items 検索結果情報 array No
8-1 lineContractId 契約ID(N番) String No
8-2 agmUuid 借用回線UUID String No
8-3 lastModifiedAc 最終更新日時
yyyy-MM-ddTHH:mm:ss.SSS+0900形式(JST時間)
String No
* 検索結果ページの件数が2以上であった場合は、該当データを全て取得できていない可能性があるため
 条件を絞り込み再度APIを実行してください。

Example Result

{
    "totalCount": 3,
    "pageNumber": "1",
    "pageSize": "1000",
    "prePageNumber": "1",
    "nextPageNumber": "1",
    "firstPageNumber": "1",
    "lastPageNumber": "1",
    "items": [
    {
        "lineContractId": "N123456780",
        "amgUuid": "5F123456789012345678901234567890",
        "lastModifiedAc": "2018-01-22T16:34:12.059+0900"
    },{
        "lineContractId": "N123456781",
        "amgUuid": "5F123456789012345678901234567890",
        "lastModifiedAc": "2018-01-22T16:34:12.180+0900"
    },{
        "lineContractId": "N123456782",
        "amgUuid": "5F123456789012345678901234567890",
        "lastModifiedAc": "2018-01-22T16:34:12.633+0900"
    }]
}

ギャランティ工事詳細情報取得

  VPNグループID及び契約ID(N番)を指定し、工事情報をJSON形式にて返却するAPIです。

ギャランティ工事詳細情報取得

GET /v4/uno/maintenance/{vpnGroupId}/{contractId}?plan=guarantee&agmUuid={agmUuid}

Request Parameters [path variable]

Name Description Type Mandatory
vpnGroupId VPN番号を指定
VPN番号:'V'+8桁の数字
String Yes
contractId サービスの契約ID(N番)を指定
契約ID(N番):'N'+9桁の数字
String Yes

Request Parameters [query argument]

Name Description Type Mandatory
plan 工事情報プランを指定
固定値:guarantee
String Yes
agmUuid 借用回線UUIDを指定 String No

Example Request

Host: api.ntt.com 
GET /v4/uno/maintenance/V1245678/N123456789?plan=guarantee&agmUuid=x23fd9dae90adbewefdwe482000000000000001 
HEADER Authorization: Bearer [YOUR_ACCESS_TOKEN]*
* トークンの取得についてはOAuth APIのページをご参照ください。

Response Parameters

No Name Description Type Mandatory
1 totalCount 検索結果件数 Int Yes
2 pageNumber 検索結果ページの番号 Int No
3 pageSize 検索結果1ページ当たりの総表示件数 Int No
4 prePageNumber 検索結果ページの1ページ前のページ番号 Int No
5 nextPageNumber 検索結果ページの1ページ次のページ番号 Int No
6 firstPageNumber 検索結果ページの1ページ最初のページ番号 Int No
7 lastPageNumber 検索結果ページの1ページ最後のページ番号 Int No
8 items 検索結果情報 array No
8-1 lastModifiedAc 最終更新日時
yyyy-MM-ddTHH:mm:ss.SSS+0900形式(JST時間)
String No
8-2 agmUuid 借用回線UUID String No
8-3 agmMngNo 借用管理番号 String No
8-4 circuitId 回線ID String No
8-5 atmOnlyCircuitId ATM契約専用回線ID String No
8-6 lineContractId 契約ID(N番) String No
8-7 lineDescription 回線種別 String No
8-8 correspondGroupId グループ番号 String No
8-9 serviceName サービス種別 String No
8-10 contractSpeed 回線速度 String No
8-11 upOfficeName お客様事業所名(上位) String No
8-12 lowOfficeName お客様事業所名(下位) String No
8-13 tocWorkerDivision TOC担当部署 String No
8-14 tocWorkerTel TOC担当TEL String No
8-15 startDay 開始年月日-時間
yyyy-MM-ddTHH:mm:ss.SSS+0900形式(JST時間)
String No
8-16 endDay 終了年月日-時間
yyyy-MM-ddTHH:mm:ss.SSS+0900形式(JST時間)
String No
8-17 startDay2 開始年月日-時間②
yyyy-MM-ddTHH:mm:ss.SSS+0900形式(JST時間)
String No
8-18 endDay2 終了年月日-時間②
yyyy-MM-ddTHH:mm:ss.SSS+0900形式(JST時間)
String No
8-19 way 工事方法 String No
8-20 impactTime 影響時間 Int No
8-21 timeUnit 影響時間の単位 String No
8-22 count 影響回数 Int No
8-23 aopImportance AOP重要度 String No
8-24 customerImpact お客様への影響 String No
8-25 circuitContactMatter お客様連絡事項【回線単位】 String No
8-26 customerConstReason お客様工事理由 String No
8-27 customerContactMatter お客様連絡事項【借用単位】 String No
* レスポンス形式・項目等はご契約内容によって異なります。
 詳細については別途お問い合わせください。  

Example Result

{   
    "totalCount": "1",  
    "pageNumber": "1",  
    "pageSize": "10",   
    "prePageNumber": "1",   
    "nextPageNumber": "1",  
    "firstPageNumber": "1", 
    "lastPageNumber": "1",  
    "items": [  
    {   
       "lastModifiedAc": "2019-03-19T13:30:32.536+0900",
       "agmMngNo": "C00167-0",
       "agmUuid": "7A35EC89AAF56013E053E40112AC644A",
       "lineContractId": "N123456789",
       "aopImportance": "2",
       "circuitId": "N180123456",
       "atmOnlyCircuitId": "999999999",
       "lineDescription": "1",
       "correspondGroupId": "V12345678",
       "serviceName": "Universal One",
       "contractSpeed": "100",
       "upOfficeName": "○×会社",
       "lowOfficeName": "○×■会社",
       "tocWorkerDivision": "TOC担当部署",
       "tocWorkerTel": "0312345678",
       "startDay": "2018-11-20T02:00:00.000+0900",
       "endDay": "2018-11-20T05:00:00.000+0900",
       "way": "2",
       "impactTime": "1",
       "timeUnit": "0",
       "count": "1",
       "circuitContactMatter": "〇〇〇",
       "customerConstReason": "計画停電のため",
       "customerContactMatter": "×××"
    }]    
}   

ベストエフォート工事情報取得

  指定されたVPNグループID、契約ID(N番)、エリアコード及び商品コードに紐づく工事情報をJSON形式にて返却するAPIです。

ベストエフォート工事情報取得

GET /v4/uno/maintenance?plan=besteffort&vpnGroupId={vpnGroupId}&contractId={contractid}&areaCode={areacode}&goodsCode={goodscode} 

Request Parameters [query argument]

Name Description Type Mandatory
plan 工事情報プランを指定
固定値:besteffort
String Yes
vpnGroupId VPNグループIDを指定
VPNグループID:'V'+8桁の数字
String Yes #1#2
contractId サービスの契約ID(N番)を指定
契約ID(N番):'N'+9桁の数字
String Yes #1#2
areaCode エリアコードを指定(複数指定可能)#3
エリアコード:3桁の数字
Int Yes #1
goodsCode 商品コードを指定
固定値:vpn-besteffort
String No
maintenanceStatus 工事ステータスを指定(複数指定可能)#3#4
0:工事前, 1:工事中, 2:完了, -:指定なし
String No
troubleStatus 故障ステータスを指定(複数指定可能)#3#4
0:対応中, 1:復旧済み, -:指定なし
String No

 #1.VPNグループIDと契約ID(N番)、もしくはエリアコードのみ指定可能とし、
    VPNグループID、契約ID(N番)とエリアコードの3つを指定した場合はエラーとなる。

 #2.VPNグループID、契約ID(N番)は2つ指定しない場合はエラーとなる。
 #3.条件を複数指定する場合はカンマ(",")で区切る。(複数指定された条件は、OR条件として検索される。)
 #4.工事情報ステータスと故障情報ステータスの両方を指定した場合は、
    工事情報ステータスと故障情報ステータスを合わせてOR条件として検索される。

     

エリアコード

地域コード 都道府県コード
301:北海道 401:北海道
302:東北 402:青森 , 403:岩手 , 404:宮城 , 405:秋田 , 406:山形 , 407:福島
303:関東 408:東京 , 409:神奈川 , 410:埼玉 , 411:千葉 , 412茨城 , 413:栃木 , 414:群馬
304:東海 421:愛知 , 422:岐阜 , 423:静岡 , 424:三重
305:甲信越 415:山梨 , 416:新潟 , 417:長野
306:北陸 418:富山 , 419:石川 , 420:福井
307:近畿 425:大阪 , 426:兵庫 , 427:京都 , 428:滋賀 , 429:奈良 , 430:和歌山
308:中国 431:鳥取 , 432:島根 , 433:岡山 , 434:広島 , 435:山口
309:四国 436:徳島 , 437:香川 , 438:愛媛 , 439:高知
310:九州 440:福岡 , 441:佐賀 , 442:長崎 , 443:熊本 , 444:大分 , 445:宮崎 , 446:鹿児島 , 447:沖縄

Example Request

Host: api.ntt.com 
GET /v4/uno/maintenance?plan=besteffort&vpnGroupId=V12345678&contractId=N123456789&areaCode=408&goodsCode=vpn-besteffort&maintenanceStatus=0&troubleStatus=-     
HEADER Authorization: Bearer [YOUR_ACCESS_TOKEN]*
* トークンの取得についてはOAuth APIのページをご参照ください。

Response Parameters

No Name Description Type Mandatory
1 items 工事・故障情報 array No
1-1 title 工事・故障タイトル String No
1-2 kind 工事・故障種別
1:工事 2:故障
Int No
1-3 kindDescription 工事・故障種別名 String No
1-4 code 工事・故障ID String No
1-5 displayUpdateDate 表示用更新年月日(JST)
yyyy-MM-ddTHH:mm+0900形式(JST時間)
String No
1-6 displayUpdateDateUtc 表示用更新年月日(UTC)
yyyy-MM-ddTHH:mmZ形式(UTC時間)
String No
1-7 maintenanceStatus 工事ステータス
1:工事前 2:工事中 3:完了
Int No
1-8 maintenanceStatusDescription 工事ステータス名 String No
1-9 troubleStatus 故障ステータス
1:故障中 2:復旧済み
Int No
1-10 troubleStatusDescription 故障ステータス名 String No
1-11 importantFlg 重要フラグ
0:通常(故障の場合0固定) 1:重要
Int No
1-12 importantDescription 重要名 String No
1-13 maintenanceStartDate 工事開始日時
yyyy-MM-ddTHH:mm+0900形式(JST時間)
String No
1-14 maintenanceEndDate 工事終了日時
yyyy-MM-ddTHH:mm+0900形式(JST時間)
String No
1-15 troubleOccuredDate 発生日時
yyyy-MM-ddTHH:mm+0900形式(JST時間)
String No
1-16 troubleRestoreDate 復旧日時
yyyy-MM-ddTHH:mm+0900形式(JST時間)
String No
1-17 maintenanceStartDateUtc 工事開始日時(UTC)
yyyy-MM-ddTHH:mmZ形式(UTC時間)
String No
1-18 maintenanceEndDateUtc 工事終了日時(UTC)
yyyy-MM-ddTHH:mmZ形式(UTC時間)
String No
1-19 troubleOccuredDateUtc 発生日時(UTC)
yyyy-MM-ddTHH:mmZ形式(UTC時間)
String No
1-20 troubleRestoreDateUtc 復旧日時(UTC)
yyyy-MM-ddTHH:mmZ形式(UTC時間)
String No
1-21 targetArea 工事対象エリアコード String No
1-22 mainTextPc PCサイト用本文 String No
1-23 influencedPlanDisplay 影響のあるサービス(画面表示用)
工事・故障登録時、実際画面表示される影響のあるサービス
String No
1-24 targetFacilityDisplay 影響のある設備(画面表示用)
工事・故障登録時、実際画面表示される影響のある設備
String No
1-25 targetAreaDisplay 工事対象エリア(画面表示用)
工事・故障登録時、実際画面表示されるエリア
String No
1-26 matchParamType 合致したパラメータ
1:商品コード 2:契約ID(N番) 3:エリアコード
String No

Example Result

{
    "items": [
    {
        "title": "【L3 ベストエフォート】青森県エリア地域IP網メンテナンス工事のお知らせ",
        "kind": 1,
        "kindDescription": "工事",
        "code": "12001",
        "displayUpdateDate":"2018-10-19T15:04+0900",
        "displayUpdateDateUtc":"2018-10-19T06:04Z",
        "maintenanceStatus": 3,
        "maintenanceStatusDescription": "完了",
        "troubleStatus": "",
        "troubleStatusDescription": "",
        "importantFlg": 0,
        "importantDescription": "通常",
        "maintenanceStartDate": "2018-10-26T00:00+0900",
        "maintenanceEndDate": "2018-10-26T06:00+0900",
        "troubleOccuredDate": "",
        "troubleRestoreDate": "",
        "maintenanceStartDateUtc": "2018-10-25T15:00Z",
        "maintenanceEndDateUtc": "2018-10-25T21:00Z",
        "troubleOccuredDateUtc": "",
        "troubleRestoreDateUtc": "",
        "targetArea": "402",
        "mainTextPc": "特定加入者回線部分のアクセスポイントで、工事時間帯において一時的にご利用できなくなる場合がございます。",
        "influencedPlanDisplay": "特定加入者回線部分(光ネクスト)",
        "targetFacilityDisplay": "",
        "targetAreaDisplay": "青森県エリアの全域",
        "matchParamType": 3
    }]
}

回線監視停止情報取得

  指定されたVPNグループID、契約ID、工事開始日時及び工事終了日時に紐づく回線監視停止情報を返却するAPIです。

回線監視停止情報取得

GET /v4/uno/monitoringsuspension/{vpnGroupId}/{contractId}?workDateFrom={workDateFrom}&workDateTo={workDateTo}  

Request Parameters [path variable]

Name Description Type Mandatory
vpnGroupId VPNグループIDを指定
VPNグループID:'V'+8桁の数字
String Yes
contractId サービスの契約ID(N番)を指定
契約ID(N番):'N'+9桁の数字
String Yes

Request Parameters [query argument]

Name Description Type Mandatory
workDateFrom 工事開始日時を指定 #1 #2 #3
日時指定例:201901010000
Date No
workDateTo 工事終了日時を指定 #1 #2 #3
日時指定例:201912312359
Date No

 #1.JSTを指定
 #2.秒は「00秒」もしくは「59秒」のみ指定可能
 #3.工事開始日時、工事終了日時が共に未指定の場合は、工事開始日時に現在時刻を指定したとみなす

Example Request

Host: api.ntt.com 
GET /v4/uno/monitoringsuspension/V12345678/N123456789?workDateFrom=20190101130000&workDateTo=20191231235959     
HEADER Authorization: Bearer [YOUR_ACCESS_TOKEN]*
* トークンの取得についてはOAuth APIのページをご参照ください。

Response Parameters

No Name Description Type Mandatory
1 hitCount 結果件数 Int No
2 items 監視停止回線情報 array No
2-1 insertDate 作成年月日時分秒(JST)
yyyy-MM-ddTHH:mm+0900形式(JST時間)
String No
2-2 workId 工事ID Int No
2-3 workDiv 工事区分
01:SO Maint(オーダ工事) 02:Com Maint(NTTCom工事) 03:Cust Maint(お客様工事) 04:Testing(回線試験) 05:Urgent Maint(緊急メンテナンス) 99:Others(その他)
Int No
2-4 workDivDescription 工事区分名 String No
2-5 workTargetId 工事対象ID String No
2-6 workTargetDiv 工事対象区分
01:Customer System(お客様システム) 02:Network(バックボーン通信グループ) 03:Site(拠点) 04:Circuit(回線) 05:CPE/LAN Equipments(宅内機器)
Int No
2-7 workTargetDivDescription 工事対象区分名 String No
2-8 workRepeatDiv 工事繰り返し区分
00:No(繰り返しなし) 10:Every day(毎日) 20:Weekly(毎週) 30:Monthly(毎月) 40:Holiday(祝日) 90:Permanent(恒久)
Int No
2-9 workRepeatDivDescription 工事繰り返し区分名 String No
2-10 workDateFrom 工事開始日時
yyyy-MM-ddTHH:mm+0900形式(JST時間)
String No
2-11 workDateTo 工事終了日時
yyyy-MM-ddTHH:mm+0900形式(JST時間)
String No
2-12 workTimeFrom 工事開始時刻(JST)
HH24:MM:SS形式(JST時間)
String No
2-13 workTimeTo 工事終了時刻(JST)
HH24:MM:SS形式(JST時間)
String No
2-14 workWeekdayFrom 工事開始曜日コード
01:Sun(日) 02:Mon(月) 03:Tue(火) 04:Wed(水) 05:Thu(木) 06:Fri(金) 07:Sat(土)
Int No
2-15 workWeekdayFromName 工事開始曜日コード名 String No
2-16 workWeekdayTo 工事終了曜日コード
01:Sun(日) 02:Mon(月) 03:Tue(火) 04:Wed(水) 05:Thu(木) 06:Fri(金) 07:Sat(土)
Int No
2-17 workWeekdayToName 工事終了曜日コード名 String No
2-18 workDayFrom 工事開始日コード
01~31:1日~31日 98:月末前日 99:月末日
Int No
2-19 workDayFromName 工事開始日コード名 String No
2-20 workDayTo 工事終了日コード
01~31:1日~31日 98:月末前日 99:月末日
Int No
2-21 workDayToName 工事終了日コード名 String No
2-22 workHolidayFrom 工事開始祝日コード
01:Yesterday Before Holiday(祝前々日) 02:Before Holiday(祝前日) 03:Holiday(祝日) 04:After Holiday(祝翌日) 05:Tommorow After Holiday(祝翌々日)
Int No
2-23 workHolidayFromName 工事開始祝日コード名 String No
2-24 workHolidayTo 工事終了祝日コード
01:Yesterday Before Holiday(祝前々日) 02:Before Holiday(祝前日) 03:Holiday(祝日) 04:After Holiday(祝翌日) 05:Tommorow After Holiday(祝翌々日)
Int No
2-25 workHolidayToName 工事終了祝日コード名 String No
2-26 remarks 備考 String No
2-27 receiptNo 受付番号 Int No
2-28 parentWorkId 親工事ID Int No
2-29 workEndIssue 工事終了時起票有無 
0:アラートのチケットを起票しない 1:アラートのチケットを起票する
Int No
2-30 workEndIssueDescription 工事終了時起票有無説明 String No

Example Result

{           
    "hitCount":1,       
    "items":[       
            {   
            "insertDate":"2018-11-10T05:42:00+0900",
            "workId":"0001458914",
            "workDiv":"04",
            "workDivDescription":"Testing(回線試験)",
            "workTargetId":"N160116028",
            "workTargetDiv":"04",
            "workTargetDivDescription":"Circuit(回線)",
            "workRepeatDiv":"20",
            "workRepeatDivDescription":"Weekly(毎週)",
            "workDateFrom":"2018-12-10T05:42:00+0900",
            "workDateTo":"2018-12-10T06:12:00+0900",
            "workTimeFrom":"110000",
            "workTimeTo":"200000",
            "workWeekdayFrom":"06",
            "workWeekdayFromName":"Fri(金)",
            "workWeekdayTo":"01",
            "workWeekdayToName":"SUN(日)",
            "workDayFrom":"",
            "workDayFromName":"",
            "workDayTo":"",
            "workDayToName":"",
            "workHolidayFrom":"",
            "workHolidayFromName":"",
            "workHolidayTo":"",
            "workHolidayToName":"",
            "remarks":"",
            "receiptNo":"",
            "parentWorkId":"",
            "workEndIssue":"0",
            "workEndIssueDescription":"アラートチケットを起票しない"
        }   
    ]       
}           

回線監視停止情報登録

  指定されたVPNグループID、契約IDに紐づく回線監視停止情報を登録するAPIです。

回線監視停止情報登録

POST /v4/uno/monitoringsuspension/{vpnGroupId}/{contractId}  

Request Parameters [path variable]

Name Description Type Mandatory
vpnGroupId VPNグループIDを指定
VPNグループID:'V'+8桁の数字
String Yes
contractId サービスの契約ID(N番)を指定
契約ID(N番):'N'+9桁の数字
String Yes

Request Parameters [JSON]

Name Description Type Mandatory
workDiv 工事区分を指定
01:SO Maint(オーダ工事) 02:Com Maint(NTTCom工事) 03:Cust Maint(お客様工事) 04:Testing(回線試験) 05:Urgent Maint(緊急メンテナンス) 99:Others(その他)
Int Yes
workTargetDiv 工事対象区分を指定
04:Circuit(回線) 05:CPE/LAN Equipments(宅内機器)
Int Yes
workRepeatDiv 工事繰り返し区分を指定
00:No(繰り返しなし) 10:Every day(毎日) 20:Weekly(毎週) 30:Monthly(毎月) 40:Holiday(祝日) 90:Permanent(恒久)
Int Yes
workDateFrom 工事期間開始日時を指定 #1#2
例:2019-04-01T10:00:00+0900
Date No
workDateTo 工事期間終了日時を指定 #1#2
例:2019-04-30T23:59:59+0900
Date No
workTimeFrom 工事開始時刻を指定 #1#2
例:10:00:00
Time No
workTimeTo 工事終了時刻を指定 #1#2
例:23:59:59
Time No
workWeekdayFrom 工事開始曜日コードを指定 #1
01:Sun(日) 02:Mon(月) 03:Tue(火) 04:Wed(水) 05:Thu(木) 06:Fri(金) 07:Sat(土)
Int No
workWeekdayTo 工事終了曜日コードを指定 #1
01:Sun(日) 02:Mon(月) 03:Tue(火) 04:Wed(水) 05:Thu(木) 06:Fri(金) 07:Sat(土)
Int No
workDayFrom 工事開始日コードを指定 #1
01~31:1日~31日 99:月末日
Int No
workDayTo 工事終了日コードを指定 #1
01~31:1日~31日 99:月末日
Int No
workHolidayFrom 工事開始祝日コードを指定 #1
02:Before Holiday(祝前日) 03:Holiday(祝日) 04:After Holiday(祝翌日) 05:Tommorow After Holiday(祝翌々日)
Int No
workHolidayTo 工事終了祝日コードを指定 #1
02:Before Holiday(祝前日) 03:Holiday(祝日) 04:After Holiday(祝翌日) 05:Tommorow After Holiday(祝翌々日)
Int No
remarks 備考を指定
例:計画停電を予定
Int No
workEndIssue 工事終了時起票有無を指定
0:アラートのチケットを起票しない 1:アラートのチケットを起票する
Int Yes

 #1.JSTを指定
 #2.秒は「00秒」もしくは「59秒」のみ指定可能

Example Request

Content-Type: application/json; charset=utf-8
Host: api.ntt.com
POST /v4/uno/monitoringsuspension/V12345678/N123456789     
{
  "workDiv":"01",
  "workTargetDiv":"04",
  "workRepeatDiv":"10",
  "workDateFrom":"2019-04-01T10:00:00+0900",
  "workDateTo":"2019-12-31T23:59:59+0900",
  "workTimeFrom":"100000",
  "workTimeTo":"235959",
  "remarks":"計画停電を予定",
  "workEndIssue":1
}
HEADER Authorization: Bearer [YOUR_ACCESS_TOKEN]*
* トークンの取得についてはOAuth APIのページをご参照ください。

Response Parameters

なし ※HTTPヘッダーのみ返却されます。

Example Result

HTTP/1.1 200 OK
Connection: keep-alive
Content-Length: 0
Date: Sun, 1 Sep 2019 09:00:00 GMT

回線監視停止情報更新

  指定されたVPNグループID、契約IDに紐づく回線監視停止情報を更新するAPIです。

回線監視停止情報更新

PUT /v4/uno/monitoringsuspension/{vpnGroupId}/{contractId} 

Request Parameters [path variable]

Name Description Type Mandatory
vpnGroupId VPNグループIDを指定
VPNグループID:'V'+8桁の数字
String Yes
contractId サービスの契約ID(N番)を指定
契約ID(N番):'N'+9桁の数字
String Yes

Request Parameters [JSON]

Name Description Type Mandatory
insertDate 作成年月日時分秒を指定 #1
例:2019-01-01T00:00:00+0900
Date Yes
workId 工事IDを指定
例:0001234567
Int Yes
workDateFrom 工事期間開始日時を指定 #1#2
例:2019-04-30T23:59:59+0900
Date No
workDateTo 工事期間終了日時を指定 #1#2
例:2019-04-30T23:59:59+0900
Date No
remarks 備考を指定
例:計画停電を予定
String No
workEndIssue 工事終了時起票有無を指定
0:アラートのチケットを起票しない 1:アラートのチケットを起票する
Int Yes

 #1.JSTを指定
 #2.秒は「00秒」もしくは「59秒」のみ指定可能

Example Request

Content-Type: application/json; charset=utf-8
Host: api.ntt.com
PUT /v4/uno/monitoringsuspension/V12345678/N123456789     
{
  "insertDate":"2019-01-01T00:00:00+0900",
  "workId":"0001234567",
  "workDateFrom":"2019-04-01T10:00:00+0900",
  "workDateTo":"2019-12-31T23:00:00+0900",
  "remarks":"計画停電を予定",
  "workEndIssue":"1"
}
HEADER Authorization: Bearer [YOUR_ACCESS_TOKEN]*
* トークンの取得についてはOAuth APIのページをご参照ください。

Response Parameters

なし ※HTTPヘッダーのみ返却されます。

Example Result

HTTP/1.1 200 OK
Connection: keep-alive
Content-Length: 0
Date: Sun, 1 Sep 2019 09:00:00 GMT

回線監視停止情報削除

  指定されたVPNグループID、契約IDに紐づく回線監視停止情報を削除するAPIです。

回線監視停止情報削除

DELETE /v4/uno/monitoringsuspension/{vpnGroupId}/{contractId}  

Request Parameters [path variable]

Name Description Type Mandatory
vpnGroupId VPNグループIDを指定
VPNグループID:'V'+8桁の数字
String Yes
contractId サービスの契約ID(N番)を指定
契約ID(N番):'N'+9桁の数字
String Yes

Request Parameters [JSON]

Name Description Type Mandatory
insertDate 作成年月日時分秒を指定 #1
例:2019-01-01T00:00:00+0900
Date Yes
workId 工事IDを指定
例:0001234567
Int Yes

 #1.JSTを指定

Example Request

Content-Type: application/json; charset=utf-8
Host: api.ntt.com
DELETE /v4/uno/monitoringsuspension/V12345678/N123456789     
{
  "insertDate":"2019-01-01T00:00:00+0900",
  "workId":"0001234567"
}
HEADER Authorization: Bearer [YOUR_ACCESS_TOKEN]*
* トークンの取得についてはOAuth APIのページをご参照ください。

Response Parameters

なし ※HTTPヘッダーのみ返却されます。

Example Result

HTTP/1.1 200 OK
Connection: keep-alive
Content-Length: 0
Date: Sun, 1 Sep 2019 09:00:00 GMT

回線調査

  指定されたVPNグループID、契約ID(N番)、に紐づく回線調査情報をJSON形式にて返却するAPIです。

回線調査

GET /v4/uno/circuitsurvey/{vpnGroupId}/{contractId}  

Request Parameters [query argument]

Name Description Type Mandatory
vpnGroupId VPNグループIDを指定
VPNグループID:'V'+8桁の数字
String Yes
contractId サービスの契約ID(N番)を指定
契約ID(N番):'N'+9桁の数字
String Yes

Example Request

Host: api.ntt.com 
GET /v4/uno/circuitsurvey/V12345678/N123456789
HEADER Authorization: Bearer [YOUR_ACCESS_TOKEN]*
* トークンの取得についてはOAuth APIのページをご参照ください。

Response Parameters

No Name Description Type Mandatory
1 result 処理結果 String Yes
2 uniqueId ユニークID String Yes
3 surveyTarget 調査対象判定 String Yes
4 returnInfo 調査結果 Object Yes
4-1 contractNumberAct ご契約番号(Act) String Yes
4-2 contractNumberSby ご契約番号(Standby) String Yes
4-3 contractServiceAct ご契約サービス(Act) String Yes
4-4 contractServiceSby ご契約サービス(Standby) String Yes
4-5 baseName 拠点名 String Yes
4-6 redundancyContract 冗長契約 String Yes
4-7 network お客様拠点ネットワーク String Yes
4-8 sammarizeNetwork お客様拠点サマライズネットワーク String Yes
4-9 wanIp 拠点WAN側IPアドレス String Yes
4-10 internetConnection インターネット接続オプション String Yes
4-11 contractorName 契約者名 String Yes
4-12 vpnNum VPN番号 String Yes
4-13 repNNum 代表N番号 String Yes
4-14 diagramBase 構成図(ベース) Int Yes
4-15 diagramPing 構成図(Ping結果) Int Yes
4-16 resultSummary 調査結果サマリ String Yes
4-17 resultSummaryCl 調査結果サマリ(色) String Yes
4-18 request お客さまへの依頼事項 String Yes
4-19 transmissionStatusAct 現在の状態(メイン) String Yes
4-20 transmissionStatusSby 現在の状態(スタンバイ) String Yes
4-21 unotStatusSummary Universaloneターミナル状態確認 String Yes
4-22 alarmInfoMain アラーム情報(メイン) String Yes
4-23 alarmTimeMain アラーム発生時刻(メイン) String Yes
4-24 alarmContentsMain アラーム内容(メイン) String Yes
4-25 alarmMainteFlagMain 工事フラグ(メイン) String Yes
4-26 alarmNomonitoringFlagMain 非監視フラグ(メイン) String Yes
4-27 alarmInfoSub アラーム情報(サブ) String Yes
4-28 alarmTimeSub アラーム発生時刻(サブ) String Yes
4-29 alarmContentsSub アラーム内容(サブ) String Yes
4-30 alarmMainteFlagSub 工事フラグ(サブ) String Yes
4-31 alarmNomonitoringFlagSub 非監視フラグ(サブ) String Yes
4-32 pastAlarmInfo 過去アラーム情報 String Yes
4-33 pastAlarmOccTime 過去アラーム発生日時 String Yes
4-34 pastAlarmRcvTime 過去アラーム回復日時 String Yes
4-35 pastAlarmContents 過去アラーム内容 String Yes
4-36 pastAlarmMainteFlag 工事フラグ(過去) String Yes
4-37 pastAlarmNomonitoringFlag 非監視フラグ(過去) String Yes
4-38 maintenanceInfo 工事情報 String Yes
4-39 maintenanceSubject 工事件名情報 String Yes
4-40 maintenanceFit 工事該当情報 String Yes
4-41 maintenanceStatus 工事ステータス情報 String Yes
4-42 maintenanceStartDate 工事開始時間情報 String Yes
4-43 maintenanceEndDate 工事終了時間情報 String Yes
4-44 maintenanceArea 工事影響地域・影響サービス String Yes
4-45 maintenanceContent 工事内容情報 String Yes
4-46 troubleInfo 故障情報 String Yes
4-47 troubleSubject 故障件名情報 String Yes
4-48 troubleFit 故障該当情報 String Yes
4-49 troubleStatus 故障ステータス情報 String Yes
4-50 troubleOccDate 故障発生時間情報 String Yes
4-51 troubleRecDate 故障復旧時間情報 String Yes
4-52 troubleArea 故障影響地域情報・影響サービス String Yes
4-53 troubleContent 故障内容情報 String Yes
4-54 unotStatusresult Universaloneターミナル情報取得結果 String Yes
4-55 lanIfSpeed LAN側IF速度 String Yes
4-56 lanAddress LAN側アドレス String Yes
4-57 nat NAT利用 String Yes
4-58 endEndMonitor End-End監視 String Yes
4-59 dhcpServer DHCPサーバ String Yes
4-60 dhcpRelay DHCPリレー String Yes
4-61 ipFiltaInfo IPフィルタ機能利用 String Yes
4-62 coldStandby コールドスタンバイ機 String Yes
4-63 currentTime 現在時刻 String Yes
4-64 lastStartUpTime 最終起動日時 String Yes
4-65 elapsedTime 起動後経過時間 String Yes
4-66 unot12IntIllustrationLan Ⅰ/Ⅱ型インターフェース図(LAN) [NXR-230,NXR-125] String Yes
4-67 unot12IntIllustrationWan Ⅰ/Ⅱ型インターフェース図(WAN) [NXR-230,NXR-125] String Yes
4-68 unot12IntIllustrationWan2 Ⅰ/Ⅱ型インターフェース図(WAN2) [NXR-230] String Yes
4-69 unot12IntIllustrationMobile Ⅰ/Ⅱ型インターフェース図(mobile) [NXR-230,NXR-125] String Yes
4-70 unot1EntryIntIllustrationLan Ⅰ型エントリインターフェース図(LAN) [RTX810,RTX830] String Yes
4-71 unot1EntryIntIllustrationWan Ⅰ型エントリインターフェース図(WAN) [RTX810,RTX830] String Yes
4-72 unot1EntryIllustrationWan2 Ⅰ型エントリインターフェース図(mobile) [RTX810,RTX830] String Yes
4-73 unotLanPort1 LAN(port1) String Yes
4-74 unotLanPort2 LAN(port2) String Yes
4-75 unotLanPort3 LAN(port3) String Yes
4-76 unotLanPort4 LAN(port4) String Yes
4-77 unotWanContract WAN_契約 String Yes
4-78 unotWanLinkStatus WAN_Link状態 String Yes
4-79 unotWan2Contract WAN2_契約 [NXR-230] String Yes
4-80 unotWan2LinkStatus WAN2_Link状態 [NXR-230] String Yes
4-81 unotMobileContract Mobile_契約 String Yes
4-82 unotMobileLinkStatus Mobile_Link状態 String Yes
4-83 unotMobileStrength Mobile_電波強度 Int Yes
4-84 unotPingToUno UNO-Tping→網内 String Yes
4-85 unotPingToInternet UNO-Tping→インターネット String Yes
4-86 unotName UNO-T機種名 String Yes
4-87 errMaint エラー内容 String Yes

Example Result

{
"result": "success",
"uniqueId": "20191029104057785",
"surveyTarget": "調査対象",
"returnInfo": {
  "contractNumberAct": "N123456789",
  "contractNumberSby": "N123456789",
  "contractServiceAct": "ベストエフォート(Closed)",
  "contractServiceSby": "ワイヤレスSBY",
  "baseName": "大手町ビル別館",
  "redundancyContract": "1台で2回線(固定回線+ワイヤレス)",
  "network": "172.16.000.0/24,null",
  "sammarizeNetwork": "172.16.000.0/24",
  "wanIp": "",
  "internetConnection": "無",
  "contractorName": "〇×株式会社",
  "vpnNum": "V12345678",
  "repNNum": "N123456789",
  "diagramBase": "10",
  "diagramPing": "01",
  "resultSummary": "Universal One ターミナルのLAN側ポートに接続されているお客様装置がございません。",
  "resultSummaryCl": "",
  "request": "お客さま宅内作業の有無や停電発生状況・ケーブル結線状況などをご確認いただき、レンタル機器の故障が疑われる場合弊社へお問い合わせください。",
  "transmissionStatusAct": "通信中",
  "transmissionStatusSby": "待機中",
  "unotStatusSummary": "Universal One ターミナルのLAN側ポートに接続されているお客様装置がございません。",
  "alarmInfoMain": "現在発生中のアラームはございません",
  "alarmTimeMain": "",
  "alarmContentsMain": "",
  "alarmMainteFlagMain": "",
  "alarmNomonitoringFlagMain": "",
  "alarmInfoSub": "",
  "alarmTimeSub": "72時間以内に発生したアラームはございません",
  "alarmContentsSub": "",
  "alarmMainteFlagSub": "",
  "alarmNomonitoringFlagSub": "",
  "pastAlarmInfo": "",
  "pastAlarmOccTime": "",
  "pastAlarmRcvTime": "",
  "pastAlarmContents": "",
  "pastAlarmMainteFlag": "",
  "pastAlarmNomonitoringFlag: "",
  "maintenanceInfo": "工事情報はございません",
  "maintenanceSubject": "",
  "maintenanceFit": "",
  "maintenanceStatus": "",
  "maintenanceStartDate": "",
  "maintenanceEndDate": "",
  "maintenanceArea": "",
   "maintenanceContent": "",
  "troubleInfo": "お客様拠点が含まれる地域で故障情報があります",
  "troubleSubject": "";
  "troubleFit": "可能性あり",
  "troubleStatus": "復旧済み",
  "troubleOccDate": "2019/10/26 19:50",
  "troubleRecDate": "2019/10/26 19:53",
  "troubleArea": "東京エリア/一部地域|特定加入者回線部分(光ネクスト)",
  "troubleContent": "特定加入者回線部分(光ネクスト)のアクセスポイントで、設備の故障により上記エリアで一部のお客様サービスがご利用できない状況が発生しておりましたが、現在は回復しております。該当サービスをご利用のお客様に対し、大変ご迷惑をおかけいたしましたことを深くお詫び申し上げます。|http://support.ntt.com/maintenance/service/troubleDetail/84074",
  "unotStatusresult": "",
  "lanIfSpeed": "Auto",
  "lanAddress": "172.16.210.249",
  "nat": "未契約",
  "endEndMonitor": "未契約",
  "dhcpServer": "未契約",
  "dhcpRelay": "未契約",
  "ipFiltaInfo": "未契約",
  "coldStandby": "無",
  "currentTime": "2019/10/29 10:43:15 +09:00",
  "lastStartUpTime": "2019/10/24 15:11:36 +09:00",
  "elapsedTime": "4days 19:31:39",
  "unot12IntIllustrationLan": "",
  "unot12IntIllustrationWan": "",
  "unot12IntIllustrationWan2": "",
  "unot12IntIllustrationMobile": "",
  "unot1EntryIntIllustrationLan": "black|black|black|black",
  "unot1EntryIntIllustrationWan": "green",
  "unot1EntryIllustrationWan2": "green",
  "unotLanPort1": "Auto Negotiation (Link Down)",
  "unotLanPort2": "Auto Negotiation (Link Down)",
  "unotLanPort3": "Auto Negotiation (Link Down)",
  "unotLanPort4": "Auto Negotiation (Link Down)",
  "unotWanContract": "Main",
  "unotWanLinkStatus": "Auto Negotiation (100BASE-TX Full Duplex)|black|white",
  "unotWan2Contract": "",
  "unotWan2LinkStatus": "",
  "unotMobileContract": "BackUp",
  "unotMobileLinkStatus": "接続中",
  "unotMobileStrength": "5",
  "unotPingToUno": "OK",
  "unotPingToInternet": "OK",
  "unotName": "RTX810",
  "errMaint": ""
}
}

-以上-


  1. 2014/12現在、DNSラウンドロビン運用。準備出来次第、お客さまの地理的に近いAPIゲートウェイに自動接続予定です。別途アナウンスします。