Arcstar Universal One API

Table of Contents

概要
Resource URL
Resource Information　　
契約詳細情報取得
設備情報取得
トラフィック情報取得
トラフィックアラーム情報取得
トラフィックアラーム情報設定
トラフィックアラーム情報解除
トラフィックレポートお客様連絡事項情報取得
回線アラーム情報取得
ギャランティ工事情報更新一覧取得
ギャランティ工事詳細情報取得
ベストエフォート工事情報取得
回線監視停止情報取得
回線監視停止情報登録
回線監視停止情報更新
回線監視停止情報削除

概要

　■ Arcstar Universal One（国内回線）に関連し、下記のAPIを提供します。
　　・Arcstar Universal One 契約詳細情報取得API
　　・Arcstar Universal One 設備情報取得API
　　・Arcstar Universal One トラフィック情報取得API
　　・Arcstar Universal One トラフィックアラーム情報API
　　　‐　トラフィックアラーム情報取得API
　　　‐　トラフィックアラーム情報設定API
　　　‐　トラフィックアラーム情報解除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

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

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

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

　■ 工事・故障情報について
　　本APIの工事・故障情報はお客さまサポートサイトに掲載しております。
　　下記URLよりご確認ください。
　　Arcstar Universal One APIのサポート情報 | NTT Com お客さまサポート

