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

 ■ ご利用においての注意事項
   本APIのご利用に際して、トップページ(https://developer.ntt.com/)のサポート(https://developer.ntt.com/ja/contact.html)から下記項目をお問い合わせ欄に記載の上、事前にお問い合わせ下さい。
  ※開発者ポータルのアカウントをお持ちでない方は、【ご要望・ご質問】欄に記載下さい。

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

   ※弊社当該サービス担当者より詳細仕様、利用条件(制約等)、利用開始予定日等をご案内させて頂きます。

Resource URL

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

1.Base Path(Global Load Balance)

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

2.Base Path(Region)

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

Resource Information  

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

契約詳細情報取得API

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

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

契約詳細情報取得

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

Request Parameters

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

Example Request

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

Response Parameters

Name Description Type Mandatory
addressType 住所区分
住所を住所情報に保持するにあたり、住所種別を判別する区分
KYS:契約者住所 STB:設置場所住所
String No
postalNumber 郵便番号 Int No
address 住所
日本語/英語表記の住所情報
String No
addressCode 住所コード
住所を特定するコード
String No
banchi1 番地等1
番地情報1
String No
banchi2 番地等2
番地情報2
String No
banchi3 番地等3
番地情報3
String No
building1 建物等1
建物の情報1
String No
building2 建物等2
建物の情報2
String No
building3 建物等3
建物の情報3
String No
samakata 様方等
様方に関する情報
String No
productName 商品名
商品コードの名称
String No
productTypeName 商品種別名
商品種別コードの名称
String No
itemNameProduct 項目名契約商品詳細
項目ID
契約商品詳細の名称
String No
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": []
    }
  ]
}

トラフィック情報取得API

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

トラフィック情報取得

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

Request Parameters

Name Description Type Mandatory
vpnGroupId VPNグループID
VPNグループID:'V'+8桁の数字
path variable Yes
contractId 契約ID(N番)
N番:'N'+9桁の数字
path variable Yes
dataType データ項目
utilization:国内 回線使用率(%)
traffic:国内 回線情報量(bps)
query argument Yes
from 表示開始日時 #1#2 query argument Yes
to 表示終了日時 #1#2 query argument Yes
direction データ送受信経路種別
in:上り[受信]、out:下り[送信]、inout:上り[受信]・下り[送信] (両方)
query argument Yes
interval プロット間隔
realtime:5分 daily:日 
query argument Yes
format 戻り値フォーマット
json:JSON形式、png:PNG形式グラフ画像
query argument Yes

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

Example Request

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

Response Parameters

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

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

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

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

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

Request Parameters

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

Example Request

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

Response Parameters

Name Description Type Mandatory
totalCount 検索結果件数 Int Yes
pageNumber 検索結果ページの番号 Int No
pageSize 検索結果ページの件数 Int No
prePageNumber 検索結果ページの1ページ前のページ番号 Int No
nextPageNumber 検索結果ページの1ページ次のページ番号 Int No
firstPageNumber 検索結果ページの1ページ最初のページ番号 Int No
lastPageNumber 検索結果ページの1ページ最後のページ番号 Int No
lineContractId サービスの契約ID(N番) String No
agmUuid 借用回線UUID String No
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"
    }
  ]
}

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

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

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

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

Request Parameters

Name Description Type Mandatory
vpnGroupId VPN番号
VPN番号:'V'+8桁の数字
path variable Yes
contractId 契約ID(N番)
N番:'N'+9桁の数字
path variable Yes
plan 工事情報プラン
固定値:guarantee
query argument Yes
agmUuid 借用回線UUID query argument No

Example Request

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

Response Parameters