Resource URL

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

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	番地等１番地情報１	String	No
1-6	banchi2	番地等２番地情報２	String	No
1-7	banchi3	番地等３番地情報３	String	No
1-8	building1	建物等１建物の情報１	String	No
1-9	building2	建物等２建物の情報２	String	No
1-10	building3	建物等３建物の情報３	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": "東京都千代田●●１丁目",
        "addressCode": "12345678901",
        "banchi1": "１番６号",
        "banchi2": "",
        "banchi3": "",
        "building1": "●●●日比谷ビル",
        "building2": "",
        "building3": "",
        "samakata": ""
    },{
        "addressType": "STB",
        "postalNumber": "1000011",
        "address": "東京都千代田区●●１丁目",
        "addressCode": "12345678901",
        "banchi1": "１番６号",
        "banchi2": "",
        "banchi3": "",
        "building1": "●●●日比谷ビル",
        "building2": "１Ｆ",
        "building3": "",
        "samakata": ""
    }],
    "productInfo": [
    {
        "productName": "Universal One",
        "productTypeName": "サービス",
        "productDetailInfo": []
    },{
        "productName": "Ｌ２",
        "productTypeName": "レイヤー",
        "productDetailInfo": []
    },{
        "productName": "ギャランティ",
        "productTypeName": "プラン",
        "productDetailInfo": []
    },{
        "productName": "メイン（主回線）",
        "productTypeName": "回線利用用途",
        "productDetailInfo": [
        {
            "itemNameProduct": "冗長化グループ番号",
            "detailItemValue": ""
        },{
            "itemNameProduct": "ＶＰＮ番号",
            "detailItemValue": "V12345678"
        }]
    },{
        "productName": "ギャランティアクセス",
        "productTypeName": "アクセス",
        "productDetailInfo": []
    },{
        "productName": "イーサタイプ（ＮＴＴＣｏｍ光アクセス）",
        "productTypeName": "タイプ",
        "productDetailInfo": []
    },{
        "productName": "Ｅｔｈｅｒ",
        "productTypeName": "イーサネット種別",
        "productDetailInfo": []
    },{
        "productName": "全二重",
        "productTypeName": "通信方式",
        "productDetailInfo": []
    },{
        "productName": "１０Ｍ",
        "productTypeName": "品目",
        "productDetailInfo": []
    },{
        "productName": "設置場所情報",
        "productTypeName": "部材",
        "productDetailInfo": [
        {
            "itemNameProduct": "設置場所事業所名",
            "detailItemValue": "●●●日比谷ビル"
        }]
    },{
        "productName": "Ｌ２　設置無",
        "productTypeName": "ＵＮＯ－Ｔ",
        "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	internetConnectExists	インターネットコネクト有無	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間アドレス情報：vUnoapiVconAddress を指定した場合]

No	Name	Description	Type	Mandatory
7	vUnoapiVconAddress	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	multicastExists	マルチキャスト有無	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	unoTerminalSpeed	UNO-T_LAN側インターフェース速度	String	No
12-12	asNumber	AS番号(WAN側)	String	No
12-13	maximumRoute	申込み上限経路数	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

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形式にて出力するAPIです。
　※当バージョンから下記も取得可能となりました。
　・Multi Cloud Connect、ベストエフォートハイグレード

トラフィック情報取得　

GET /v5/uno/traffic/{vpnGroupId}/{contractId}?dataType={dataType}&interval={interval}&from={from}&to={to}

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：国内回線使用率(%) throughput：スループット(bps)	String	Yes
interval	プロット間隔を指定 time：5分　day：日　day-max：日最大	String	Yes
from	表示開始日時を指定日時指定例：202108010000 #1#2#3#4	Date	Yes
to	表示終了日時を指定日時指定例：202108010000 #1#2#3#4	Date	Yes

　#1．JSTを指定
　#2．プロット間隔が「time」の場合以下のように指定
　　　1. YYYYMMDDhhmm形式であること
　　　2. mm は、5分粒度「00, 05, 10, 15 ,20, 25, 30, 35, 40, 45, 50 ,55」であること

　#3．プロット間隔が「day」の場合以下のように指定
　　　1. YYYYMMDDhhmm形式であること
　　　2. hhmmは、0時0分「0000」であること

　#4．プロット間隔が「day-max」の場合以下のように指定
　　　1. YYYYMMDDhhmm形式であること
　　　2. hhmmは、0時0分「0000」であること

Example Request

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

Response Parameters

No	Name	Description	Type	Mandatory
1	trafficDataValue	トラフィックデータ一覧	Array	Yes
1-1	intervalTime	収集日時	String	Yes
1-2	in	受信トラフィックデータ	String	Yes
1-3	out	送信トラフィックデータ	String	Yes

Example Result

{
　 "trafficdataValue":[
　　{
　　　 "intervaltime":"2020/12/01 00:00:00"
　　　,"in":"123456.9999999999"
　　　,"out":"123456.9999999999"
　　}
　　,{
　　　 "intervaltime":"2020/12/01 00:05:00"
　　　,"in":"123456.9999999999"
　　　,"out":"123456.9999999999"
　　}
　　,{
　　　 "intervaltime":"2020/12/01 00:10:00"
　　　,"in":"123456.9999999999"
　　　,"out":"123456.9999999999"
　　}
　　,{
　　　 "intervaltime":"2020/12/01 00:15:00"
　　　,"in":"123456.9999999999"
　　　,"out":"123456.9999999999"
　　}
　　,{
　　　 "intervaltime":"2020/12/01 00:20:00"
　　　,"in":"123456.9999999999"
　　　,"out":"123456.9999999999"
　　}
　　,{
　　　 "intervaltime":"2020/12/01 00:25:00"
　　　,"in":"123456.9999999999"
　　　,"out":"123456.9999999999"
　　}
　　,{
　　　 "intervaltime":"2020/12/01 00:30:00"
　　　,"in":"123456.9999999999"
　　　,"out":"123456.9999999999"
　　}
　]
}

トラフィックアラーム情報取得

　VPNグループID、契約ID(N番)、検索タイプを指定し、同一ネットワークグループの「契約回線」情報、または設定済みのトラフィックアラーム条件を取得するためのAPI、JSON形式にて出力するAPIです。

トラフィックアラーム情報取得

GET /v1/uno/alarm/{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 [query argument]

Name	Description	Type	Mandatory
searchType	検索タイプを指定 contractlist：契約回線情報を検索する場合に指定する　condition：設定済のトラフィックアラーム条件を検索する場合に指定する	String	No
searchAllOption	一括登録オプションを指定 0：個別　1：一括	Int	Yes #1

　#1．検索タイプが「condition」である場合のみ必須。

Example Request

Host: api.ntt.com  
GET /v1/uno/alarm/V12345678/N123456789?searchType=condition&searchAllOption=0 
HEADER Authorization: Bearer [YOUR_ACCESS_TOKEN]*
* トークンの取得についてはOAuth APIのページをご参照ください。

Response Parameters

No	Name	Description	Type	Mandatory
1	contractValue	契約回線一覧	Object	Yes
1-1	productName	トラレポ内サービス名	String	Yes
1-2	networkGroupId	回線グループ番号	String	Yes
1-3	contractList	契約回線対象リスト	Array	Yes
1-3-1	contractNo	契約回線番号	String	Yes
1-3-2	cityName	都市名	String	Yes
1-3-3	officeLocation	設置場所事業所名	String	Yes
1-3-4	manageFlag	管理回線フラグ	Int	Yes
1-3-5	conditionValue	アラーム条件情報	Object	Yes
1-3-5-1	allOption	一括登録オプション	Int	Yes
1-3-5-2	conditionItem1	閾値アイテム1 time_inbusyline：回線使用率(受信)　time_outbusyline：回線使用率(送信)	String	Yes
1-3-5-3	conditionEqualSign1	等符号1	String	Yes
1-3-5-4	conditionValue1	閾値1	Int	Yes
1-3-5-5	conditionForMinutes1	連続時間（分）1	Int	Yes
1-3-5-6	conditionItem2	閾値アイテム2 time_inbusyline：回線使用率(受信)　time_outbusyline：回線使用率(送信)	String	Yes
1-3-5-7	conditionEqualSign2	等符号2	String	Yes
1-3-5-8	conditionValue2	閾値2	Int	Yes
1-3-5-9	conditionForMinutes2	連続時間（分）2	Int	Yes
1-3-5-10	conditionItem3	閾値アイテム3 time_inbusyline：回線使用率(受信)　time_outbusyline：回線使用率(送信)	String	Yes
1-3-5-11	conditionEqualSign3	等符号3	String	Yes
1-3-5-12	conditionValue3	閾値3	Int	Yes
1-3-5-13	conditionForMinutes3	連続時間（分）3	Int	Yes
1-3-5-14	conditionItem4	閾値アイテム4 time_inbusyline：回線使用率(受信)　time_outbusyline：回線使用率(送信)	String	Yes
1-3-5-15	conditionEqualSign4	等符号4	String	Yes
1-3-5-16	conditionValue4	閾値4	Int	Yes
1-3-5-17	conditionForMinutes4	連続時間（分）4	Int	Yes
1-3-5-18	conditionUnion	閾値条件結合方式	String	Yes
1-3-5-19	mailAddress1	通知先メールアドレス1	String	Yes
1-3-5-20	mailStatus1	登録状態1 0：登録済み　1：未登録　2：確認待ち　3：メール送信失敗　4：ドメインエラー	Int	Yes
1-3-5-21	mailAddress2	通知先メールアドレス2	String	Yes
1-3-5-22	mailStatus2	登録状態2 0：登録済み　1：未登録　2：確認待ち　3：メール送信失敗　4：ドメインエラー	Int	Yes
1-3-5-23	mailAddress3	通知先メールアドレス3	String	Yes
1-3-5-24	mailStatus3	登録状態3 0：登録済み　1：未登録　2：確認待ち　3：メール送信失敗　4：ドメインエラー	Int	Yes
1-3-5-25	mailSubject	通知メール件名	String	Yes
1-3-5-26	language	言語設定	String	Yes
1-3-5-27	entryDate	登録日	Date	Yes
1-3-5-28	weekSettingList	曜日毎時刻設定情報	Array	Yes
1-3-5-28-1	wday	曜日 0:日　1:月　2:火　3:水　4:木　5:金　6:土	Int	Yes
1-3-5-28-2	startHH	開始時	Int	Yes
1-3-5-28-3	startMI	開始分	Int	Yes
1-3-5-28-4	endHH	終了時	Int	Yes
1-3-5-28-5	endMI	終了分	Int	Yes
1-3-5-28-6	status	設定有無ステータス	Int	Yes

Example Result

{
     "contractValue": {
         "productName": "UNO"
        ,"networkGroupId": "J12345678"
        ,"contractList": [
            {
                 "contractNo": "N111111111"
                ,"cityName": "北海道"
                ,"officeLocation": "札幌センター１"
                , "manageFlag":"1"
                ,"conditionValue": {
                     "allOption": "1"
                    ,"conditionItem1": "time_inbusyline"
                    ,"conditionEqualSign1": ">="
                    ,"conditionValue1": "20"
                    ,"conditionForMinutes1":"10"
                    ,"conditionItem2": "time_inbusyline"
                    ,"conditionEqualSign2": ">="
                    ,"conditionValue2": "30"
                    ,"conditionForMinutes2":"20"
                    ,"conditionItem3": "time_outbusyline"
                    ,"conditionEqualSign3": ">="
                    ,"conditionValue3": "40"
                    ,"conditionForMinutes3":"30"
                    ,"conditionItem4": "time_outbusyline"
                    ,"conditionEqualSign4": ">="
                    ,"conditionValue4": "50"
                    ,"conditionForMinutes4":"40"
                    ,"conditionUnion": "OR"
                    ,"mailAddress1": "mailadd1@ntt.com"
                    ,"mailStatus1": "0"
                    ,"mailAddress2": "mailadd2@ntt.com"
                    ,"mailStatus2": "1"
                    ,"mailAddress3": "mailadd3@ntt.com"
                    ,"mailStatus3": "2"
                    ,"mailSubject": "[Traffic Alarm]回線アラーム設定"
                    ,"language": "ja"
                    ,"entryDate": "2020-12-01 01:01:01"
                    ,"weekSettingList": [
                        {
                             "wday": "0"
                            ,"startHH": "00"
                            ,"startMI": "00"
                            ,"endHH": "24"
                            ,"endMI": "00"
                            ,"status": "1"
                        }
                        ,{
                             "wday": "1"
                            ,"startHH": "00"
                            ,"startMI": "00"
                            ,"endHH": "24"
                            ,"endMI": "00"
                            ,"status": "1"
                        }
                        ,{
                             "wday": "2"
                            ,"startHH": "00"
                            ,"startMI": "00"
                            ,"endHH": "24"
                            ,"endMI": "00"
                            ,"status": "1"
                        }
                        ,{
                             "wday": "3"
                            ,"startHH": "00"
                            ,"startMI": "00"
                            ,"endHH": "24"
                            ,"endMI": "00"
                            ,"status": "1"
                        }
                        ,{
                             "wday": "4"
                            ,"startHH": "00"
                            ,"startMI": "00"
                            ,"endHH": "24"
                            ,"endMI": "00"
                            ,"status": "1"
                        }
                        ,{
                             "wday": "5"
                            ,"startHH": "00"
                            ,"startMI": "00"
                            ,"endHH": "24"
                            ,"endMI": "00"
                            ,"status": "1"
                        }
                        ,{
                             "wday": "6"
                            ,"startHH": "00"
                            ,"startMI": "00"
                            ,"endHH": "24"
                            ,"endMI": "00"
                            ,"status": "1"
                        }
                    ]
                }
            }
        ]
    }
}

トラフィックアラーム情報設定

　VPNグループID、契約ID(N番)、アラーム情報設定値を指定し、アラーム条件の設定（登録・変更）を行うAPIです。

トラフィックアラーム情報設定

POST /v1/uno/alarm/{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
conditionValue	アラーム条件情報	Object	Yes
allOption	一括登録オプション "0"：個別登録　"1"：一括登録	Int	Yes
conditionItem1	閾値アイテム1 #1 time_inbusyline：回線使用率(受信)　time_outbusyline：回線使用率(送信)	String	Yes #1
conditionEqualSign1	等符号1 "<="　">="	String	Yes #1
conditionValue1	閾値1	Int	Yes #1
conditionForMinutes1	連続時間（分）1 #2 5～1440	Int	Yes #1
conditionItem2	閾値アイテム2 #1 time_inbusyline：回線使用率(受信)　time_outbusyline：回線使用率(送信)	String	Yes #3
conditionEqualSign2	等符号2 "<="　">="	String	Yes #3
conditionValue2	閾値2	Int	Yes #3
conditionForMinutes2	連続時間（分）2 #2 5～1440	Int	Yes #3
conditionItem3	閾値アイテム3 #1 time_inbusyline：回線使用率(受信)　time_outbusyline：回線使用率(送信)	String	Yes #4
conditionEqualSign3	等符号3 "<="　">="	String	Yes #4
conditionValue3	閾値3	Int	Yes #4
conditionForMinutes3	連続時間（分）3 #2 5～1440	Int	Yes #4
conditionItem4	閾値アイテム4 #1 time_inbusyline：回線使用率(受信)　time_outbusyline：回線使用率(送信)	String	Yes #5
conditionEqualSign4	等符号4 "<="　">="	String	Yes #5
conditionValue4	閾値4	Int	Yes #5
conditionForMinutes4	連続時間（分）1 #2 5～1440	Int	Yes #5
conditionUnion	閾値条件結合方式 "AND"　"OR"	String	Yes
mailAddress1	通知先メールアドレス1	String	Yes #6
mailAddress2	通知先メールアドレス2	String	Yes #6
mailAddress3	通知先メールアドレス3	String	Yes #6
mailSubject	通知メール件名	String	Yes
language	言語設定 "ja":日本語　"en":英語	String	Yes
weekSettingList	曜日毎時刻設定情報	Array	Yes
wday	曜日 0:日　1:月　2:火　3:水　4:木　5:金　6:土	Int	Yes
startHH	開始時 00～23 #7	Int	Yes
startMI	開始分 00～55 #7	Int	Yes
endHH	終了時 00～24 #7	Int	Yes
endMI	終了分 00～55 #7	Int	Yes
status	設定有無ステータス 0:未設定　1:設定済	Int	Yes

　#1．閾値アイテム1、等符号1、閾値1、連続時間（分）1のいずれかに値が設定されている場合必須。
　#2．指定可能な値について、下記表「連続時間に指定可能な値(分)」を参照。
　#3．閾値アイテム2、等符号2、閾値2、連続時間（分）2のいずれかに値が設定されている場合必須。
　#4．閾値アイテム3、等符号3、閾値3、連続時間（分）3のいずれかに値が設定されている場合必須。
　#5．閾値アイテム4、等符号4、閾値4、連続時間（分）4のいずれかに値が設定されている場合必須。
　#6．通知先メールアドレス1から通知先メールアドレス3で重複しない値であること。
　　　通知先メールアドレス1から通知先メールアドレス3のいずれかに必須。
　#7．連続時間判定は以下のように行う。
　　　1. 連続時間１～４の連続最大値(分数)を取得　※設定値未設定は除く
　　　2. 曜日毎の設定有無ステータスが「1：設定済」で設定されている曜日に対し以下のチェックを行う
　　　2.1. 終了時：終了分－開始時：開始分＝時間数(時)：時間数(分)
　　　2.2. 上記で算出した、「時間数(時)」：「時間数(分)」を分数に換算する　※以下、監視分数で記載
　　　2.3. 上記で算出した、監視分数の範囲内チェックを行い「連続最大値(分数)＞監視分数」の場合、エラーとする。

連続時間に指定可能な値(分)

値	内容
5	5分
10	10分
15	15分
20	20分
25	25分
30	30分
35	35分
40	40分
45	45分
50	50分
55	55分
60	1時間
120	2時間
180	3時間
240	4時間
300	5時間
360	6時間
420	7時間
480	8時間
540	9時間
600	10時間
660	11時間
720	12時間
780	13時間
840	14時間
900	15時間
960	16時間
1020	17時間
1080	18時間
1140	19時間
1200	20時間
1260	21時間
1320	22時間
1380	23時間
1440	24時間

Example Request

Content-Type: application/json; charset=utf-8
Host: api.ntt.com
POST /v1/uno/alarm/V12345678/N123456789     
{
　　"conditionValue": {
　　"contractNo": "N123456789",
　　"allOption": "1",
　　"conditionItem1": "time_inbusyline",
　　"conditionEqualSign1": ">=",
　　"conditionValue1": "20",
　　"conditionForMinutes1": "10",
　　"conditionItem2": "time_inbusyline",
　　"conditionEqualSign2": ">=",
　　"conditionValue2": "30",
　　"conditionForMinutes2": "20",
　　"conditionItem3": "time_outbusyline",
　　"conditionEqualSign3": ">=",
　　"conditionValue3": "40",
　　"conditionForMinutes3": "30",
　　"conditionItem4": "time_outbusyline",
　　"conditionEqualSign4": ">=",
　　"conditionValue4": "50",
　　"conditionForMinutes4": "40",
　　"conditionUnion": "OR",
　　"mailAddress1": "mailadd1@ntt.com",
　　"mailAddress2": "mailadd2@ntt.com",
　　"mailAddress3": "mailadd3@ntt.com",
　　"mailSubject": "[Traffic Alarm]回線アラーム設定",
　　"language": "ja",
　　"weekSettingList": [
　　　{
　　　　"wday": "0",
　　　　"startHH": "00",
　　　　"startMI": "00",
　　　　"endHH": "24",
　　　　"endMI": "00",
　　　　"status": "1"
　　　},
　　　{
　　　　"wday": "1",
　　　　"startHH": "00",
　　　　"startMI": "00",
　　　　"endHH": "24",
　　　　"endMI": "00",
　　　　"status": "1"
　　　},
　　　{
　　　　"wday": "2",
　　　　"startHH": "00",
　　　　"startMI": "00",
　　　　"endHH": "24",
　　　　"endMI": "00",
　　　　"status": "1"
　　　},
　　　{
　　　　"wday": "3",
　　　　"startHH": "00",
　　　　"startMI": "00",
　　　　"endHH": "24",
　　　　"endMI": "00",
　　　　"status": "1"
　　　},
　　　{
　　　　"wday": "4",
　　　　"startHH": "00",
　　　　"startMI": "00",
　　　　"endHH": "24",
　　　　"endMI": "00",
　　　　"status": "1"
　　　},
　　　{
　　　　"wday": "5",
　　　　"startHH": "00",
　　　　"startMI": "00",
　　　　"endHH": "24",
　　　　"endMI": "00",
　　　　"status": "1"
　　　},
　　　{
　　　　"wday": "6",
　　　　"startHH": "00",
　　　　"startMI": "00",
　　　　"endHH": "24",
　　　　"endMI": "00",
　　　　"status": "1"
　　　}
　　]
　}
}
HEADER Authorization: Bearer [YOUR_ACCESS_TOKEN]*
* トークンの取得についてはOAuth APIのページをご参照ください。

Response Parameters

No	Name	Description	Type	Mandatory
1	returnValue	処理結果	Object	Yes
1-1	contractNo	契約回線番号	String	Yes
1-2	allOption	一括登録オプション	Int	Yes
1-3	entry	契約状態	String	Yes

Example Result

{
　　"returnValue": {
　　　　"contractNo": "N123456789",
　　　　"allOption": "1",
　　　　"entry": "success"
　　}
}

トラフィックアラーム情報解除

　VPNグループID、契約ID(N番)、アラーム情報設定値を指定し、アラーム条件の設定（解除）を行うAPIです。

トラフィックアラーム情報解除

DELETE /v1/uno/alarm/{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 [query argument]

Name	Description	Type	Mandatory
deleteAllOption	一括登録オプションを指定 0：個別　1：一括	Int	Yes

Example Request

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

Response Parameters

No	Name	Description	Type	Mandatory
1	returnValue	処理結果	Object	Yes
1-1	deleteContractNo	契約回線番号	String	Yes
1-2	deleteAllOption	一括登録オプション	Int	Yes
1-3	delete	削除結果	String	Yes

Example Result

{
　　"returnValue": {
　　　　"deleteContractNo": "N123456789",
　　　　"deleteAllOption": "0",
　　　　"delete": "success"
　　}
}

トラフィックレポートお客様連絡事項情報取得

　UNOサービスのトラフィックレポートに関するお客様連絡事項を取得するAPIです。

トラフィックレポートお客様連絡事項情報取得

GET /v1/uno/announce/{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 /v1/uno/announce/V12345678/N123456789
HEADER Authorization: Bearer [YOUR_ACCESS_TOKEN]*
* トークンの取得についてはOAuth APIのページをご参照ください。

Response Parameters

No	Name	Description	Type	Mandatory
1	announceList	お客様連絡事項情報一覧	Array	Yes
1-1	startDate	連絡事項有効開始日	Date	Yes
1-2	endDate	連絡事項有効終了日	Date	Yes
1-3	title	連絡事項タイトル	String	Yes
1-4	contents	連絡事項内容	String	Yes
1-5	createDate	登録日	Date	Yes

Example Result

{
　"announceList": [
　　{
　　　"startDate":"2021-01-20",
　　　"endDate": "2021-02-28",
　　　"title":"メンテナンス工事のお知らせ",
　　　"contents":"2021年1月15日（金）09:00から14:00までの期間において、サーバのメンテナンスを実施いたします。<br />工事時間内に本サイトの閲覧ができない場合があります。<br />ご利用の方々にはご迷惑をおかけしますが、ご理解のほどよろしくお願い申し上げます。<br />",
　　　"createDate":"2021-01-18"
　　},
　　{
　　　"startDate":"2021-01-18",
　　　"endDate": "2021-02-28",
　　　"title":"メンテナンス工事のお知らせ",
　　　"contents":"2021年1月4日（月）09:00から14:00までの期間において、サーバのメンテナンスを実施いたします。<br />工事時間内に本サイトの閲覧ができない場合があります。<br />ご利用の方々にはご迷惑をおかけしますが、ご理解のほどよろしくお願い申し上げます。<br />",
　　　"createDate":"2021-01-18"
　　}
　]
}

回線アラーム情報取得

　　指定された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

-以上-

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

検索フォーム

現在地

概要

Resource URL

Resource Information

契約詳細情報取得

契約詳細情報取得

Request Parameters [path variable]

Example Request

Response Parameters

Example Result

設備情報取得

設備情報取得

Request Parameters [path variable]

Request Parameters [query argument]

Example Request

Response Parameters [共通]

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Example Result

トラフィック情報取得

トラフィック情報取得

Request Parameters [path variable]

Request Parameters [query argument]

Example Request

Response Parameters

Example Result

トラフィックアラーム情報取得

トラフィックアラーム情報取得

Request Parameters [path variable]

Request Parameters [query argument]

Example Request

Response Parameters

Example Result

トラフィックアラーム情報設定

トラフィックアラーム情報設定

Request Parameters [path variable]

Request Parameters [JSON]

連続時間に指定可能な値(分)

Example Request

Response Parameters

Example Result

トラフィックアラーム情報解除

トラフィックアラーム情報解除

Request Parameters [path variable]

Request Parameters [query argument]

Example Request

Response Parameters

Example Result

トラフィックレポートお客様連絡事項情報取得

トラフィックレポートお客様連絡事項情報取得

Request Parameters [path variable]

Example Request

Response Parameters

Example Result

回線アラーム情報取得

回線アラーム情報取得

Request Parameters [path variable]

Request Parameters [query argument]

Example Request

Response Parameters

Example Result

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

Resource Information　　

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

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

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

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

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

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

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

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

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

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

トラフィック情報取得　