Name Description Type Mandatory
totalCount 検索結果件数 Int Yes
pageNumber 検索結果ページの番号 Int No
pageSize 検索結果ページの件数 Int No
prePageNumber 検索結果ページの1ページ前のページ番号 Int No
nextPageNumber 検索結果ページの1ページ次のページ番号 Int No
firstPageNumber 検索結果ページの1ページ最初のページ番号 Int No
lastPageNumber 検索結果ページの1ページ最後のページ番号 Int No
lastModifiedAc 最終更新日時
yyyy-MM-ddTHH:mm:ss.SSS+0900形式(JST時間)
String No
lineContractId サービスの契約ID(N番) String No
agmUuid 借用回線UUID String No
switchInfo1StartDay 回線情報-切替情報①開始年月日-時間
yyyy-MM-ddTHH:mm:ss.SSS+0900形式(JST時間)
String No
switchInfo1EndDay 回線情報-切替情報①終了年月日-時間
yyyy-MM-ddTHH:mm:ss.SSS+0900形式(JST時間)
String No
switchInfo1ImpactTime 回線情報-切替情報①時間 String No
switchInfo1TimeUnit 回線情報-切替情報①単位 String No
switchInfo2StartDay 回線情報-切替情報②開始年月日-時間
yyyy-MM-ddTHH:mm:ss.SSS+0900形式(JST時間)
String No
switchInfo2EndDay 回線情報-切替情報②終了年月日-時間
yyyy-MM-ddTHH:mm:ss.SSS+0900形式(JST時間)
String No
switchInfo2ImpactTime 回線情報-切替情報②時間 String No
switchInfo2TimeUnit 回線情報-切替情報②単位 String No
vpSwitchDateStartDay 回線情報-VP切替予定開始年月日-時間
yyyy-MM-ddTHH:mm:ss.SSS+0900形式(JST時間)
String No
vpSwitchDateEndDay 回線情報-VP切替予定終了年月日-時間
yyyy-MM-ddTHH:mm:ss.SSS+0900形式(JST時間)
String No
vpSwitchDateImpactTime 回線情報-VP切替予定時間 String No
vpSwitchDateTimeUnit 回線情報-VP切替予定単位 String No
vpCutBackDateStartDay 回線情報-VP切戻予定開始年月日-時間
yyyy-MM-ddTHH:mm:ss.SSS+0900形式(JST時間)
String No
vpCutBackDateEndDay 回線情報-VP切戻予定終了年月日-時間
yyyy-MM-ddTHH:mm:ss.SSS+0900形式(JST時間)
String No
vpCutBackDateImpactTime 回線情報-VP切戻予定時間 String No
vpCutBackDateTimeUnit 回線情報-VP切戻予定単位 String No

Example Result

{
  "totalCount": "1",
  "pageNumber": "1",
  "pageSize": "10",
  "prePageNumber": "1",
  "nextPageNumber": "1",
  "firstPageNumber": "1",
  "lastPageNumber": "1",
  "items": [
    {
      "lastModifiedAc": "2018-01-04T12:24:33.506+0900",
      "agmUuid": "5E23F123456789123456789123456789",
      "lineContractId": "N123456789",
      "switchInfo1StartDay": "2018-01-26T03:00:00.000+0900",
      "switchInfo1EndDay": "2018-01-26T05:00:00.000+0900",
      "switchInfo1ImpactTime": "3",
      "switchInfo1TimeUnit": "1",
      "switchInfo2StartDay": null,
      "switchInfo2EndDay": null,
      "switchInfo2ImpactTime": null,
      "switchInfo2TimeUnit": null,
      "vpSwitchDateStartDay": null,
      "vpSwitchDateEndDay": null,
      "vpSwitchDateImpactTime": null,
      "vpSwitchDateTimeUnit": null,
      "vpCutBackDateStartDay": null,
      "vpCutBackDateEndDay": null,
      "vpCutBackDateImpactTime": null,
      "vpCutBackDateTimeUnit": null
    }
  ]
}

 ■工事の開始日時・終了日時・影響時間の判定方法
 ・開始日時(※以下、上から判定)
  (1)VP切替開始日とVP切戻開始日のうち、値がある方を設定
  (2)VP切替開始日とVP切戻開始日のどちらも値がある場合、早い方を設定
  (3)工事情報①と工事情報②のうち、値がある方を設定
  (4)工事情報①と工事情報②のどちらも値がある場合、早い方を設定

 ・終了日時(※以下、上から判定)
  (1)VP切替終了日とVP切戻終了日のうち、値がある方を設定
  (2)VP切替終了日とVP切戻終了日のどちらも値がある場合、遅い方を設定
  (3)工事情報①と工事情報②のうち、値がある方を設定
  (4)工事情報①と工事情報②のどちらも値がある場合、遅い方を設定

 ・影響時間(※以下、上から判定)
  (1)VP切替の「方法,時間,単位,回数」があれば、それを設定
  (2)VP切戻の「方法,時間,単位,回数」があれば、それを設定
  (3)工事情報①の「方法,時間,単位,回数」があれば、それを設定
  (4)工事情報②の「方法,時間,単位,回数」があれば、それを設定

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

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

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

GET /v1/uno/maintenance?plan=besteffort&vpnGroupId={vpnGroupId}&contractid={contractid}&areacode={areacode}&goodscode={goodscode} 

Request Parameters

Name Description Type Mandatory
plan 工事情報プランを指定
固定値:besteffort
query argument Yes
vpnGroupId VPNグループID
VPNグループID:'V'+8桁の数字
query argument Yes
contractId サービスの契約ID(N番)を指定
N番:'N'+9桁の数字
query argument Yes
areaCode エリアコードを指定
エリアコード:3桁の数字
query argument Yes
goodsCode 商品コードを指定
固定値:vpn-besteffort
query argument Yes|     

     

エリアコード

地域コード 都道府県コード
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

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

Response Parameters

Name Description Type Mandatory
title 工事・故障タイトル String No
kind 工事・故障種別
1:工事 2:故障
Int No
kindDescription 工事・故障種別名 String No
code 工事・故障ID String No
displayUpdateDate 表示用更新年月日(JST)
yyyy-MM-ddTHH:mm+0900形式(JST時間)
String No
displayUpdateDateUtc 表示用更新年月日(UTC)
yyyy-MM-ddTHH:mmZ形式(UTC時間)
String No
maintenanceStatus 工事ステータス
1:工事前 2:工事中 3:完了
Int No
maintenanceStatusDescription 工事ステータス名 String No
troubleStatus 故障ステータス
1:故障中 2:復旧済み
Int No
troubleStatusDescription 故障ステータス名 String No
importantFlg 重要フラグ
0:通常(故障の場合0固定) 1:重要
Int No
importantDescription 重要名 String No
maintenanceStartDate 工事開始日時
yyyy-MM-ddTHH:mm+0900形式(JST時間)
String No
maintenanceEndDate 工事終了日時
yyyy-MM-ddTHH:mm+0900形式(JST時間)
String No
troubleOccuredDate 発生日時
yyyy-MM-ddTHH:mm+0900形式(JST時間)
String No
troubleRestoreDate 復旧日時
yyyy-MM-ddTHH:mm+0900形式(JST時間)
String No
maintenanceStartDateUtc 工事開始日時(UTC)
yyyy-MM-ddTHH:mmZ形式(UTC時間)
String No
maintenanceEndDateUtc 工事終了日時(UTC)
yyyy-MM-ddTHH:mmZ形式(UTC時間)
String No
troubleOccuredDateUtc 発生日時(UTC)
yyyy-MM-ddTHH:mmZ形式(UTC時間)
String No
troubleRestoreDateUtc 復旧日時(UTC)
yyyy-MM-ddTHH:mmZ形式(UTC時間)
String No
targetArea 工事対象エリアコード String No
mainTextPc PCサイト用本文 String No
influencedPlanDisplay 影響のあるサービス(画面表示用)
工事・故障登録時、実際画面表示される影響のあるサービス
String No
targetFacilityDisplay 影響のある設備(画面表示用)
工事・故障登録時、実際画面表示される影響のある設備
String No
targetAreaDisplay 工事対象エリア(画面表示用)
工事・故障登録時、実際画面表示されるエリア
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": "青森県エリアの全域"
    }
  ]
}

-以上-


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