Software-Defined Network Service API

Overview

Software-Defined Network Service (以下SD-NS)では、各種APIが利用可能です。

SD-NSは以下の機能を提供します。

  • お客様のクラウド環境、Arcstar Universal One拠点、Webサービス等への接続を簡単に実現できます。
  • 専用の端末を拠点に設置し、VPN回線/Internet回線を接続することにより回線をAct/Actで利用することを可能とし、回線を効率的に利用できます。
  • ポータルからの一元管理が可能な仮想ネットワークを構築・運用できます。

本APIはSD-NSの申し込み完了後にご利用可能です。
SD-NSサービスについては、サービス紹介サイト(Software-Defined Network Service)を参照ください。


提供API一覧

SD-NSでは、以下のAPIを提供します。

API Description Method
契約情報
基本契約申込 基本契約申込を行います POST
基本契約取得 基本契約の詳細情報を取得します GET
基本契約変更 基本契約の変更を行います PUT
基本契約廃止 基本契約廃止申込を行います DELETE
契約数取得 基本契約、GW、相互接続、端末、マネージドオプションの契約数を取得します GET
契約サマリ取得 GW、相互接続、端末の契約情報を一覧で取得します GET
GW
GW申込 GWの申込を行います POST
GW詳細取得 GWの詳細情報を取得します GET
GW設定変更 GWの設定を変更します PUT
GW一覧取得 GWの情報を一覧で取得します GET
GW廃止 GWの廃止申込を行います DELETE
端末
端末申込 端末の申込を行います POST
端末申込変更 端末の申込内容の変更を行います PUT
端末申込キャンセル 端末の申込をキャンセルします PUT
端末詳細取得 端末の詳細情報を取得します GET
端末事前設定 端末の設定を事前に行います PUT
端末アクティベーション 端末のアクティベーションを行います PUT
端末設定変更 端末の設定を変更します PUT
端末設定変更(Office365の経路更新) インターネットブレイクアウトにOffice365の経路を更新します PUT
端末設定変更(アプリケーション定義ファイル更新) 端末のアプリケーション定義ファイルを更新します PUT
端末一覧取得 端末の情報を一覧で取得します GET
端末廃止 端末の廃止申込を行います DELETE
端末廃止情報登録 端末廃止後に回収日や回収先の情報を登録します PUT
端末グループ作成 端末グループの作成を行います POST
端末グループ一覧取得 端末グループの情報を一覧で取得します GET
端末グループ設定変更 端末グループの設定を変更します PUT
端末グループ削除 端末グループを削除します DELETE
端末監視状態取得 端末の監視状態(監視中/非監視)を取得します GET
端末監視状態一覧取得 端末の監視状態(監視中/非監視)を一覧で取得します GET
端末監視状態切替 端末の監視状態(監視中/非監視)を切り替えます PUT
端末状態取得 端末の運用状態(運用中/故障中)を取得します GET
端末状態一覧取得 端末の運用状態(運用中/故障中)を一覧で取得します GET
端末状態詳細取得 端末の運用状態詳細を取得します GET
統計情報
Traffic取得(5分単位) 端末のTraffic情報(5分単位の平均値)を取得します GET
Traffic取得(1日単位) 端末のTraffic情報(1日単位の最小/最大/平均値)を取得します GET
Error取得(5分単位) 端末のError情報(5分単位の平均値)を取得します GET
Error取得(1日単位) 端末のError情報(1日単位の最小/最大/平均値)を取得します GET
アプリケーション取得(5分単位) 端末のアプリケーション情報(5分単位の平均値)を取得します GET
Traffic詳細取得 端末のTraffic情報を詳細条件を指定し取得します GET
アプリケーションリスト取得 利用可能なアプリケーションのリストを取得します GET
Trafficランキング取得 指定した条件でのTraffic量をランキングで取得します GET
端末リソース情報取得 端末のCPU使用率等の情報を取得します GET
遅延値詳細取得 遅延値詳細を取得します GET
通信品質取得 端末の遅延、ジッタ、パケロス値を取得します GET
マルチパス切替り情報取得 マルチパスの切替り情報を取得します GET
相互接続
相互接続申込 相互接続の申込を行います POST
相互接続詳細取得 相互接続の詳細情報を取得します GET
相互接続一覧取得 相互接続の情報を一覧で取得します GET
相互接続設定変更 相互接続の設定変更を行います PUT
相互接続廃止 相互接続の廃止申込を行います DELETE
マネージドオプション
マネージドオプション申込 マネージドオプションの申込を行います POST
マネージドオプション一覧取得 マネージドオプションの情報を一覧で取得します
※月額利用料発生分
GET
マネージドオプション廃止 マネージドオプション廃止申込を行います DELETE
オーダー情報
オーダー詳細取得 オーダーの詳細情報を取得します GET
オーダー一覧取得 オーダーの情報一覧を取得します GET

Resource URL

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

1.Base path(Global Load Balance)

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

2.Base path(Region)

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

Resource Information

Key Value
リクエストフォーマット JSON
レスポンス フォーマット JSON
認証(OAuth) Yes

基本契約申込

SD-NSの基本契約申込を行います。

POST /v1/sdns/contracts

Request Parameters

Name Description Type Mandatory Remarks
contractor 契約担当者 object yes
   zipCode 郵便番号 string yes
   address 住所 string yes
   buildingName 住所(ビル名等) string yes
   sectionName 部課名 string yes
   staffName 担当者様名 string yes
   contactTel 電話番号 string yes
   email メールアドレス string yes
salesChannelCode 販売チャネルコード string no
name 識別名 string yes
remarks 備考 string no
billingAddress 請求書送付先情報 object yes
   zipCode 郵便番号 string yes
   address 住所 string yes
   buildingName 住所(ビル名等) string yes
   corpName 会社名 string yes
   corpNameKana 会社名(全角フリガナ) string yes
   sectionName 部課名 string yes
   staffName 担当者名 string yes
   contactTel 電話番号 string yes
   email メールアドレス string yes
technicalContactPerson 技術担当者 object yes
   corpName 会社名 string yes
   corpNameKana 会社名(全角フリガナ) string yes
   sectionName 部課名 string yes
   staffName 担当者様名 string yes
   contactTel 電話番号 string yes
   email メールアドレス string yes
corpName 会社名 string yes

Example Request

POST /v1/sdns/contracts

{
    "contractor": {
        "zipCode": "9999999",
        "address": "東京都xxxxxx",
        "buildingName": "xxxxxxビル",
        "sectionName": "xxxxxx部",
        "staffName": "xxxxxx",
       "contactTel": "999-9999-9999",
        "email": "xxxxxx@xxx.xxx"
    },
    "salesChannelCode": "999xxxxxx",
    "name": "SD-NSxxxxxx",
    "remarks": "-",
    "billingAddress": {
        "zipCode": "9999999",
        "address": "東京都xxxxxx",
        "buildingName": "xxxxxxビル",
        "corpName": "xxxxxx株式会社", 
        "corpNameKana": "xxxxxxカブシキガイシャ",
        "sectionName": "xxxxxx部",
        "staffName": "xxxxxx",
        "contactTel": "999-9999-9999",
        "emaill": "xxxxxx@xxx.xxx"
    },
    "technicalContactPerson": {
        "corpName": "xxxxxx株式会社", 
        "corpNameKana": "xxxxxxカブシキガイシャ",
        "sectionName": "xxxxxx部",
        "staffName": "xxxxxx",
        "contactTel": "999-9999-9999",
        "emaill": "xxxxxx@xxx.xxx"
    }
    "corpName": "xxxxxx株式会社"   
 }

Response Code

Code Description
201 成功
400 parameterの型不正
404 指定されたID、もしくはIDの組合せが存在しない

Response Parameters

Name Description Type Mandatory Remarks
contractId サービス契約ID string yes 15桁の数字
orderId Order ID string yes 10桁の数字

Example Result

{
    "contractId":"999999999999999"
    "orderId": "9999999999"
}

基本契約取得

基本契約の詳細情報を取得するAPIです。

GET /v1/sdns/contracts/{contractId}

Request Parameters

Name Description Type Mandatory Remarks
contractId サービス契約ID string yes 15桁の数字

Example Request

GET /v1/sdns/contracts/999999999999999

Response Code

Code Description
200 成功
400 parameterの型不正
404 指定されたID、もしくはIDの組合せが存在しない

Response Parameters

Name Description Type Mandatory Remarks
customerId お客様番号 string yes C+10桁の数字
contractor 契約担当者 object yes
   sectionName 部課名 string yes
   staffName 担当者様名 string yes
   contactTel 電話番号 string yes
   email メールアドレス string yes
   zipCode 郵便番号 string yes
   address 住所 string yes
   buildingName 住所(ビル名等) string yes
name 識別名 string yes
salesChannelCode 販売チャネルコード string yes
remarks 備考 string yes
billingAddress 請求書送付先情報 object yes
   equalContractor 契約担当者と同じ boolean yes
   corpName 会社名 string yes
   corpNameKana 会社名(全角フリガナ) string yes
   sectionName 部課名 string yes
   staffName 担当者様名 string yes
   contactTel 電話番号 string yes
   email メールアドレス string yes
   zipCode 郵便番号 string yes
   address 住所 string yes
   buildingName 住所(ビル名等) string yes
technicalContactPerson 技術担当者 object yes
   equalContractor 契約担当者と同じ boolean yes
   corpName 会社名 string yes
   corpNameKana 会社名(全角フリガナ) string yes
   sectionName 部課名 string yes
   staffName 担当者名 string yes
   contactTel 電話番号 string yes
   email メールアドレス string yes
corpName 会社名 string yes

Example Result

{
    "customerId": "C9999999999", 
    "contractor": {
        "sectionName": "xxxxxx部", 
        "staffName": "xxxxxx", 
        "contactTel": "9999-999-9999", 
        "email": "xxxxxx@xxx.xxx", 
        "zipCode": "9999999",
        "address": "東京都xxxxxx", 
        "buildingName": "xxxxxxビル" 
    },
    "name": "SD-NSxxxxxx", 
    "salesChannelCode": "999999",
    "remarks": "memoxxxxxx", 
    "corpName": "xxxxxx株式会社", 
    "billingAddress": {
        "equalContractor": true, 
        "corpName": "xxxxxx株式会社", 
        "corpNameKana": "xxxxxxカブシキガイシャ", 
        "sectionName": "xxxxxx部", 
        "staffName": "xxxxxx", 
        "contactTel": "9999-999-999", 
        "email": "xxxxxx@xxx.xxx", 
        "zipCode": "9999999",
        "address": "東京都xxxxxx", 
        "buildingName": "xxxxxxビル"
    }, 
    "technicalContactPerson": {
        "equalContractor": true, 
        "corpName": "xxxxxx株式会社", 
        "corpNameKana": "xxxxxxカブシキガイシャ", 
        "sectionName": "xxxxxx部", 
        "staffName": "xxxxxx", 
        "contactTel": "9999-999-999",
        "email": "xxxxxx@xxx.xxx"
    }, 
}

基本契約変更

基本契約の変更を行います。

PUT /v1/sdns/contracts/{contractId}

Request Parameters

Name Description Type Mandatory Remarks
contractId サービス契約ID string yes 15桁の数字
Name Description Type Mandatory Remarks
contractor 契約担当者 object yes
   zipCode 郵便番号 string yes
   address 住所 string yes
   buildingName 住所(ビル名等) string yes
   sectionName 部課名 string yes
   staffName 担当者様名 string yes
   contactTel 電話番号 string yes
   email メールアドレス string yes
salesChannelCode 販売チャネルコード string no
name 識別名 string yes
remarks 備考 string no
billingAddress 請求書送付先情報 object yes
   equalContractor 契約担当者と同じ boolean yes #1 #2
   zipCode 郵便番号 string yes
   address 住所 string yes
   buildingName 住所(ビル名等) string yes
   corpName 会社名 string yes
   corpNameKana 会社名(全角フリガナ) string yes
   sectionName 部課名 string yes
   staffName 担当者様名 string yes
   contactTel 電話番号 string yes
   email メールアドレス string yes
technicalContactPerson 技術担当者 object yes
   equalContractor 契約担当者と同じ boolean yes #1 #2
   corpName 会社名 string yes
   corpNameKana 会社名(全角フリガナ) string yes
   sectionName 部課名 string yes
   staffName 担当者名 string yes
   contactTel 電話番号 string yes
   email メールアドレス string yes
corpName メールアドレス string no #1
  • #1 変更不可項目
  • #2 true/falseは申込時のequalContractorの値を応答しているため、申込時にfalseを選択し、手動でContractorと同じ情報を入力した場合もfalesを応答

Example Request

PUT /v1/sdns/contracts/99999999999999

{
    "contractor": {
        "zipCode": "9999999",
        "address": "東京都xxxxxx", 
        "buildingName": "xxxxxxビル" 
        "sectionName": "xxxxxx部", 
        "staffName": "xxxxxx", 
        "contactTel": "9999-999-9999", 
        "email": "xxxxxx@xxx.xxx", 
    },
    "name": "SD-NSxxxxxx", 
    "salesChannelCode": "999999",
    "remarks": "memoxxxxxx", 
    "billingAddress": {
        "equalContractor": true, 
        "corpName": "xxxxxx株式会社", 
        "corpNameKana": "xxxxxxカブシキガイシャ", 
        "sectionName": "xxxxxx部", 
        "staffName": "xxxxxx", 
        "contactTel": "9999-999-999", 
        "email": "xxxxxx@xxx.xxx", 
        "zipCode": "9999999",
        "address": "東京都xxxxxx", 
        "buildingName": "xxxxxxビル"
   },
    "technicalContactPerson": {
        "equalContractor": true, 
        "corpName": "xxxxxx株式会社", 
        "corpNameKana": "xxxxxxカブシキガイシャ", 
        "sectionName": "xxxxxx部", 
        "staffName": "xxxxxx", 
        "contactTel": "9999-999-999",
        "email": "xxxxxx@xxx.xxx"
    },
}

Response Code

Code Description
202 成功
400 parameterの型不正
404 指定されたID、もしくはIDの組合せが存在しない

Response Parameters

Name Description Type Mandatory Remarks
orderId Order ID string yes 10桁の数字

Example Result

{
  "orderId": "9999999999"
}

基本契約廃止

SD-NSの基本契約廃止申込を行います。

DELETE /v1/sdns/contracts/{contractId}

Request Parameters

Name Description Type Mandatory Remarks
contractId サービス契約ID string yes 15桁の数字

Example Request

DELETE /v1/sdns/contracts/999999999999999

Response Code

Code Description
202 成功
400 parameterの型不正
404 指定されたID、もしくはIDの組合せが存在しない

Response Parameters

Name Description Type Mandatory Remarks
orderId Order ID string yes 10桁の数字

Example Result

{
  "orderId": "9999999999"
}

契約数取得

基本契約、GW、相互接続、端末、マネージドオプションの契約数一覧を取得するAPIです。

GET /v1/sdns/contracts/{contractId}/counts

Request Parameters

Name Description Type Mandatory Remarks
contractId サービス契約ID string yes 15桁の数字

Example Request

GET /v1/sdns/contracts/999999999999999/counts

Response Code

Code Description
200 成功
400 parameterの型不正
404 指定されたID、もしくはIDの組合せが存在しない

Response Parameters

Name Description Type Mandatory Remarks
terminalCount 端末契約数 number yes
contractId 契約ID string yes 15桁の数字
gwCount GW契約数 number yes
interconnectionCount 相互接続契約数 number yes
managedOptionCount マネージドオプション契約数 number yes #1
  • #1 月額が発生中の契約数

Example Result

{
    "terminalCount": 10, 
    "contractId": "999999999999999", 
    "gwCount": 1, 
    "interconnectionCount": 1, 
    "managedOptionCount": 1
}

契約サマリ取得

GW、相互接続、端末の契約情報を一覧で取得します。

GET /v1/sdns/contracts/{contractId}/summary

Request Parameters

Name Description Type Mandatory Remarks
contractId サービス契約ID string yes 15桁の数字

Example Request

GET /v1/sdns/contracts/999999999999999/summary

Response Code

Code Description
200 成功
400 parameterの型不正
404 指定されたID、もしくはIDの組合せが存在しない

Response Parameters

相互接続
Name Description Type Mandatory Remarks
interconnections 契約している相互接続オプションの一覧 array yes
gwId 相互接続オプションに紐づくGWのID string no T+10桁の数字
name 識別名 string no
vpnNo VPN番号 string no V+8桁の数字
representativeNNo 代表N番 string no N+9桁の数字
multiCloudConnectNNo Multi-Cloud ConnectのN番 string no N+9桁の数字
orderStatus 相互接続のオーダー状況 string no #1
  • #1 Processing:変更中, Completed:完了, Error:エラー, Canceled:キャンセル
GW
Name Description Type Mandatory Remarks
gateways 契約しているGWの一覧 array yes
gwId GW ID string no T+10桁の数字
orderStatus GWのオーダー状況 string no #2
name 識別名 string no
  • #2 Processing:変更中, Completed:完了, Error;エラー, Canceled:キャンセル
端末
Name Description Type Mandatory Remarks
terminals 契約している端末の一覧 array yes
gwId 端末に紐づくGWのID string no T+10桁の数字
terminalId 端末ID string no D+10桁の数字 #3
status 端末の申込状況 string no #4
orderStatus 端末のオーダー状況 string no #5
installRequestedDate 配送希望日/オンサイト工事希望日 string no yyyy-mm-dd
secondaryTerminalId 端末ID(Secondary) string no D+10桁の数字 #6
name 識別名 string no
terminalType 端末種別 string no
terminalGroupId 端末グループID string no
address 住所 string no
buildingName 住所(ビル名等) string no
  • #3 端末冗長利用時はタグ名primaryTerminalIdで応答
  • #4 Processing:受付中, Kitting:キッティング中, Delivered;配送中, Activated:アクティベーション済み
  • #5 Processing:変更中, Completed:完了, Error;エラー, Canceled:キャンセル
  • #6 端末冗長利用時にのみ応答

Example Result

{
   "interconnections":[
      {
         "gwId":"T9999999991",
         "name":"SD-NS-NWxxxxxx",
         "vpnNo":"V99999999",
         "representativeNNo":"N999999999",
         "multiCloudConnectNNo":"N999999999",
         "orderStatus":"Processing"
      }
   ],
   "gateways":[
      {
         "gwId":"T9999999999",
         "orderStatus":"Completed",
         "name":"SD-NS-GWxxxxxx",
      }
   ],
   "terminals":[
      {
        "gwId":"T99999999999",
        "primaryTerminalId":"D9999999999",
        "status":"Delivered",
        "orderStatus":"Processing",
        "installRequestedDate":"2017-04-01",
        "secondaryTerminalId": "D9999999999",
        "name": "SD-NS-Terminalxxxxxx",
        "terminalType": "C4321",
        "terminalGroupId": "0000001601",
        "address": "東京都xxxxxx", 
        "buildingName": "xxxxxxビル"
      }
   ]
}

GW申込

GWの申込を行います

POST /v1/sdns/contracts/{contractId}/gateways

Request Parameters

Name Description Type Mandatory Remarks
contractId サービス契約ID string yes 15桁の数字
Name Description Type Mandatory Remarks
region リージョン string yes #1
bandwidth 帯域 string yes #2
gwManagementIpAddress GWマネジメント用アドレス object yes
   ipAddress IPアドレス string yes
   subnetMask サブネットマスク string yes #3
overlay1IpAddress オーバーレイアドレス1 object yes
   ipAddress IPアドレス string yes
   subnetMask サブネットマスク string yes #4
overlay2IpAddress オーバーレイアドレス2 object yes
   ipAddress IPアドレス string yes
   subnetMask サブネットマスク string yes #4
terminalManagementIpAddress 端末管理アドレス object yes
   ipAddress IPアドレス string yes
   subnetMask サブネットマスク string yes #4
vpnNo VPN番号 string yes V+8桁の数字
representativeNNo 代表N番号 string yes N+9桁の数字
name 識別名 string yes
remarks 備考 string no
  • #1 "JapanEast"を指定
  • #2 "100Mbps","1000Mbps"から選択
  • #3 サブネットマスクは22-24から指定
  • #4 サブネットマスクは22-25から指定

Example Request

POST /v1/sdns/contracts/12345678012345/gateways

{
    "region": "JapanEast", 
    "bandwidth": "100Mbps", 
    "gwManagementIpAddress": {
        "ipAddress": "99.99.99.99", 
        "subnetMask": "**"
    }, 
    "overlay1IpAddress": {
        "ipAddress": "99.99.99.99",
        "subnetMask": "**"
    }, 
    "overlay2IpAddress": {
        "ipAddress": "99.99.99.99",
        "subnetMask": "**"
    }, 
    "terminalManagementIpAddress": {
        "ipAddress": "99.99.99.99",
        "subnetMask": "**"
    }, 
    "vpnNo": "V99999999",
    "representativeNNo": "Nxxxxxxxx",
    "name": "SD-NSxxxxxx",
    "remarks": "-",
   }
}

Response Code

Code Description
201 成功
400 parameterの型不正
404 指定されたID、もしくはIDの組合せが存在しない

Response Parameters

Name Description Type Mandatory Remarks
gwId GW ID string yes T+10桁の数字
orderId Order ID string yes 10桁の数字

Example Result

{
    "gatewayId": "T9999999999"
    "orderId": "9999999999"
}

GW詳細取得

GWの詳細情報を取得するAPIです。

GET /v1/sdns/contracts/{contractId}/gateways/{gwId}

Request Parameters

Name Description Type Mandatory Remarks
contractId サービス契約ID string yes 15桁の数字
gwId 端末に紐づくGWのID string yes T+10桁の数字

Example Request

GET /v1/sdns/contracts/999999999999999/gateways/T9999999999

Response Code

Code Description
200 成功
400 parameterの型不正
404 指定されたID、もしくはIDの組合せが存在しない

Response Parameters

Name Description Type Mandatory Remarks
gwId GW契約ID string yes T+10桁の数字
region リージョン string yes
bandwidth 帯域 string yes
gwManagementIpAddress GWマネジメント用アドレス object yes
   ipAddress IPアドレス string yes
   subnetMask サブネットマスク string yes
overlay1IpAddress オーバーレイアドレス1 object yes
   ipAddress IPアドレス string yes
   subnetMask サブネットマスク string yes
overlay2IpAddress オーバーレイアドレス2 object yes
   ipAddress IPアドレス string yes
   subnetMask サブネットマスク string yes
terminalManagementIpAddress 端末管理アドレス object yes
   ipAddress IPアドレス string yes
   subnetMask サブネットマスク string yes
terminalConnectionNw1 端末接続ネットワーク(VPN) string yes
terminalConnectionNw2 端末接続ネットワーク(Internet) string yes
vpnNo VPN番号 string yes V+8桁の数字
representativeNNo 代表N番号 string yes N+9桁の数字
name 識別名 string yes
remarks 備考 string yes
orderStatus GWのオーダー状況 string yes #1
multipathControl マルチパス設定 array yes
   seqNo 優先順 string yes
   applicationName アプリケーション名 string yes
   name 識別名 string yes
   tos ToS値 string yes #2
   primaryPath 第一優先パス string yes
   secondaryPath 第二優先パス string yes
   policy ポリシー string yes
   loss パケットロス値 string yes
   latency 遅延値 string no
   jitter Jitter string no
tosSettings ToS設定 array yes
   tos ToS値 string yes #2
   settings 設定内容 array yes
      direction IN/OUT string no
      seqNo シーケンス番号 string no
      protocol プロトコル string no
      surceIpAddress 送信元IPアドレス string no
      surceSubnetMask 送信元サブネットマスク string no
      surcePort 送信元ポート番号 string no
      destinationIpAddress あて先IPアドレス string no
      destinationSubnetMask あて先サブネットマスク string no
      destinationPort あて先ポート番号 string no
      action Set/Except string no
  • #1 Processing:変更中, Completed:完了, Error:エラー, Canceled:キャンセル
  • #2 ToS値はdefault、0~7まで(6は除く)を応答

Example Result

{
    "gwId": "T9999999999", 
    "region": "JapanEast", 
    "bandwidth": "100Mbps", 
    "gwManagementIpAddress": {
        "ipAddress": "99.99.99.99", 
        "subnetMask": "99"
    }, 
    "overlay1IpAddress": {
        "ipAddress": "99.99.99.99",
        "subnetMask": "99"
    }, 
    "overlay2IpAddress": {
        "ipAddress": "99.99.99.99",
        "subnetMask": "99"
    }, 
    "terminalManagementIpAddress": {
        "ipAddress": "99.99.99.99",
        "subnetMask": "99"
    }, 
    "terminalConnectionNw1": "VPN",
    "terminalConnectionNw2": "INTERNET",
    "vpnNo": "V99999999",
    "representativeNNo": "N99999999",
    "name": "SD-NSxxxxxx",
    "remarks": "-",
    "orderStatus": "Processing",
   "multiPathControl": [
      {
        "seqNo": "2010",
        "applicationName": null,
        "name": "tos7",
        "tos":"7",
        "primaryPath": "VPN",
        "secondaryPath": "Internet",
        "policy": "custom",
        "loss": "1.25",
        "latency": "65535",
        "jitter": "100",
      },
   ],
    "tosSettings": [
        {
            "tos":"7",
            "settings": [
                {
                    "direction": "in",
                    "seqNo": "51",
                    "protocol": "tcp",
                    "sourceIpAddress": "99.99.99.99",
                    "sourceSubnetMask": "99",
                    "sourcePort": null,
                    "destinationIpAddress": "99.99.99.99",
                    "destinationSubnetMask": "99",
                    "destinationPort": "99",
                    "action": "Set"
                }
            ]
        },
        {
            "tos":"5",
            "settings": [
                {
                    "direction": "in",
                    "seqNo": "51",
                    "protocol": "tcp",
                    "sourceIpAddress": "99.99.99.99",
                    "sourceSubnetMask": "99",
                    "sourcePort": null,
                    "destinationIpAddress": "99.99.99.99",
                    "destinationSubnetMask": "99",
                    "destinationPort": "0",
                    "action": "Set"
                }
            ]
        },
        {
            "tos":"4",
            "settings": [
            ]
        },
        {
            "tos":"3",
            "settings": [
            ]
        },
        {
            "tos":"2",
            "settings": [
            ]
        },
        {
            "tos":"1",
            "settings": [
            ]
        },
        {
            "tos":"default",
            "settings": [
            ]
        }
    ]
}    

GW設定変更

GWの設定を変更するAPIです。

PUT /v1/sdns/contracts/{contractId}/gateways/{gwId}

Request Parameters

Name Description Type Mandatory Remarks
contractId サービス契約ID string yes 15桁の数字
gwId 端末に紐づくGWのID string yes T+10桁の数字
Name Description Type Mandatory Remarks
gwId GW契約ID string yes T+10桁の数字 #1
region リージョン string yes #1
bandwidth 帯域 string yes #1
gwManagementIpAddress GWマネジメント用アドレス object yes #1
   ipAddress IPアドレス string yes #1
   subnetMask サブネットマスク string yes #1
overlay1IpAddress オーバーレイアドレス1 object yes #1
   ipAddress IPアドレス string yes #1
   subnetMask サブネットマスク string yes #1
overlay2IpAddress オーバーレイアドレス2 object yes #1
   ipAddress IPアドレス string yes #1
   subnetMask サブネットマスク string yes #1
terminalManagementIpAddress 端末管理アドレス object yes #1
   ipAddress IPアドレス string yes #1
   subnetMask サブネットマスク string yes #1
terminalConnectionNw1 端末接続ネットワーク(VPN) string yes #1
terminalConnectionNw2 端末接続ネットワーク(Internet) string yes #1
vpnNo VPN番号 string yes V+8桁の数字 #1
representativeNNo 代表N番号 string yes N+9桁の数字 #1
name 識別名 string yes
remarks 備考 string yes
orderStatus GWのオーダー状況 string yes #1 #2
multipathControl マルチパス設定 array yes #14
   seqNo 優先順 string yes #3
   applicationName アプリケーション名 string yes #17
   name 識別名 string yes
   tos ToS値 string yes #1
   primaryPath 第一優先パス string yes #4
   secondaryPath 第二優先パス string yes #4
   policy ポリシー string yes #5
   loss パケットロス値 string yes #6
   latency 遅延値 string yes #7
   jitter Jitter string yes #8
tosSettings ToS設定 array yes #1 #14
   tos ToS値 string yes #1 #9
   settings 設定内容 array yes #10
      direction IN string yes #1
      seqNo シーケンス番号 string yes #11
      protocol プロトコル string yes #12
      surceIpAddress 送信元IPアドレス string yes #13
      surceSubnetMask 送信元サブネットマスク string yes #13
      surcePort 送信元ポート番号 string yes #13
      destinationIpAddress あて先IPアドレス string yes #13
      destinationSubnetMask あて先サブネットマスク string yes #13
      destinationPort あて先ポート番号 string yes #13
      action Set/Except string yes
  • #1 変更不可項目
  • #2 Processing:変更中, Completed:完了, Error:エラー, Canceled:キャンセル
  • #3 アプリケーションの優先度は、ToSより優先:1-2000で入力、ToSを優先:3001-5000で入力。ToS値の場合は、ToS7:2010、ToS5:2020、ToS4:2030、ToS3:2040、ToS2:2050、ToS1:2060、ToS0:2070を入力。合計60件までとする。
  • #4 "WAN1"または"WAN2"から指定
  • #5 default/Real-time-video/Voice/Best-effort/customより指定
  • #6 policyにて選択した値により、異なる。default:100、Real-time-video/Voice:1、Best-effort:10、custom:1.00-100.00(少数点2桁までの値を指定)
  • #7 policyにて選択した値により、異なる。default:指定なし、Real-time-video/Voice:150、Best-effort:500、custom:1-65535までで指定
  • #8 policyにて選択した値により、異なる。default:指定なし、Real-time-video/Voice:20、Best-effort:指定なし、custom:1-200までで指定
  • #9 ToS値はdefault,1~7(6は除く)を指定
  • #10 ToS毎に120個、ToS7個合計で840個を超える場合はエラーとする。
  • #11 1-9999で入力。すでに登録済み値と一致する場合はエラーとする。
  • #12 tcp/udp/ipから指定
  • #13 指定しない場合はanyを入力
  • #14 マルチパス設定とToS設定を同時に変更することは不可
  • #17 ToS値のマルチパス設定の場合は"null"

Example Request

PUT /v1/sdns/contracts/999999999999999/gateways/T9999999999

{
    "gwId": "T9999999999", 
    "region": "JapanEast", 
    "bandwidth": "100Mbps", 
    "gwManagementIpAddress": {
        "ipAddress": "99.99.99.99", 
        "subnetMask": "**"
    }, 
    "overlay1IpAddress": {
        "ipAddress": "99.99.99.99",
        "subnetMask": "**"
    }, 
    "overlay2IpAddress": {
        "ipAddress": "99.99.99.99",
        "subnetMask": "**"
    }, 
    "terminalManagementIpAddress": {
        "ipAddress": "99.99.99.99",
        "subnetMask": "**"
    }, 
    "terminalConnectionNw1": "VPN",
    "terminalConnectionNw2": "INTERNET",
    "vpnNo": "Vxxxxxx*",
    "representativeNNo": "Nxxxxxx**",
    "name": "SD-NSxxxxxx",
    "remarks": "-",
    "orderStatus": "Processing",

    "multiPathControl": [
      {
        "seqNo": "2010",
        "applicationName": null,
        "name": "tos7",
        "tos": "7",
        "primaryPath": "WAN1",
        "secondaryPath": "WAN2",
        "policy": "custom",
        "loss": "1.25",
        "latency": "65535",
        "jitter": "100",
      },
    ],
     "tosSettings": [
        {
            "tos":"7",
            "settings": [
                {
                    "direction": "in",
                    "seqNo": "51",
                    "protocol": "tcp",
                    "sourceIpAddress": "99.99.99.99",
                    "sourceSubnetMask": "**",
                    "sourcePort": null,
                    "destinationIpAddress": "99.99.99.99",
                    "destinationSubnetMask": "**",
                    "destinationPort": "**",
                    "action": "Set"
                }
            ]
        },
        {
            "tos":"5",
            "settings": [
                {
                    "direction": "in",
                    "seqNo": "51",
                    "protocol": "tcp",
                    "sourceIpAddress": "99.99.99.99",
                    "sourceSubnetMask": "**",
                    "sourcePort": null,
                    "destinationIpAddress": "99.99.99.99",
                    "destinationSubnetMask": "**",
                    "destinationPort": "0",
                    "action": "Set"
                }
            ]
        },
        {
            "tos":"4",
            "settings": [
            ]
        },
        {
            "tos":"3",
            "settings": [
            ]
        },
        {
            "tos":"2",
            "settings": [
            ]
        },
        {
            "tos":"1",
            "settings": [
            ]
        },
        {
            "tos":"default",
            "settings": [
            ]
        }
    ]
}    

Response Code

Code Description
202 成功
400 parameterの型不正
404 指定されたID、もしくはIDの組合せが存在しない

Response Parameters

Name Description Type Mandatory Remarks
orderId Order ID string yes 10桁の数字

Example Result

{
    "orderId": "9999999999"
}

GW一覧取得

GWの情報を一覧で取得するAPIです。

GET /v1/sdns/contracts/{contractId}/gateways

Request Parameters

Name Description Type Mandatory Remarks
contractId サービス契約ID string yes 15桁の数字

Example Request

GET /v1/sdns/contracts/999999999999999/gateways

Response Code

Code Description
200 成功
400 parameterの型不正
404 指定されたID、もしくはIDの組合せが存在しない

Response Parameters

Name Description Type Mandatory Remarks
gateways 契約中のGW一覧 array yes
   gwId GW契約ID string yes T+10桁の数字
   name 識別名 string yes
   region GW設置場所 string yes
   bandwidth 帯域 string yes
   terminalConnectionNw1 端末接続ネットワーク(VPN) string yes
   vpnNo VPN番号 string yes V+8桁の数字
   representativeNNo 代表N番号 string yes N+9桁の数字
   terminalConnectionNw2 端末接続ネットワーク(Internet) string yes
   remarks 備考 string yes
   orderStatus GWのオーダー状況 string yes #1
  • #1 Processing:変更中, Completed:完了, Error:エラー, Canceled:キャンセル

Example Result

{
    "gateways": [
        {
            "gwId": "T999999999", 
            "region": "JapanEast", 
            "bandwidth": "100Mbps", 
            "terminalConnectionNw1": "VPN", 
            "vpnNo": "V99999999",
            "representativeNNo": "N999999999", 
            "terminalConnectionNw2": "INTERNET", 
            "name": "SD-NS-GW*****", 
            "remarks": "-", 
            "orderStatus": "Completed", 
        }   
    ]
}

GW廃止

GWの廃止申込を行います。

DELETE /v1/sdns/contracts/{contractId}/gateways/{gwId}

Request Parameters

Name Description Type Mandatory Remarks
contractId サービス契約ID string yes 15桁の数字
gwId GW契約ID string yes T+10桁の数字

Example Request

DELETE /v1/sdns/contracts/999999999999999/gateways/T9999999999

Response Code

Code Description
202 成功
400 parameterの型不正
404 指定されたID、もしくはIDの組合せが存在しない

Response Parameters

Name Description Type Mandatory Remarks
orderId Order ID string yes 10桁の数字

Example Result

{
    "orderId": "9999999999"
}

端末申込

端末申込を行います。

POST /v1/sdns/contracts/{contractId}/gateways/{gwId}/terminals

Request Parameters

Name Description Type Mandatory Remarks
contractId サービス契約ID string yes 15桁の数字
gwId 契約中のGW ID string yes T+10桁の数字
基本情報
Name Description Type Mandatory Remarks
basicInformation 基本情報 object yes
   terminalType 端末種別 string yes #2
   terminalContractType 申込種別 string yes #3
   terminalConstructionType 工事方法 string yes #4
   installRequestedDate 端末設置希望日 string yes #5
   installRequestedTimeSlot 端末設置希望時間 string yes #6
   installRequestedTimeZone 端末設置希望時間のタイムゾーン string yes #7
   onSiteRepairOption オンサイト故障交換オプション(true/false) boolean yes
   rackMount ラックマウントキット(true/false) boolean yes #8
  • #2 "C4321","C891F","ASR1K"から選択
  • #3 申込種別は"Rental"か"Purchase"を指定。"Purchase"は弊社営業担当へ事前相談要
  • #4 "DIY"を指定
  • #5 "YYYY-mm-dd"にて指定
  • #6 "9:00","13:00","15:00","17:00"から選択
  • #7 "+9:00"を指定
  • #8 terminalTypeで"ASR1K","C4321"を選択した場合にのみ要否を記載。"C891F"を選択の場合は"false"
設置先情報
Name Description Type Mandatory Remarks
installationSite 設置先情報 object yes
   foreignFlag 海外配送有無(false) boolean yes #8
   country string yes #9
   zipCode 郵便番号 string yes
   address 住所 string yes
   buildingName 住所(ビル名等) string yes
   corpName 会社名 string yes
   corpNameKana 会社名(全角フリガナ) string yes
   sectionName 部課名 string yes
   staffName 担当者名 string yes
   contactTel 電話番号 string yes
   email メールアドレス string yes
  • #8 "false"を指定
  • #9 "Japan"を指定
端末配送先情報
Name Description Type Mandatory Remarks
shippingInformation 端末配送先 object yes
   foreignFlag 海外配送有無(false) boolean yes #8
   country string yes #9
   zipCode 郵便番号 string yes
   address 住所 string yes
   buildingName 住所(ビル名等) string yes
   corpName 会社名 string yes
   corpNameKana 会社名(全角フリガナ) string yes
   sectionName 部課名 string yes
   staffName 担当者名 string yes
   contactTel 電話番号 string yes
   email メールアドレス string yes
接続回線情報
Name Description Type Mandatory Remarks
wanConfigs 端末のWAN側インターフェイス設定 array yes
WAN1回線情報
   circuitTypeWan1 回線種別 string yes #10
   circuitServiceType 接続回線サービス種別 string yes #11
   circuitServiceName 接続回線サービス名 string yes
   circuitContractId 接続回線契約番号 string yes
   bandwidth 回線速度 string yes #12
   interfaceSpeed WAN IF (Speed) string yes #13
   interfaceDuplex WAN IF (Duplex) string yes #14
   ipAddress WAN IPアドレス(宅内側) string yes
   subnetMask WAN IPアドレス(宅内側)(サブネット) string yes
   routingSetting ルーティング設定 string yes #15
   defaultGw デフォルトゲートウェイ string yes #16
   perBgpAsNo AS番号(網側) string yes #17
   cerBgpAsNo AS番号(宅内側) string yes #17 #26
   perWanPortIpAddress WAN IPアドレス(網側) string yes #17
   pppoeId PPPoE ID string yes
   pppoePassword PPPoE Password string yes
   pppoeAuthenticationMethod PPPoE認証方式 string yes
WAN2回線情報
   circuitTypeWan2 回線種別 string yes #18
   circuitServiceType 接続回線サービス種別 string yes #11
   circuitServiceName 接続回線サービス名 string yes
   circuitContractId 接続回線契約番号 string yes
   bandwidth 回線速度 string yes #12
   interfaceSpeed WAN IF (Speed) string yes #19
   interfaceDuplex WAN IF (Duplex) string yes #14
   ipMethod WAN IP 方式 string yes #20
   ipAddress WAN IPアドレス string yes #21
   subnetMask WAN IPアドレス(サブネット) string yes #21
   defaultGw デフォルトゲートウェイ string yes #22
   pppoeId PPPoE ID string yes #23
   pppoePassword PPPoE Password string yes #23
   pppoeAuthenticationMethod PPPoE認証方式 string yes #24
   perBgpAsNo AS番号(網側) string yes #25
   cerBgpAsNo AS番号(宅内側) string yes #25 #26
   perWanPortIpAddress WAN IPアドレス(網側) string yes #25
  • #10 WAN側Internetシングル構成を利用の場合は"null"、それ以外の場合は"VPN"
  • #11 "ntt_japan","other_japan"から選択
  • #12 terminalType:C4321かASR1Kを選択の場合、1-9999から選択。terminalType:C891F指定の場合、1-1000から指定
  • #13 C4321かC891Fを選択の場合は"10","100","1000","auto"から指定、ASR1Kを選択の場合は"auto"を指定
  • #14 interfaceSpeed"auto"の場合は"auto"、interfaceSpeedが"auto"以外の場合は"full"を指定
  • #15 "Static","BGP"から指定。circuitServiceType"other_japan"は"Static"のみ指定
  • #16 routingSetting"Static"の場合に指定、"BGP"の場合は"null"
  • #17 routingSetting"BGP"の場合に指定、"Static"の場合は"null"
  • #18 "INTERNET","VPN"から選択
  • #19 C4321を選択の場合と、C891FをWAN側Internetシングル構成で利用の場合は"10","100","1000","auto"から選択、C891FをWAN側2回線構成で利用の場合は"10","100","auto"から選択、ASR1Kを選択の場合は"auto"を指定
  • #20 "circuitTypeWan2"で"INTERNET"を選択の場合"PPPoE","StaticIP"から選択、"VPN"を選択の場合"Static","BGP"から選択(circuitServiceType"other_japan"の場合は"Static"を指定)
  • #21 "circuitTypeWan2"で"StatucIp","Static","BGP"を選択の場合に指定、"PPPoE"の場合は"null"
  • #22 "circuitTypeWan2"で"StatucIp","Static"の場合に指定、"PPPoE","BGP"の場合は"null"
  • #23 "circuitTypeWan2"で"PPPoE"の場合に指定、"StatucIp","Static","BGP"の場合は"null"
  • #24 "circuitTypeWan2"で"PPPoE"の場合に"CHAP"を指定、"StatucIp","Static","BGP"の場合は"null"
  • #25 "circuitTypeWan2"で"BGP"を選択の場合1-65535から指定、"StatucIp","Static","PPPoE"の場合は"null"
  • #26 WAN側2回線ともにVPN回線の場合、同一のBGP番号を入力
その他
Name Description Type Mandatory Remarks
redundancyOption 端末冗長オプション有無(true/false) string yes #26
name 識別名 string yes #27
terminalGroupId 端末グループID string yes 10桁の数字
gwId GW ID string yes
remarks 備考 string no
interLinkIpAddress 端末冗長用IPアドレス string no #28
interLinkSubnetMask 端末冗長用IPアドレス string no #29
secondaryName 端末冗長時のセカンダリ端末識別名 string no #30
  • #26 terminalType"C891F"を選択の場合は"false"
  • #27 redundancyOption"true"の場合は"primaryName"として指定
  • #28 redundancyOption"true"の場合のみ指定
  • #29 redundancyOption"true"の場合のみ"29"で指定
  • #30 redundancyOption"true"の場合のみ指定

Example Request

POST /v1/sdns/contracts/999999999999999/gateways/T9999999999/terminals

{
    "name": "SD-NS_Terminal_xxxxxx*",
    "redundancyOption":false
    "basicInformation": {
        "terminalType": "C4321",
        "terminalContractType": "Purchase",
        "terminalConstructionType": "DIY",
        "installRequestedDate": "****-**-**",
        "installRequestedTimeSlot": "+09:00",
        "installRequestedTimeZone": "+09:00",
        "onSiteRepairOption": false,
        "rackMount": false, 
    },
    "installationSite": {
        "foreignFlag": true,
        "country":  "Japan",
        "zipCode": "9999999",
        "address": "東京都xxxxxx",
        "buildingName": "xxxxxxビル",
        "corpName": "xxxxxx株式会社",
        "corpNameKana": "xxxxxxカブシキガイシャ",
        "sectionName": "xxxxxx部",
        "staffName": "xxxxxx",
        "contactTel": "999-9999-9999",
        "email": "xxxxxx@xxx.xxx",
    },
    "shippingInformation": {
        "foreignFlag": true,
        "country": "Japan",
        "zipCode": "9999999",
        "address": "東京都*****",
        "buildingName": "xxxxxxビル",
        "corpName": "xxxxxx株式会社",
        "corpNameKana": "xxxxxxカブシキガイシャ",
        "sectionName": "xxxxxx部",
        "staffName": "xxxxxx",
        "contactTel": "999-9999-9999",
        "email": "xxxxxx@xxx.xxx"
    },
    "terminalGroupId": "9999999999",
    "gwId": "T9999999999",
    "remarks": "-",
    "wanConfigs": {
            "wan1LineType" : "VPN",
            "circuitServiceType": "ntt_japan",
            "circuitServiceName": "Arcster Universal One",
            "circuitContractId": "N999999999",
            "bandwidth": "100", 
            "interfaceSpeed": "auto", 
            "interfaceDuplex": "full",
            "ipAddress": "99.99.99.99",
            "subnetMask": "**", 
            "routingSetting": "Static", 
            "defaultGw": "99.99.99.99",
            "perBgpAsNo": null,
            "cerBgpAsNo": null,
            "perWanPortIpAddress": null
            "pppoeId": null, 
            "pppoePassword": null,
            "pppoeAuthenticationMethod": null
        },
        {
            "wan2LineType" : "Internet",
            "circuitServiceType": "ntt_japan",
            "circuitServiceName": "OCN",
            "circuitContractId": "99999999",
            "bandwidth": "100",
            "interfaceSpeed": "100",
            "interfaceDuplex": "full",
            "ipMethod": "StaticIP",
            "ipAddress": "99.99.99.99",
            "subnetMask": "**", 
            "defaultGw": "99.99.99.99",
            "pppoeId": null, 
            "pppoePassword": null,
            "pppoeAuthenticationMethod": null
   },
   ]
}

Response Code

Code Description
201 成功
400 parameterの型不正
404 指定されたID、もしくはIDの組合せが存在しない

Response Parameters

Name Description Type Mandatory Remarks
terminalId 端末ID string yes D+10桁の数字 #31
orderId Order ID string yes 10桁の数字
  • #31 redundancyOption"true"の場合は"primaryTerminalId","secondaryTerminalId"を応答

Example Result

{
    "terminalId":"D9999999999"
    "orderId":"9999999999"
}

端末申込変更

端末の申込内容の変更を行います。

PUT /v1/sdns/contracts/{contractId}/gateways/{gwId}/terminals/{terminalId}/revise

Request Parameters

Name Description Type Mandatory Remarks
contractId サービス契約ID string yes 15桁の数字
gwId GW契約ID string yes T+10桁の数字
terminalId 端末ID string yes D+10桁の数字
基本情報
Name Description Type Mandatory Remarks
basicInformation 基本情報 object yes
   terminalType 端末種別 string yes #1
   terminalContractType 申込種別 string yes
   terminalConstructionType 工事方法 string yes #1
   installRequestedDate 端末設置希望日 string yes
   installRequestedTimeSlot 端末設置希望時間 string yes
   installRequestedTimeZone 端末設置希望時間のタイムゾーン string yes #1
   onSiteRepairOption オンサイト故障交換オプション(true/false) boolean yes
   rackMount ラックマウントキット(true/false) boolean yes
  • #1 変更不可項目
設置先情報
Name Description Type Mandatory Remarks
installationSite 設置先情報 object yes
   foreignFlag 海外配送有無(false) boolean yes #1
   country string yes #1
   zipCode 郵便番号 string yes
   address 住所 string yes
   buildingName 住所(ビル名等) string yes
   corpName 会社名 string yes
   corpNameKana 会社名(全角フリガナ) string yes
   sectionName 部課名 string yes
   staffName 担当者名 string yes
   contactTel 電話番号 string yes
   email メールアドレス string yes
端末配送先情報
Name Description Type Mandatory Remarks
shippingInformation 端末配送先 object yes
   foreignFlag 海外配送有無(false) boolean yes #1
   country string yes #1
   zipCode 郵便番号 string yes
   address 住所 string yes
   buildingName 住所(ビル名等) string yes
   corpName 会社名 string yes
   corpNameKana 会社名(全角フリガナ) string yes
   sectionName 部課名 string yes
   staffName 担当者名 string yes
   contactTel 電話番号 string yes
   email メールアドレス string yes
接続回線情報
Name Description Type Mandatory Remarks
wanConfigs 端末のWAN側インターフェイス設定 array yes
WAN1回線情報
   circuitTypeWan1 回線種別 string yes #1
   circuitServiceType 接続回線サービス種別 string yes #1
   circuitServiceName 接続回線サービス名 string yes
   circuitContractId 接続回線契約番号 string yes
   bandwidth 回線速度 string yes
   interfaceSpeed WAN IF (Speed) string yes
   interfaceDuplex WAN IF (Duplex) string yes
   ipAddress WAN IPアドレス(宅内側) string yes
   subnetMask WAN IPアドレス(宅内側)(サブネット) string yes
   routingSetting ルーティング設定 string yes
   defaultGw デフォルトゲートウェイ string yes
   perBgpAsNo AS番号(網側) string yes
   cerBgpAsNo AS番号(宅内側) string yes
   perWanPortIpAddress WAN IPアドレス(網側) string yes
WAN2回線情報
   circuitTypeWan2 回線種別 string yes #1
   circuitServiceType 接続回線サービス種別 string yes #1
   circuitServiceName 接続回線サービス名 string yes
   circuitContractId 接続回線契約番号 string yes
   bandwidth 回線速度 string yes
   interfaceSpeed WAN IF (Speed) string yes
   interfaceDuplex WAN IF (Duplex) string yes
   ipMethod WAN IP 方式 string yes
   ipAddress WAN IPアドレス string yes
   subnetMask WAN IPアドレス(サブネット) string yes
   defaultGw デフォルトゲートウェイ string yes
   pppoeId PPPoE ID string yes
   pppoePassword PPPoE Password string yes
   pppoeAuthenticationMethod PPPoE認証方式 string yes
   perBgpAsNo AS番号(網側) string yes
   cerBgpAsNo AS番号(宅内側) string yes
   perWanPortIpAddress WAN IPアドレス(網側) string yes
WAN側インターフェイス設定(Secondary)
Name Description Type Mandatory Remarks
secondaryWanConfigs WAN側インターフェイス設定(Secondary) array yes
   perBgpAsNo AS番号(網側)(Secondary) string yes #1
   cerIpAddress WAN IPアドレス(宅内側)(Secondary) string yes #1
   cerSubnetMask WAN サブネットマスク(宅内側)(Secondary) string yes #1
   perIpAddress WAN IPアドレス(網側)(Secondary) string yes #1
   loopbackIpAddress Loopbackアドレス string yes #1
その他
Name Description Type Mandatory Remarks
redundancyOption 端末冗長オプション有無(true/false) boolean yes #1
name 識別名 string yes #2
terminalGroupId 端末グループID string yes 10桁の数字
gwId GW ID string yes T+10桁の数字 #1
remarks 備考 string yes
interLinkIpAddress 端末冗長用IPアドレス string yes
interLinkSubnetMask 端末冗長用IPアドレス string yes
secondaryName 端末冗長利用時のセカンダリ端末識別名 string yes
  • #2 redundancyOption"true"の場合はprimaryNameとする

Example Request

PUT /v1/sdns/contracts/{contractId}/gateways/{gatewayId}/terminals/{terminalId}/revise

    "name": "SD-NS_Terminal_xxxxxx",
    "redundancyOption":false
    "basicInformation": {
        "terminalType": "C4321",
        "terminalContractType": "Purchase",
        "terminalConstructionType": "DIY",
        "installRequestedDate": "****-**-**",
        "installRequestedTimeSlot": "+09:00",
        "installRequestedTimeZone": "+09:00",
        "onSiteRepairOption": false,
        "rackMount": false, 
    },
    "installationSite": {
        "foreignFlag": true,
        "country":  "Japan",
        "zipCode": "xxxxxx*",
        "address": "東京都xxxxxx",
        "buildingName": "xxxxxxビル",
        "corpName": "xxxxxx株式会社",
        "corpNameKana": "xxxxxxカブシキガイシャ",
        "sectionName": "xxxxxx部",
        "staffName": "xxxxxx",
        "contactTel": "999-9999-9999",
        "email": "xxxxxx@xxx.xxx",
    },
    "shippingInformation": {
        "foreignFlag": true,
        "country": "Japan",
        "zipCode": "9999999",
        "address": "東京都xxxxxx",
        "buildingName": "xxxxxxビル",
        "corpName": "xxxxxx株式会社",
        "corpNameKana": "xxxxxxカブシキガイシャ",
        "sectionName": "xxxxxx部",
        "staffName": "xxxxxx",
        "contactTel": "999-9999-9999",
        "email": "xxxxxx@xxx.xxx"
    },
    "terminalGroupId": "9999999999",
    "gwId": "T9999999999",
    "remarks": "-",
    "wanConfigs": [
            "wan1LineType" : "VPN",
            "circuitServiceType": "ntt_japan",
            "circuitServiceName": "Arcster Universal One",
            "circuitContractId": "N999999999",
            "bandwidth": "100", 
            "interfaceSpeed": "auto", 
            "interfaceDuplex": "full",
            "ipAddress": "99.99.99.99",
            "subnetMask": "**", 
            "routingSetting": "Static", 
            "defaultGw": "99.99.99.99",
            "perBgpAsNo": null,
            "cerBgpAsNo": null,
            "perWanPortIpAddress": null
            "pppoeId": null, 
            "pppoePassword": null,
            "pppoeAuthenticationMethod": null
        },
        {
            "wan2LineType" : "Internet",
            "circuitServiceType": "ntt_japan",
            "circuitServiceName": "OCN",
            "circuitContractId": "99999999",
            "bandwidth": "100",
            "interfaceSpeed": "100",
            "interfaceDuplex": "full",
            "ipMethod": "StaticIP",
            "ipAddress": "99.99.99.99",
            "subnetMask": "**", 
            "defaultGw": "99.99.99.99",
            "pppoeId": null, 
            "pppoePassword": null,
            "pppoeAuthenticationMethod": null
   },
       "secondaryWanConfigs": [
    {
        "perBgpAsNo": "****",
        "cerIpAddress": "99.99.99.99",
        "cerSubnetMask": "**",
        "perIpAddress": "99.99.99.99",
        "loopbackIpAddress": "99.99.99.99"
    }
    ]
   }
}

Response Code

Code Description
202 成功
400 parameterの型不正
404 指定されたID、もしくはIDの組合せが存在しない

Response Parameters

Name Description Type Mandatory Remarks
orderId Order ID string yes 10桁の数字

Example Result

{
  "orderId": "9999999999"
}

端末申込キャンセル

本APIにてSD-NS端末が配送されるまでの間であれば、申込をキャンセルすることができます。

PUT /v1/sdns/contracts/{contractId}/gateways/{gwId}/terminals/{terminalId}/cancel

Request Parameters

Name Description Type Mandatory Remarks
contractId サービス契約ID string yes 15桁の数字
gwId GW ID string yes T+10桁の数字
terminalId 端末ID string yes D+10桁の数字

Example Request

PUT /v1/sdns/contracts/999999999999999/gateways/{gwId}/terminals/D9999999999/cancel

Response Code

Code Description
202 成功
400 parameterの型不正
404 指定されたID、もしくはIDの組合せが存在しない

Response Parameters

Name Description Type Mandatory Remarks
orderId Order ID string yes 10桁の数字

Example Result

{
    "orderId": "9999999999"
}

端末詳細取得

端末の詳細情報を取得するAPIです。

GET /v1/sdns/contracts/{contractId}/gateways/{gwId}/terminals/{terminalId}

Request Parameters

Name Description Type Mandatory Remarks
contractId サービス契約ID string yes 15桁の数字
gwId 契約中のGW ID string yes T+10桁の数字
terminalId 端末ID string yes D+10桁の数字

Example Request

GET /v1/sdns/contracts/999999999999999/gateways/T9999999999/terminals/D9999999999

Response Code

Code Description
200 成功
400 parameterの型不正
404 指定されたID、もしくはIDの組合せが存在しない

Response Parameters

接続回線情報
Name Description Type Mandatory Remarks
wanConfigs 端末のWAN側インターフェイス設定 array yes
WAN1回線情報
   interface ポート番号 string yes
   circuitTypeWan1 接続回線種別 string yes
   circuitServiceType 接続回線サービス種別 string yes
   circuitServiceName 接続回線サービス名 string yes
   circuitContractId 接続回線契約番号 string yes
   bandwidth 回線速度 string yes
   interfaceSpeed WAN IF (Speed) string yes
   interfaceDuplex WAN IF (Duplex) string yes
   ipAddress WAN IPアドレス(宅内側) string yes
   subnetMask WAN IPアドレス(宅内側)(サブネット) string yes
   routingSetting ルーティング設定 string yes
   defaultGw デフォルトゲートウェイ string yes
   perBgpAsNo AS番号(網側) string yes
   cerBgpAsNo AS番号(宅内側) string yes
   perWanPortIpAddress WAN IPアドレス(網側) string yes
   pppoeId PPPoE ID string yes
   pppoePassword PPPoE Password string yes
   pppoeAuthenticationMethod PPPoE方式 string yes
WAN2回線情報
   interface ポート番号 string yes
   circuitTypeWan2 接続回線種別 string yes
   circuitServiceType 接続回線サービス種別 string yes
   circuitServiceName 接続回線サービス名 string yes
   circuitContractId 接続回線契約番号 string yes
   bandwidth 回線速度 string yes
   interfaceSpeed WAN IF (Speed) string yes
   interfaceDuplex WAN IF (Duplex) string yes
   ipMethod WAN IP 方式 string yes
   ipAddress WAN IPアドレス string yes
   subnetMask WAN IPアドレス(サブネット) string yes
   defaultGw デフォルトゲートウェイ string yes
   pppoeId PPPoE ID string yes
   pppoePassword PPPoE Password string yes
   pppoeAuthenticationMethod PPPoE方式 string yes
   perBgpAsNo AS番号(網側) string yes
   cerBgpAsNo AS番号(宅内側) string yes
   perWanPortIpAddress WAN IPアドレス(網側) string yes
LAN側ポート設定
Name Description Type Mandatory Remarks
lanPortSettings 端末のLAN側インターフェイス設定 array yes
   available true/false boolean yes
   name 識別名 string yes
   portVlanNo Untag VLAN番号 string yes
   tagVlanNo Tag VLAN番号 string yes
   vlanMode Tagged/Untagged string yes
   port ポート番号 string yes
VLANネットワークアドレス設定
Name Description Type Mandatory Remarks
vlanSettings VLANネットワーク設定 array yes
   ipAddress IPアドレス string no #1
   vlanId VLAN ID string no
   subnetMask サブネットマスク string no
   available true/false boolean no
   name 識別名 string no
   ipAddressPrimary IPアドレス(Primary) string no
   ipAddressSecondary IPアドレス(Secondary) string no
   portNo ポート番号 string no
   tagging Tagged/Untagged string no
  • #1 端末冗長利用時は"ipAddressVip"で応答
LAN側ルーティング設定(Static)
Name Description Type Mandatory Remarks
lanRoutingSettings LAN側ルーティング設定(Static) array yes
   name 識別名 string no
   ipAddress あて先NWアドレス string no
   subnetMask あて先NWアドレス(サブネット) string no
   gwIpAddress デフォルトGWIPアドレス string no
LAN側ルーティング設定(Dynamic)
Name Description Type Mandatory Remarks
lanRoutigSettingDynamic LAN側ルーティング設定(Dynamic) object yes
   ospfEnable true(有効)/false(無効) boolean yes
   ospf OSPF object yes
      ospfRouterId Router ID string no
      ospfType OSPF Type string no
      networktype Network Type string no
      processNumber Process Number string no
      areaNumber Ares Number string no
      authenticationType Authentication Type string no
      text Text string no #2
      keyId Key ID string no #3
      password Password string no #3
      ospfInterface OSPFを設定するインターフェイス array no
         port インターフェイス番号 string no
         vlan VLAN ID string no
      distributionRouteToNetwork 網側へ広告する経路 array yes
         name 識別名 string no
         ipAddress IP Address string no
         subnetMask Subnet Mask string no
  • #2 "authenticationType""text"を選択のみ表示
  • #3 "authenticationType""MD5"を選択のみ表示
DHCP
Name Description Type Mandatory Remarks
dhcp DHCP設定 object yes
   method Server/Relay/なし string yes
   server Server object yes
      exclusionRange 除外範囲 string yes #4
      defaultRouter デフォルトルーターアドレス string yes #4
      primaryDns プライマリDNSアドレス string yes #4
      secondaryDns セカンダリDNSアドレス string yes #4
      domain DHCPドメイン string yes #4
      ipAddress DHCP適用ネットワークアドレス(IPアドレス) string yes #4
      subnetMask DHCP適用ネットワークアドレス(サブネットマスク) string yes #4
      primaryWins プライマリWINSアドレス string yes #4
      secondaryWins セカンダリWINSアドレス string yes #4
   relay Relay object yes
      ipAddress1 DHCPサーバーアドレス1 string yes #5
      ipAddress2 DHCPサーバーアドレス2 string yes #5
      ipAddress2 DHCPサーバーアドレス3 string yes #5
      ipAddress2 DHCPサーバーアドレス4 string yes #5
  • #4 methodにて"Relay"を選択の場合はnull
  • #5 methodにて"Server"を選択の場合はnull
IPフィルタリング
Name Description Type Mandatory Remarks
ipFilterings IPフィルタリングの設定 array yes
   portName 対象インターフェイス名 string no
   targetInterface 対象インターフェイス string no #6
   settings 設定内容 array yes
      direction IN/OUT string no
      destinationIpAddress あて先IPアドレス string no
      destinationPortNo あて先ポート番号 string no
      destinationSubnetMask あて先サブネットマスク string no
      protocol プロトコル string no
      seqNo シーケンス番号 string no
      sourceIpAddress 送信元IPアドレス string no
      sourcePortNo 送信元ポート番号 string no
      sourceSubnetMask 送信元サブネットマスク string no
      action deny/permit string no
  • #6 IPフィルタリングを設定しているインターフェイス(WAN1、WAN2、VLAN ID)単位に応答
ToS設定
Name Description Type Mandatory Remarks
tosSettings TOS設定 array yes
   tos TOS値 string yes #7
   settings 設定内容 array yes
      direction IN/OUT string no
      seqNo シーケンス番号 string no
      protocol プロトコル string no
      sourceIpAddress 送信元IPアドレス string no
      sourceSubnetMask 送信元サブネットマスク string no
      sourcePort 送信元ポート番号 string no
      destinationIpAddress あて先IPアドレス string no
      destinationPortNo あて先ポート番号 string no
      destinationSubnetMask あて先サブネットマスク string no
      action deny/permit string no
  • #7 ToS値はdefault,1~7まで(6は除く)を応答
優先制御
Name Description Type Mandatory Remarks
qos 優先制御 string yes #8
  • #8 優先制御はなし(none)/4段階(4clsss)/6段階(6class)から、設定した値を応答
インターネットブレイクアウト
Name Description Type Mandatory Remarks
internetBreakout インターネットブレイクアウト設定 object yes
   enable true/fals boolean yes
   services サービスを指定してブレイクアウト array yes
      name サービス名称 string yes
      breakout true/false boolean yes
   applications アプリケーションを指定してブレイクアウト array yes
      name 識別名 string no
      applicationName アプリケーション名 string no
   specificIpAddress IPアドレスを指定してブレイクアウト array yes
      listId リストID string yes 端末ID+6桁の数字
      name 識別名 string no
      ipAddress あて先IPアドレス string no
      netmask あて先サブネットマスク string no
WAN側インターフェイス設定(Secondary)
Name Description Type Mandatory Remarks
secondaryWanConfigs WAN側インターフェイス設定(Secondary) array no #9
   perBgpAsNo AS番号(網側)(Secondary) string no
   cerIpAddress WAN IPアドレス(宅内側)(Secondary) string no
   cerSubNetmask WAN サブネットマスク(宅内側)(Secondary) string no
   perIpAddress WAN IPアドレス(網側)(Secondary) string no
   loopbackIpAddress Loopbackアドレス string no
  • #9 海外拠点利用の場合のみ、申込完了後に応答
工事情報
Name Description Type Mandatory Remarks
installationInformation 工事情報 object yes
   customerPresenceContactInformation 工事当日お客様立会者 連絡先 string yes
   customerPresenceCorpNameKana 工事当日お客様立会者 会社名フリガナ string yes
   howToEnter 工事当日 入館方法 string yes
   customerPresenceCorpName 工事当日お客様立会者 会社名 string yes
   installationCorpName 工事会社名 string yes
   workerContactInformation 作業員連絡先 string yes
   carInformation 車両情報 string yes
   date 確定工事日 string yes
   workerInformation 作業員情報 string yes
   customerPresenceSectionName 工事当日 お客様立会者 部課名 string yes
   time 確定工事時間 string yes
   customerPresenceName 工事当日 お客様立会者 氏名 string yes
   customerPresenceNameKana 工事当日 お客様立会者 氏名フリガナ string yes
端末配送先情報
Name Description Type Mandatory Remarks
shippingInformation 端末配送先 object yes
   address 住所 string yes
   buildingName 住所(ビル名) string yes
   email メールアドレス string yes
   contactTel 電話番号 string yes
   corpName 会社名 string yes
   corpNameKana 会社名(全角フリガナ) string yes
   country string yes
   equalInstallAddress 設置先住所と同じ boolean yes
   sectionName 部課名 string yes
   staffName 担当者名 string yes
   zipCode 郵便番号 string yes
   foreignFlag 海外配送 boolean yes
設置先情報
Name Description Type Mandatory Remarks
installationSite 設置先情報 object yes
   address 住所 string yes
   buildingName 住所(ビル名等) string yes
   email メールアドレス string yes
   contactTel 電話番号 string yes
   corpName 会社名 string yes
   corpNameKana 会社名(全角フリガナ) string yes
   country string yes
   sectionName 部課名 string yes
   staffName 担当者名 string yes
   zipCode 郵便番号 string yes
   foreignFlag 海外配送 boolean yes
基本情報
Name Description Type Mandatory Remarks
basicInformation 基本情報 object yes
   terminalContractType 申込種別 string yes
   terminalType 端末種別 string yes
   terminalConstructionType 工事方法 string yes
   installRequestedDate 端末設置希望日 string yes
   installRequestedTimeSlot 端末設置希望時間 string yes
   installRequestedTimeZone 端末設置希望時間のタイムゾーン string yes
   onSiteRepairOption オンサイト故障交換オプション boolean yes
      rackMount ラックマウントキット(true/false) boolean yes
   primary プライマリ端末 object no #10
      luggageTrackingNo 荷物追跡番号 string yes
      serialNo シリアルナンバー string yes
   secondary セカンダリ端末 object no #10
      luggageTrackingNo 荷物追跡番号 string no #10
      serialNo シリアルナンバー string no #10
  • #10 端末冗長利用時にのみ応答
端末の廃止情報
Name Description Type Mandatory Remarks
collectionRequestedDate 端末回収希望日 string no
collectionRequestedTimeSlot 端末回収希望時間 string no
collectionContactInformation 端末回収先情報 object no
   country string no
   foreignFlag 海外利用(true/false) boolean no
   zipCode 回収先郵便番号 string no
   address 回収先住所 string no
   buildingName ビル名 string no
   corpName 会社名 string no
   corpNameKana 会社名カナ string no
   sectionName 部署名 string no
   staffName 担当者名 string no
   contactTel 連絡先電話番号 string no
   email 連絡先メールアドレス string no
その他
Name Description Type Mandatory Remarks
terminalId 端末ID string yes D+10桁の数字 #12
secondaryTerminalId 端末ID(Secondary) string no D+10桁の数字 #11
gwId GW ID string yes T+10桁の数字
terminalGroupId 端末グループID string yes 10桁の数字
remarks 備考 string yes
name 識別名 string yes
secondaryName セカンダリ端末識別名 string yes
gwId GW ID string yes T+10桁の数字
orderStatus 端末のオーダー状況 string yes #13
status 端末の状態 string yes #14
secondaryStatus セカンダリ端末の状態 string yes #14
interLinkIpAddress 端末冗長用アドレス string no #11
interLinkSubnetMask 端末冗長用アドレス(サブネット) string no #11
preConfigureError 端末事前設定のエラー有無(true/false) boolean yes #15
  • #11 端末冗長利用時にのみ応答
  • #12 端末冗長利用時はタグ名を「primaryTerminalId」で応答
  • #13 Processing:変更中, Completed:完了, Error:エラー, Canceled:キャンセル
  • #14 Processing:変更中, Kitting:キッティング中, Deliverd:配送中, Activated:アクティベーション済み, WaitingSendBack,SendBack:端末廃止済み
  • #15 true:端末の事前設定を実施しActivationが未の状態, fals:事前設定を実施していないか、事前設定を反映済み

Example Result

{
    "wanConfigs": [
          {
            "interface": "ge0/0/0", 
            "circuitTypeWan1": "VPN", 
            "circuitServiceType": "ntt_japan", 
            "circuitServiceName": "Arcstar Universal One", 
            "circuitContractId": "N999999999", 
            "bandwidth": "100", 
            "interfaceSpeed": "auto", 
            "interfaceDuplex": "auto", 
            "perWanPortIpAddress": null
            "routingSetting": "Static", 
            "perBgpAsNo": "****",
            "cerBgpAsNo": "*****", 
            "defaultGw": "99.99.99.99", 
            "ipAddress": "99.99.99.99, 
            "subnetMask": "**", 
            "pppoeId": null, 
            "pppoePassword": null,
            "pppoeAuthenticationMethod": null
          }, 
          {
            "interface": "ge0/0/1", 
            "circuitType": "INTERNET", 
            "circuitServiceType": "ntt_japan", 
            "circuitServiceName": "OCN", 
            "circuitContractId": "N99999999",
            "bandwidth": "100", 
            "interfaceSpeed": "auto", 
            "interfaceDuplex": "auto", 
            "ipMethod": "StaticIP", 
            "ipAddress": "99.99.99.99", 
            "subnetMask": "**", 
            "defaultGw": "99.99.99.99", 
            "pppoeId": null, 
            "pppoePassword": null
        }
    ],
    "lanPortSettings": [
        {
            "available": false, 
            "name": "port0", 
            "portVlanNo": null, 
            "tagVlanNo": "1000,1100", 
            "vlanMode": "Tagged", 
            "port": "0"
        }
        {
            "available": true, 
            "name": "port1", 
            "portVlanNo": null, 
            "tagVlanNo": "11,20,30", 
            "vlanMode": "Tagged", 
            "port": "1"
        },
        {
            "available": true, 
            "name": "port2", 
            "portVlanNo": null, 
            "tagVlanNo": "11,20,30", 
            "vlanMode": "Tagged", 
            "port": "2"
        },
        {
            "available": true, 
            "name": "port3", 
            "portVlanNo": null, 
            "tagVlanNo": "11,20,30", 
            "vlanMode": "Tagged", 
            "port": "3"
        },
        {
            "available": true, 
            "name": "port4", 
            "portVlanNo": null, 
            "tagVlanNo": "11,20,30", 
            "vlanMode": "Tagged", 
            "port": "4"
        },
        {
            "available": true, 
            "name": "port5", 
            "portVlanNo": null, 
            "tagVlanNo": "11,20,30", 
            "vlanMode": "Tagged", 
            "port": "5"
        },
        {
            "available": true, 
            "name": "port6", 
            "portVlanNo": null, 
            "tagVlanNo": "11,20,30", 
            "vlanMode": "Tagged", 
            "port": "6"
        },
        {
            "available": true, 
            "name": "port7", 
            "portVlanNo": null, 
            "tagVlanNo": "11,20,30", 
            "vlanMode": "Tagged", 
            "port": "7"
        }
    ],
    "vlanSettings": [
        {
            "ipAddressVip": "99.99.99.99", 
            "vlanId": "10", 
            "subnetMask": "**", 
            "available": false, 
            "name": "VLAN_10"
            "ipAddressPrimary":"99.99.99.99",
            "ipAddressSecondary":"99.99.99.99"
        },
        {
            "ipAddressVip": "99.99.99.99", 
            "vlanId": "20", 
            "subnetMask": "**", 
            "available": true, 
            "managementName": "VLAN_15"
            "ipAddressPrimary":"99.99.99.99",
            "ipAddressSecondary":"99.99.99.99"
        }, 
        {
            "ipAddressVip": "99.99.99.99", 
            "vlanId": "30", 
            "subnetMask": "**", 
            "available": true, 
            "managementName": "VLAN_20"
            "ipAddressPrimary":"99.99.99.99",
            "ipAddressSecondary":"99.99.99.99"
        }
    ], 
    "lanRoutingSettings": [
        {
            "name": "Static2", 
            "ipAddress": "99.99.99.99", 
            "subnetMask": "**", 
            "gwIpAddress": "99.99.99.99"
        },
        {
            "name": "Static3", 
            "ipAddress": "99.99.99.99", 
            "subnetMask": "**", 
            "gwIpAddress": "99.99.99.99"
        },
        {
            "name": "Static4", 
            "ipAddress": "99.99.99.99", 
            "subnetMask": "**", 
            "gwIpAddress": "99.99.99.99"
        }
    ], 
    "dhcp": {
        "method": "Relay", 
        "server": { 
          "exclusionRange": null, 
          "defaultRouter": null, 
          "primaryDns": null, 
          "secondaryDns": null, 
          "domain": null, 
          "ipAddress": null, 
          "subnetMask": null, 
          "primaryWins": null, 
          "secondaryWins": null
    }, 
        "relay": { 
          "ipAddress1": "99.99.99.99",
          "ipAddress2": "99.99.99.99",
          "ipAddress3": "99.99.99.99",
          "ipAddress4": "99.99.99.99"
    }, 
    "ipFilterings": [
        {
            "targetInterface": "WAN1", 
            "settings": [
                {
                    "direction": "IN", 
                    "destinationIpAddress": "99.99.99.99", 
                    "destinationPortNo": "**", 
                    "destinationSubnetMask": "99.99.99.99", 
                    "protocol": "udp", 
                    "seqNo": "60", 
                    "sourceIpAddress": "99.99.99.99", 
                    "sourcePortNo": "**", 
                    "sourceSubnetMask": "99.99.99.99", 
                    "action": "deny"
                }
            ]
        },
        {
            "targetInterface": "WAN2", 
            "settings": [
                {
                    "packetDirection": "IN", 
                    "destinationIpAddress": "99.99.99.99", 
                    "destinationPortNo": "**", 
                    "destinationSubnetMask": "99.99.99.99", 
                    "destinationProtocol": "tcp", 
                    "seqNo": "80", 
                    "sourceIpAddress": "99.99.99.99", 
                    "sourcePortNo": "110", 
                    "sourceSubnetMask": "99.99.99.99", 
                    "action": "permit"
                }
            ]
        },
        {
            "targetInterface": "Vlan10", 
            "settings": [
                {
                    "packetDirection": "IN", 
                    "destinationIpAddress": "99.99.99.99", 
                    "destinationPortNo": null, 
                    "destinationSubnetMask": "99.99.99.99", 
                    "destinationProtocol": "tcp", 
                    "seqNo": "55", 
                    "sourceIpAddress": "99.99.99.99", 
                    "sourcePortNo": "80", 
                    "sourceSubnetMask": "99.99.99.99", 
                    "action": "deny"
                },
                {
                    "packetDirection": "IN", 
                    "destinationIpAddress": "99.99.99.99", 
                    "destinationPortNo": null, 
                    "destinationSubnetMask": "99.99.99.99", 
                    "destinationProtocol": "tcp", 
                    "seqNo": "65", 
                    "sourceIpAddress": "99.99.99.99", 
                    "sourcePortNo": null, 
                    "sourceSubnetMask": "99.99.99.99", 
                    "action": "deny"
                }
            ]
        }
    ], 
    "tosSettings": [
        {
            "tos":"7",
            "settings": [
                {
                    "direction": "IN",
                    "seqNo": "51",
                    "protocol": "tcp",
                    "sourceIpAddress": "99.99.99.99",
                    "sourceSubnetMask": "**",
                    "sourcePort": null,
                    "destinationIpAddress": "99.99.99.99",
                    "destinationSubnetMask": "**",
                    "destinationPort": "88",
                    "action": "permit"
                }
            ]
        },
        {
            "tos":"5",
            "settings": [
                {
                    "direction": "IN",
                    "seqNo": "51",
                    "protocol": "tcp",
                    "sourceIpAddress": "99.99.99.99",
                    "sourceSubnetMask": "**",
                    "sourcePort": null,
                    "destinationIpAddress": "99.99.99.99",
                    "destinationSubnetMask": "**",
                    "destinationPort": "88",
                    "action": "permit"
                }
            ]
        },
        {
            "tos":"4",
            "settings": []
        },
        {
            "tos":"3",
            "settings": []
        },
        {
            "tos":"2",
            "settings": []
        },
        {
            "tos":"1",
            "settings": []
        },
        {
            "tos":"default",
            "settings": []
        }
    ],
    "qos": "4class", 
    "internetBreakout": {
      "enable": true 
      "services": [
       {
        "serviceName":"office365",
        "breakout":true, 
       }
      ],
      "applications": [
      {
        "name": "app",
        "applicationName": "3pc"
      }
     ]
     "specificIpAddress": [
    {
      "listId" : "D9999999999_999999"
      "name":"****",
      "ipAddress":"99.99.99.99",
      "netmask":32,  
    }
  ]
}
    "secondaryWanConfigs": [
        {
            "perBgpAsNo": "****",
            "cerIpAddress": "99.99.99.99",
            "cerSubnetMask": "**",
            "perIpAddress": "99.99.99.99",
            "loopbackIpAddress": "99.99.99.99"
        }
    ],
  "installationInformation": {
    "customerPresenceContactInformation": "999-999-9999",
    "customerPresenceCorpName": "xxxxxx株式会社",
    "howToEnter": "memoxxxxxx",
    "customerPresenceCorpNameKana": "xxxxxxカブシキガイシャ",
    "installationCorpName": "株式会社xxxxxx",
    "workerContactInformation": "999-999-9999",
    "carInformation": "xxxxxx",
    "date": "2017-04-01",
    "workerInformation": "xxxxxx",
    "customerPresenceSectionName": "xxxxxx部"
    "time": "99:99",
    "customerPresenceName": "xxxxxx",
    "customerPresenceNameKana": "xxxxxx"
    },
  "secondaryTerminalId": "D9999999999",
  "gwId": "T9999999999",
  "primaryTerminalId": "D9999999999", 
  "remarks": "memoxxxxxx", 
  "name": "SD-NS-Txxxxxx**", 
  "secondaryName": "SD-NS-Txxxxxx", 
  "gwId": "T9999999999", 
  "orderStatus": "Completed", 
  "status": "Activated", 
  "secondaryStatus": "Activated", 
  "interLinkIpAddress":"99.99.99.99",
  "interLinkSubnetMask":"**",
  "terminalGroupId": "9999999999", 
  "preConfigureError":false,
  "shippingInformation": {
      "address": "東京都xxxxxx", 
      "buildingName": "xxxxxxビル", 
      "email": "xxxxxx@xxx.xxx", 
      "contactTel": "999-999-9999", 
      "corpName": "xxxxxx株式会社", 
      "corpNameKana": "xxxxxxカブシキガイシャ", 
      "country": "Japan", 
      "equalInstallAddress": true, 
      "sectionName": "xxxxxx部", 
      "staffName": "xxxxxx", 
      "zipCode": "9999999"
      "foreignFlag": false, 
  }, 
  "installationSite": {
      "address": "東京都xxxxxx", 
      "buildingName": "xxxxxxビル", 
      "email": "xxxxxx@xxx.xxx", 
      "contactTel": "9999-999-9999", 
      "corpName": "xxxxxx株式会社", 
      "corpNameKana": "xxxxxxカブシキガイシャ", 
      "country": "Japan", 
      "sectionName": "xxxxxx部", 
      "staffName": "xxxxxx", 
      "zipCode": "9999999"
      "foreignFlag": false, 
  }, 
  "basicInformation": {
      "terminalContractType": "Purchase", 
      "terminalType": "C4321", 
      "terminalConstructionType": "DIY",    
      "installRequestedDate": "2017-04-01", 
      "installRequestedTimeSlot": "9:99", 
      "installRequestedTimeZone": "+09:00", 
      "onSiteRepairOption": false, 
      "luggageTrackingNo": "xxxxxx-999999999", 
      "rackMount": "false", 
      "serialNo": "xxxxxx", 
  }
}

端末事前設定

端末の設定を事前に行います。

PUT /v1/sdns/contracts/{contractId}/gateways/{gwId}/terminals/{terminalId}/pre_settings

Request Parameters

Name Description Type Mandatory Remarks
contractId サービス契約ID string yes 15桁の数字
gwId 契約中のGW ID string yes T+10桁の数字
terminalId 端末ID string yes D+10桁の数字
基本情報
Name Description Type Mandatory Remarks
redundancyOption 端末冗長 boolean yes #1
basicInformation 基本情報 object yes
   terminalType 端末種別 string yes #1
  • #1 変更不可の項目
LAN側ポート設定
Name Description Type Mandatory Remarks
lanPortSettings 端末のLAN側インターフェイス設定 array yes
   available true/false boolean yes #13
   name 識別名 string yes
   portVlanNo Untag VLAN番号 string yes #14 #15
   tagVlanNo Tag VLAN番号 string yes #14 #16
   vlanMode Tagged/Untagged string yes #17
   port ポート番号 string yes #18
  • #13 ポートを有効化する場合は"true",無効かする場合は"false"を選択
  • #14 Vlanの総数はC4321は30個まで、C891は10個までとし、2-4094(1002-1005および、2350-2449除く)から指定
  • #15 Untagの場合、Vlan IDを2-4094から1個入力
  • #16 tagVlanの場合、Vlan IDを2-4094からカンマで区切り、最大10個入力可能
  • #17 "Tagged""Untagged"にて指定
  • #18 1-8にて指定、端末冗長利用の場合は1-7にて指定、ASR1Kの場合は3-6で指定、ASR1Kで端末冗長利用の場合は3-5で指定
VLANネットワークアドレス設定
Name Description Type Mandatory Remarks
vlanSettings VLANネットワーク設定 array yes
   ipAddress IPアドレス string no #19
   vlanId VLAN ID string no #14
   subnetMask サブネットマスク string no
   available true/false boolean no #20
   name 識別名 string no
   ipAddressPrimary IPアドレス(Primary) string no #21
   ipAddressSecondary IPアドレス(Secondary) string no #21
   portNo Port番号 string no #22
   tagging tagged/untagged string no #23
  • #19 端末冗長利用時は"ipAddressVip"を指定
  • #20 有効化する場合はtrue、無効化する場合はfals
  • #21 端末冗長利用時にのみ指定
  • #22 ASR1K利用の場合は2-5,ASR1K端末冗長利用時は3-5で指定、C4321,C891を利用の場合は"null"
  • #23 ASR1K利用の場合は"Tagged","Untagged"を指定、C4321,C891を利用の場合は"null"
LAN側ルーティング設定(Static)
Name Description Type Mandatory Remarks
lanRoutingSettings LAN側ルーティング設定(Static) array yes
   name 識別名 string no
   ipAddress あて先NWアドレス string no
   subnetMask あて先NWアドレス(サブネット) string no
   gwIpAddress デフォルトGWIPアドレス string no
LAN側ルーティング設定(Dynamic)
Name Description Type Mandatory Remarks
lanRoutingSettingDynamic LAN側ルーティング設定(Dynamic) object yes
   ospfEnable true/false boolean no #24
   ospf OSPF object no
      ospfRouterId OSPF Router ID string no
      ospfType OSPF Type string no #1
      networkType Network Type string no #1
      processNumber Process Number string no #1
      areaNumber Area Number string no #25
      authenticationType Authentication Type string no #26
      text text string no #27
      keyId Key ID string no #28
      password Password string no #28
      ospfInterface OSPFを適用するInterface array no
         port ポート番号 string no #29
         vlan VLAN ID string no #30
      distributionRouteToNetwork 網側へ広告する経路 array no
         name 識別名 string no
         ipAddress IP Address string no
         subnetmask Subnet Mask string no
  • #24 C891Fの場合、"fales"固定
  • #25 0-65535から指定
  • #26 "none","TEXT","MD5"から指定
  • #27 authenticationTypeで"TEXT"選択時にのみ指定、"none","MD5"を選択時は"null"
  • #28 authenticationTypeで"MD5"選択時にのみ指定、"none","TEXT"を選択時は"null"
  • #29 ASR1K利用時にのみ3-6から指定、ASR1K端末冗長利用時は3-5から指定、C4321利用時はnull
  • #30 VLAN IDを指定
DHCP
Name Description Type Mandatory Remarks
dhcp DHCP設定 object yes
   method Server/Relay/なし string yes #31
   server Server object yes
  &nbsp   exclusionRange 除外範囲 string yes #32
  &nbsp   defaultRouter デフォルトルーターアドレス string yes #32
  &nbsp   primaryDns プライマリDNSアドレス string yes #32
  &nbsp   secondaryDns セカンダリDNSアドレス string yes #32
  &nbsp   domain DHCPドメイン string yes #32
  &nbsp   ipAddress DHCP適用ネットワークアドレス(IPアドレス) string yes #32
  &nbsp   subnetMask DHCP適用ネットワークアドレス(サブネットマスク) string yes #32
  &nbsp   primaryWins プライマリWINSアドレス string yes #32
  &nbsp   secondaryWins セカンダリWINSアドレス string yes #32
   relay Relay object yes
      ipAddress1 DHCPサーバーアドレス1 string yes #33
      ipAddress2 DHCPサーバーアドレス2 string yes #33
      ipAddress2 DHCPサーバーアドレス3 string yes #33
      ipAddress2 DHCPサーバーアドレス4 string yes #33
  • #31 "Server""Relay""None"から指定
  • #32 "Relay""None"を指定の場合は"null"
  • #33 "Server""None"を指定の場合は"null"
IPフィルタリング
Name Description Type Mandatory Remarks
ipFilterings IPフィルタリングの設定 array yes
   portName 対象インターフェイス string no #34
   targetInterface 対象インターフェイス string no #35
   settings 設定内容 array no
      direction IN string no
      destinationIpAddress あて先IPアドレス string no #36
      destinationPortNo あて先ポート番号 string no #36
      destinationSubnetMask あて先サブネットマスク string no #36
      protocol プロトコル string no #37
      seqNo 優先順 string no #38
      sourceIpAddress 送信元IPアドレス string no #36
      sourcePortNo 送信元ポート番号 string no #36
      sourceSubnetMask 送信元サブネットマスク string no #36
      action deny/permit string no
  • #34 ASR1K利用時に2-5から指定、ASR1K端末冗長利用時は3-5にて指定、C4321,C891を利用時は"null"
  • #35 IPフィルタリングを設定するInterface、"WAN1""WAN2""VLANXX"(XXには作成済みのVLAN ID)より指定
  • #36 指定しない場合は"any"
  • #37 "tcp""udp""ip"から指定
  • #38 1-9999にて指定、設定箇Interface毎に60個までとする
ToS設定
Name Description Type Mandatory Remarks
tosSettings TOS設定 array yes
   tos TOS値 string yes #39
   settings 設定内容 array yes
      direction IN string no #1
      seqNo 優先順 string no #40
      protocol プロトコル string no #37
      sourceIpAddress 送信元IPアドレス string no #36
      sourceSubnetMask 送信元サブネットマスク string no #36
      sourcePort 送信元ポート番号 string no #36
      destinationIpAddress あて先IPアドレス string no #36
      destinationPortNo あて先ポート番号 string no #36
      destinationSubnetMask あて先サブネットマスク string no #36
      action deny/permit string no
  • #39 ToS値はdefault,1~7まで(6は除く)を応答
  • #40 1-9999にて指定、設定箇所毎に120個までとする
優先制御
Name Description Type Mandatory Remarks
qos 優先制御 string yes #41
  • #41 優先制御はなし(none)/4段階(4clsss)/6段階(6class)から、設定した値を応答。
インターネットブレイクアウト
Name Description Type Mandatory Remarks
internetBreakout インターネットブレイクアウト設定 object yes
   enable true/fals boolean yes
   services サービスを指定してブレイクアウト array yes
      serviceName サービス名称 string yes #1 #43
      breakout true/false string no
   applications アプリケーションを指定してブレイクアウト array no
      name 識別名 string no
      applicationName アプリケーション名 string no #44
   specificIpAddress IPアドレスを指定してブレイクアウト array yes
      listId リストID string no 端末ID+6桁の数字
      name 識別名 string no
      ipAddress あて先IPアドレス string no
      netmask あて先サブネットマスク string no
  • #43 "office365"固定
  • #44 既定のアプリケーションリストより指定、applicationNameはアプリケーションリスト取得APIにて取得

Example Request

PUT /v1/sdns/contracts/999999999999999/gateways/T9999999999/terminals/D9999999999/pre_settings

  "redundancyOption":false
  "basicInformation": {
      "terminalType": "C4321", 
    "lanPortSettings": [
        {
            "available": false, 
            "name": "port0", 
            "portVlanNo": null, 
            "tagVlanNo": "1000,1100", 
            "vlanMode": "Tagged", 
            "port": "0"
        }
        {
            "available": true, 
            "name": "port1", 
            "portVlanNo": null, 
            "tagVlanNo": "11,20,30", 
            "vlanMode": "Tagged", 
            "port": "1"
        },
        {
            "available": true, 
            "name": "port2", 
            "portVlanNo": null, 
            "tagVlanNo": "11,20,30", 
            "vlanMode": "Tagged", 
            "port": "2"
        },
        {
            "available": true, 
            "name": "port3", 
            "portVlanNo": null, 
            "tagVlanNo": "11,20,30", 
            "vlanMode": "Tagged", 
            "port": "3"
        },
        {
            "available": true, 
            "name": "port4", 
            "portVlanNo": null, 
            "tagVlanNo": "11,20,30", 
            "vlanMode": "Tagged", 
            "port": "4"
        },
        {
            "available": true, 
            "name": "port5", 
            "portVlanNo": null, 
            "tagVlanNo": "11,20,30", 
            "vlanMode": "Tagged", 
            "port": "5"
        },
        {
            "available": true, 
            "name": "port6", 
            "portVlanNo": null, 
            "tagVlanNo": "11,20,30", 
            "vlanMode": "Tagged", 
            "port": "6"
        },
        {
            "available": true, 
            "name": "port7", 
            "portVlanNo": null, 
            "tagVlanNo": "11,20,30", 
            "vlanMode": "Tagged", 
            "port": "7"
        }
    ],
    "vlanSettings": [
        {
            "ipAddressVip": "99.99.99.99", 
            "vlanId": "10", 
            "subnetMask": "**", 
            "available": false, 
            "name": "VLAN_10"
            "ipAddressPrimary":"99.99.99.99",
            "ipAddressSecondary":"99.99.99.99"
        },
        {
            "ipAddressVip": "99.99.99.99", 
            "vlanId": "20", 
            "subnetMask": "**", 
            "available": true, 
            "managementName": "VLAN_15"
            "ipAddressPrimary":"99.99.99.99",
            "ipAddressSecondary":"99.99.99.99"
        }, 
        {
            "ipAddressVip": "99.99.99.99", 
            "vlanId": "30", 
            "subnetMask": "**", 
            "available": true, 
            "managementName": "VLAN_20"
            "ipAddressPrimary":"99.99.99.99",
            "ipAddressSecondary":"99.99.99.99"
        }
    ], 
    "lanRoutingSettings": [
        {
            "name": "Static2", 
            "ipAddress": "99.99.99.99", 
            "subnetMask": "**", 
            "gwIpAddress": "99.99.99.99"
        },
        {
            "name": "Static3", 
            "ipAddress": "99.99.99.99", 
            "subnetMask": "**", 
            "gwIpAddress": "99.99.99.99"
        },
        {
            "name": "Static4", 
            "ipAddress": "99.99.99.99", 
            "subnetMask": "**", 
            "gwIpAddress": "99.99.99.99"
        }
    ], 
    "lanRoutigSettingDynamic" : {
     "ospfEnable" : true,
     "ospf" : {
       "ospfRouterId" : "99.99.99.99,
       "primaryOspfRouterId" : "99.99.99.99",
       "secondaryOspfRouterId" : "99.99.99.99",
       "ospfType" : "Normal area",
       "networkType" : "Broadcast",
       "processNumber" : "1",
       "areaNumber" : "1",
       "authenticationType" : "TEXT",
       "text" : "cisco1111",
       "keyId" : null,
       "ospfInterface" : [
           {
              "name""port" : "1",
              "vlan" : "vlan999",
         ],
        "distributionRouteToNetwork" : [
            {
              "name" : "OSPF1",
              "ipAddress" : "99.99.99.99",
              "subnetmask" : "**"
            },
            {
              "name" : "OSPF2",
              "ipAddress" : "99.99.99.99",
              "subnetmask" : "**"
            }
            ]
         }
      },
    "dhcp": {
        "method": "Relay", 
        "server": { 
          "exclusionRange": null, 
          "defaultRouter": null, 
          "primaryDns": null, 
          "secondaryDns": null, 
          "domain": null, 
          "ipAddress": null, 
          "subnetMask": null, 
          "primaryWins": null, 
          "secondaryWins": null
    }, 
        "relay": { 
          "ipAddress1": "99.99.99.99",
          "ipAddress2": "99.99.99.99",
          "ipAddress3": "99.99.99.99",
          "ipAddress4": "99.99.99.99"
    }, 
    "ipFilterings": [
        {
            "targetInterface": "WAN1", 
            "settings": [
                {
                    "direction": "IN", 
                    "destinationIpAddress": "99.99.99.99", 
                    "destinationPortNo": "**", 
                    "destinationSubnetMask": "99.99.99.99", 
                    "protocol": "udp", 
                    "seqNo": "60", 
                    "sourceIpAddress": "99.99.99.99", 
                    "sourcePortNo": "**", 
                    "sourceSubnetMask": "99.99.99.99", 
                    "action": "deny"
                }
            ]
        },
        {
            "targetInterface": "WAN1", 
            "settings": [
                {
                    "packetDirection": "IN", 
                    "destinationIpAddress": "99.99.99.99", 
                    "destinationPortNo": "**", 
                    "destinationSubnetMask": "99.99.99.99", 
                    "destinationProtocol": "tcp", 
                    "seqNo": "80", 
                    "sourceIpAddress": "99.99.99.99", 
                    "sourcePortNo": "110", 
                    "sourceSubnetMask": "99.99.99.99", 
                    "action": "permit"
                }
            ]
        },
        {
            "targetInterface": "Vlan10", 
            "settings": [
                {
                    "packetDirection": "IN", 
                    "destinationIpAddress": "99.99.99.99", 
                    "destinationPortNo": null, 
                    "destinationSubnetMask": "99.99.99.99", 
                    "destinationProtocol": "tcp", 
                    "seqNo": "55", 
                    "sourceIpAddress": "99.99.99.99", 
                    "sourcePortNo": "80", 
                    "sourceSubnetMask": "99.99.99.99", 
                    "action": "deny"
                },
                {
                    "packetDirection": "IN", 
                    "destinationIpAddress": "99.99.99.99", 
                    "destinationPortNo": null, 
                    "destinationSubnetMask": "99.99.99.99", 
                    "destinationProtocol": "tcp", 
                    "seqNo": "65", 
                    "sourceIpAddress": "99.99.99.99", 
                    "sourcePortNo": null, 
                    "sourceSubnetMask": "99.99.99.99", 
                    "action": "deny"
                }
            ]
        }
    ], 
    "tosSettings": [
        {
            "tos":"7",
            "settings": [
                {
                    "direction": "IN",
                    "seqNo": "51",
                    "protocol": "tcp",
                    "sourceIpAddress": "99.99.99.99",
                    "sourceSubnetMask": "**",
                    "sourcePort": null,
                    "destinationIpAddress": "99.99.99.99",
                    "destinationSubnetMask": "**",
                    "destinationPort": "88",
                    "action": "permit"
                }
            ]
        },
        {
            "tos":"5",
            "settings": [
                {
                    "direction": "IN",
                    "seqNo": "51",
                    "protocol": "tcp",
                    "sourceIpAddress": "99.99.99.99",
                    "sourceSubnetMask": "**",
                    "sourcePort": null,
                    "destinationIpAddress": "99.99.99.99",
                    "destinationSubnetMask": "**",
                    "destinationPort": "88",
                    "action": "permit"
                }
            ]
        },
        {
            "tos":"4",
            "settings": []
        },
        {
            "tos":"3",
            "settings": []
        },
        {
            "tos":"2",
            "settings": []
        },
        {
            "tos":"1",
            "settings": []
        },
        {
            "tos":"default",
            "settings": []
        }
    ],
    "qos": "4class", 
    "internetBreakout": {
      "enable": true 
      "services": [
       {
        "serviceName":"office365",
        "breakout":true, 
       }
      ],
      "applications": [
      {
        "name": "app",
        "applicationName": "3pc"
      }
     ]
     "specificIpAddress": [
    {
      "listId" : "D9999999999_999999"
      "name":"****",
      "ipAddress":"99.99.99.99",
      "netmask":32,  
    }
  ]
}

Response Code

Code Description
202 成功
400 parameterの型不正
404 指定されたID、もしくはIDの組合せが存在しない

Response Parameters

Name Description Type Mandatory Remarks
orderId Order ID string yes 10桁の数字

Example Result

{
    "orderId": "9999999999"
}

端末アクティベーション

SD-NS端末のアクティベーションを行います。

PUT /v1/sdns/contracts/{contractId}/gateways/{gwId}/terminals/{terminalId}/activation

Request Parameters

Name Description Type Mandatory Remarks
contractId サービス契約ID string yes 15桁の数字
gwId GW契約ID string yes T+10桁の数字
terminalId 端末ID string yes D+10桁の数字

Example Request

PUT /v1/sdns/contracts/999999999999999/gateways/T999999999/terminals/D999999999/activation

{
}

Response Code

Code Description
202 成功
400 parameterの型不正
404 指定されたID、もしくはIDの組合せが存在しない

Response Parameters

Name Description Type Mandatory Remarks
orderId Order ID string yes 10桁の数字

Example Result

{
    "orderId": "9999999999"
}

端末設定変更

端末の設定を変更するAPIです。

PUT /v1/sdns/contracts/{contractId}/gateways/{gwId}/terminals/{terminalId}

Request Parameters

Name Description Type Mandatory Remarks
contractId サービス契約ID string yes 15桁の数字
gwId 契約中のGW ID string yes T+10桁の数字
terminalId 端末ID string yes D+10桁の数字

※下記項目を同時に設定変更することはできません。設定の変更は項目単位に実施してください。

接続回線情報
Name Description Type Mandatory Remarks
wanConfigs 端末のWAN側インターフェイス設定 array yes
WAN1回線情報
   circuitTypeWan1 接続種別 string yes #1
   circuitServiceType 接続回線サービス種別 string yes #1
   circuitServiceName 接続回線サービス名 string yes
   circuitContractId 接続回線契約番号 string yes
   bandwidth 回線速度 string yes #2
   interfaceSpeed WAN IF (Speed) string yes #3
   interfaceDuplex WAN IF (Duplex) string yes #4
   ipAddress WAN IPアドレス(宅内側) string yes #1
   subnetMask WAN IPアドレス(宅内側)(サブネット) string yes #1
   routingSetting ルーティング設定 string yes #1
   perWanPortIpAddress WAN IPアドレス(網側) string yes #1 \
   perBgpAsNo AS番号(網側) string yes #1
   cerBgpAsNo AS番号(宅内側) string yes #1
   defaultGw デフォルトゲートウェイ string yes #1
   pppoeId PPPoE ID string yes #1
   pppoePassword PPPoE Password string yes #1
   pppoeAuthenticationMethod PPPoE認証方式 string yes #1
WAN2線情報
   circuitTypeWan2 接続回線種別 string yes #1
   circuitServiceType 接続回線サービス種別 string yes #1
   circuitServiceName 接続回線サービス名 string yes
   circuitContractId 接続回線契約番号 string yes
   bandwidth 回線速度 string yes #2
   interfaceSpeed WAN IF (Speed) string yes #5
   interfaceDuplex WAN IF (Duplex) string yes #4
   ipMethod WAN IP 方式 string yes #6
   ipAddress WAN IPアドレス string yes #7
   subnetMask WAN IPアドレス(サブネット) string yes #7
   defaultGw デフォルトゲートウェイ string yes #7
   pppoeId PPPoE ID string yes #8
   pppoePassword PPPoE Password string yes #8
   pppoeAuthenticationMethod PPPoE認証方式 string yes #8 #9
   perWanPortIpAddress WAN IPアドレス(網側) string yes #1
   perBgpAsNo AS番号(網側) string yes #1
   cerBgpAsNo AS番号(宅内側) string yes #1
  • #1 設定変更不可
  • #2 terminalType:C4321指定の場合、1-9999から選択。terminalType:c891F指定の場合、1-1000から指定
  • #3 "10","100","1000","auto"から指定
  • #4 interfaceSpeed"auto"の場合は"auto"、interfaceSpeedが"auto"以外の場合は"full"
  • #5 terminalTypeでC4321,ASR1Kの場合:10,100,1000,auto、C891の場合:10,100,autoから指定(Internetシングル構成の場合のみ1000も選択可)
  • #6 circuitTypeWan2がINTERNETの場合は、"PPPoE"か"StaticIP"から指定、circuitTypeWan2でVPNを選択の場合は設定変更不可
  • #7 ipMethodで"StaticIP"の場合に指定、"PPPoE"の場合は"null"、circuitTypeWan2でVPNを選択の場合は設定変更不可
  • #8 ipMethodで"PPPoE"の場合に指定、"StaticIP"の場合は"null"、circuitTypeWan2でVPNを選択の場合は設定変更不可
  • #9 "CHAP"を指定
LAN側ポート設定
Name Description Type Mandatory Remarks
lanPortSettings 端末のLAN側インターフェイス設定 array yes
   available true/false boolean yes #13
   name 識別名 string yes
   portVlanNo Untag VLAN番号 string yes #14 #15
   tagVlanNo Tag VLAN番号 string yes #14 #16
   vlanMode Tagged/Untagged string yes #17
   port ポート番号 string yes #18
  • #13 ポートを有効化する場合は"true",無効かする場合は"false"を選択
  • #14 Vlanの総数はC4321は30個まで、C891は10個までとし、2-4094(1002-1005および、2350-2449除く)から指定
  • #15 Untagの場合、Vlan IDを2-4094から1個入力
  • #16 tagVlanの場合、Vlan IDを2-4094からカンマで区切り、最大10個入力可能
  • #17 "Tagged""Untagged"にて指定
  • #18 1-8にて指定、端末冗長利用の場合は1-7にて指定、ASR1Kの場合は3-6で指定、ASR1Kで端末冗長利用の場合は3-5で指定
VLANネットワークアドレス設定
Name Description Type Mandatory Remarks
vlanSettings VLANネットワーク設定 array yes
   ipAddress IPアドレス string no #19
   vlanId VLAN ID string no #14
   subnetMask サブネットマスク string no
   available true/false boolean no #20
   name 識別名 string no
   ipAddressPrimary IPアドレス(Primary) string no #21
   ipAddressSecondary IPアドレス(Secondary) string no #21
   portNo Port番号 string no #22
   tagging tagged/untagged string no #23
  • #19 端末冗長利用時は"ipAddressVip"を指定
  • #20 有効化する場合はtrue、無効化する場合はfals
  • #21 端末冗長利用時にのみ指定
  • #22 ASR1K利用の場合は2-5,ASR1K端末冗長利用時は3-5で指定、C4321,C891を利用の場合は"null"
  • #23 ASR1K利用の場合は"Tagged","Untagged"を指定、C4321,C891を利用の場合は"null"
LAN側ルーティング設定(Static)
Name Description Type Mandatory Remarks
lanRoutingSettings LAN側ルーティング設定(Static) array yes
   name 識別名 string no
   ipAddress あて先NWアドレス string no
   subnetMask あて先NWアドレス(サブネット) string no
   gwIpAddress デフォルトGWIPアドレス string no
LAN側ルーティング設定(Dynamic)
Name Description Type Mandatory Remarks
lanRoutingSettingDynamic LAN側ルーティング設定(Dynamic) object yes
   ospfEnable true/false boolean no #24
   ospf OSPF object no
      ospfRouterId OSPF Router ID string no
      ospfType OSPF Type string no #1
      networkType Network Type string no #1
      processNumber Process Number string no #1
      areaNumber Area Number string no #25
      authenticationType Authentication Type string no #26
      text text string no #27
      keyId Key ID string no #28
      password Password string no #28
      ospfInterface OSPFを適用するInterface array no
         port ポート番号 string no #29
         vlan VLAN ID string no #30
      distributionRouteToNetwork 網側へ広告する経路 array no
         name 識別名 string no
         ipAddress IP Address string no
         subnetmask Subnet Mask string no
  • #24 C891Fの場合、"fales"固定
  • #25 0-65535から指定
  • #26 "none","TEXT","MD5"から指定
  • #27 authenticationTypeで"TEXT"選択時にのみ指定、"none","MD5"を選択時は"null"
  • #28 authenticationTypeで"MD5"選択時にのみ指定、"none","TEXT"を選択時は"null"
  • #29 ASR1K利用時にのみ3-6から指定、ASR1K端末冗長利用時は3-5から指定、C4321利用時はnull
  • #30 VLAN IDを指定
DHCP
Name Description Type Mandatory Remarks
dhcp DHCP設定 object yes
   method Server/Relay/なし string yes #31
   server Server object yes
  &nbsp   exclusionRange 除外範囲 string yes #32
  &nbsp   defaultRouter デフォルトルーターアドレス string yes #32
  &nbsp   primaryDns プライマリDNSアドレス string yes #32
  &nbsp   secondaryDns セカンダリDNSアドレス string yes #32
  &nbsp   domain DHCPドメイン string yes #32
  &nbsp   ipAddress DHCP適用ネットワークアドレス(IPアドレス) string yes #32
  &nbsp   subnetMask DHCP適用ネットワークアドレス(サブネットマスク) string yes #32
  &nbsp   primaryWins プライマリWINSアドレス string yes #32
  &nbsp   secondaryWins セカンダリWINSアドレス string yes #32
   relay Relay object yes
      ipAddress1 DHCPサーバーアドレス1 string yes #33
      ipAddress2 DHCPサーバーアドレス2 string yes #33
      ipAddress2 DHCPサーバーアドレス3 string yes #33
      ipAddress2 DHCPサーバーアドレス4 string yes #33
  • #31 "Server""Relay""None"から指定
  • #32 "Relay""None"を指定の場合は"null"
  • #33 "Server""None"を指定の場合は"null"
IPフィルタリング
Name Description Type Mandatory Remarks
ipFilterings IPフィルタリングの設定 array yes
   portName 対象インターフェイス string no #34
   targetInterface 対象インターフェイス string no #35
   settings 設定内容 array no
      direction IN string no
      destinationIpAddress あて先IPアドレス string no #36
      destinationPortNo あて先ポート番号 string no #36
      destinationSubnetMask あて先サブネットマスク string no #36
      protocol プロトコル string no #37
      seqNo 優先順 string no #38
      sourceIpAddress 送信元IPアドレス string no #36
      sourcePortNo 送信元ポート番号 string no #36
      sourceSubnetMask 送信元サブネットマスク string no #36
      action deny/permit string no
  • #34 ASR1K利用時に2-5から指定、ASR1K端末冗長利用時は3-5にて指定、C4321,C891を利用時は"null"
  • #35 IPフィルタリングを設定するInterface、"WAN1""WAN2""VLANXX"(XXには作成済みのVLAN ID)より指定
  • #36 指定しない場合は"any"
  • #37 "tcp""udp""ip"から指定
  • #38 1-9999にて指定、設定箇Interface毎に60個までとする
ToS設定
Name Description Type Mandatory Remarks
tosSettings TOS設定 array yes
   tos TOS値 string yes #39
   settings 設定内容 array yes
      direction IN string no #1
      seqNo 優先順 string no #40
      protocol プロトコル string no #37
      sourceIpAddress 送信元IPアドレス string no #36
      sourceSubnetMask 送信元サブネットマスク string no #36
      sourcePort 送信元ポート番号 string no #36
      destinationIpAddress あて先IPアドレス string no #36
      destinationPortNo あて先ポート番号 string no #36
      destinationSubnetMask あて先サブネットマスク string no #36
      action deny/permit string no
  • #39 ToS値はdefault,1~7まで(6は除く)を応答
  • #40 1-9999にて指定、設定箇所毎に120個までとする
優先制御
Name Description Type Mandatory Remarks
qos 優先制御 string yes #41
  • #41 優先制御はなし(none)/4段階(4clsss)/6段階(6class)から、設定した値を応答。
インターネットブレイクアウト
Name Description Type Mandatory Remarks
internetBreakout インターネットブレイクアウト設定 object yes
   enable true/fals boolean yes
   services サービスを指定してブレイクアウト array yes
      serviceName サービス名称 string yes #1 #43
      breakout true/false string no
   applications アプリケーションを指定してブレイクアウト array no
      name 識別名 string no
      applicationName アプリケーション名 string no #44
   specificIpAddress IPアドレスを指定してブレイクアウト array yes
      listId リストID string no 端末ID+6桁の数字
      name 識別名 string no
      ipAddress あて先IPアドレス string no
      netmask あて先サブネットマスク string no
  • #43 "office365"固定
  • #44 既定のアプリケーションリストより指定、applicationNameはアプリケーションリスト取得APIにて取得
WAN側インターフェイス設定(Secondary)
Name Description Type Mandatory Remarks
secondaryWanConfigs WAN側インターフェイス設定(Secondary) array yes #1
   perBgpAsNo AS番号(網側)(Secondary) string yes #1
   cerIpAddress WAN IPアドレス(宅内側)(Secondary) string yes #1
   cerSubnetMask WAN サブネットマスク(宅内側)(Secondary) string yes #1
   perIpAddress WAN IPアドレス(網側)(Secondary) string yes #1
   loopbackIpAddress Loopbackアドレス string yes #1
工事情報
Name Description Type Mandatory Remarks
installationInformation 工事情報 object yes
   customerPresenceContactInformation 工事当日お客様立会者 連絡先 string yes #1
   customerPresenceCorpName 工事当日お客様立会者 会社名 string yes #1
   howToEnter 工事当日 入館方法 string yes #1
   customerPresenceCorpNameKana 工事当日お客様立会者 会社名フリガナ string yes #1
   installationCorpName 工事会社名 string yes #1
   workerContactInformation 作業員連絡先 string yes #1
   carInformation 車両情報 string yes #1
   date 確定工事日 string yes #1
   workerInformation 作業員情報 string yes #1
   customerPresenceSectionName 工事当日 お客様立会者 部課名 string yes #1
   time 確定工事時間 string yes #1
   customerPresenceName 工事当日 お客様立会者 氏名 string yes #1
   customerPresenceNameKana 工事当日 お客様立会者 氏名フリガナ string yes #1
端末配送先情報
Name Description Type Mandatory Remarks
shippingInformation 端末配送先 object yes
   address 住所 string yes #1
   buildingName 住所(ビル名) string yes #1
   email メールアドレス string yes
   contactTel 電話番号 string yes
   corpName 会社名 string yes
   corpNameKana 会社名(全角フリガナ) string yes
   country string yes #1
   equalInstallAddress 設置先住所と同じ boolean yes
   sectionName 部課名 string yes
   staffName 担当者名 string yes
   zipCode 郵便番号 string yes #1
   foreignFlag 海外配送 boolean yes
設置先情報
Name Description Type Mandatory Remarks
installationSite 設置先情報 object yes
   address 住所 string yes
   buildingName 住所(ビル名等) string yes
   email メールアドレス string yes
   contactTel 電話番号 string yes
   corpName 会社名 string yes
   corpNameKana 会社名(全角フリガナ) string yes
   country string yes
   sectionName 部課名 string yes
   staffName 担当者名 string yes
   zipCode 郵便番号 string yes
基本情報
Name Description Type Mandatory Remarks
basicInformation 基本情報 object yes
   terminalContractType 申込種別 string yes #1
   terminalType 端末種別 string yes #1
   terminalConstructionType 工事方法 string yes #1
   installRequestedDate 端末設置希望日 string yes #1
   installRequestedTimeSlot 端末設置希望時間 string yes #1
   installRequestedTimeZone 端末設置希望時間のタイムゾーン string yes #1
   onSiteRepairOption オンサイト故障交換オプション boolean yes #1
   rackMount ラックマウントキット(true/false) string yes #1
   primary プライマリ端末 object no #1 #45
      luggageTrackingNo 荷物追跡番号 string yes #1
      serialNo シリアルナンバー string yes #1
   secondary セカンダリ端末 object no #1 #45
      luggageTrackingNo 荷物追跡番号 string no #1 #45
      serialNo シリアルナンバー string no #1 #45
  • #45 端末冗長利用時にのみ
その他
Name Description Type Mandatory Remarks
redundancyOption 端末冗長 string yes #1
secondaryTerminalId 端末ID(Secondary) string yes D+10桁の数字 #45 #1
gwId GW ID string yes T+10桁の数字 #1
terminalId 端末ID string yes D+10桁の数字 #46 #1
terminalGroupId 端末グループID string yes 10桁の数字
remarks 備考 string yes
name 識別名 string yes
secondaryName セカンダリ端末識別名 string yes #45
gwId GW ID string yes #1
orderStatus 端末のオーダー状況 string yes #1
status 端末の申込状況 string yes #1
secondaryStatus セカンダリ端末の申込状況 string yes #1 #45
interLinkIpAddress 端末冗長用アドレス string yes #1 #45
interLinkSubnetMask 端末冗長用アドレス(サブネット) string yes #1 #45
preConfigureError 端末事前設定のエラー有無(true/false) boolean yes
  • #45 端末冗長利用時にのみ
  • #46 端末冗長利用時はタグ名「primaryTerminalId」

Example Request

PUT /v1/sdns/contracts/999999999999999/gateways/T9999999999/terminals/D9999999999

{
    "wanConfigs": [
          {
            "interface":ge0/0/0",
            "circuitServiceType": "Arcstar Universal One (Japan site)", 
            "circuitServiceName": "Arcstar Universal One", 
            "circuitContractId": "N999999999", 
            "bandwidth": "100", 
            "interfaceSpeed": "auto", 
            "interfaceDuplex": "auto", 
            "perWanPortIpAddress": null
            "routingSetting": "Static", 
            "perBgpAsNo": "****",
            "cerBgpAsNo": "*****", 
            "defaultGw": "99.99.99.99", 
            "ipAddress": "99.99.99.99, 
            "subnetMask": "**", 
          }, 
          {
            "interface":ge0/0/1",
            "circuitServiceType": "OCN (Japan site), 
            "circuitServiceName": "OCN", 
            "circuitContractId": "N99999999",
            "bandwidth": "100", 
            "interfaceSpeed": "auto", 
            "interfaceDuplex": "auto", 
            "ipMethod": "StaticIP", 
            "ipAddress": "99.99.99.99", 
            "subnetMask": "**", 
            "defaultGw": "99.99.99.99", 
            "pppoeId": null, 
            "pppoePassword": null
        }
    ],
    "lanPortSettings": [
        {
            "available": false, 
            "name": "port0", 
            "portVlanNo": null, 
            "tagVlanNo": "1000,1100", 
            "vlanMode": "Tagged", 
            "port": "0"
        }
        {
            "available": true, 
            "name": "port1", 
            "portVlanNo": null, 
            "tagVlanNo": "11,20,30", 
            "vlanMode": "Tagged", 
            "port": "1"
        },
        {
            "available": true, 
            "name": "port2", 
            "portVlanNo": null, 
            "tagVlanNo": "11,20,30", 
            "vlanMode": "Tagged", 
            "port": "2"
        },
        {
            "available": true, 
            "name": "port3", 
            "portVlanNo": null, 
            "tagVlanNo": "11,20,30", 
            "vlanMode": "Tagged", 
            "port": "3"
        },
        {
            "available": true, 
            "name": "port4", 
            "portVlanNo": null, 
            "tagVlanNo": "11,20,30", 
            "vlanMode": "Tagged", 
            "port": "4"
        },
        {
            "available": true, 
            "name": "port5", 
            "portVlanNo": null, 
            "tagVlanNo": "11,20,30", 
            "vlanMode": "Tagged", 
            "port": "5"
        },
        {
            "available": true, 
            "name": "port6", 
            "portVlanNo": null, 
            "tagVlanNo": "11,20,30", 
            "vlanMode": "Tagged", 
            "port": "6"
        },
        {
            "available": true, 
            "name": "port7", 
            "portVlanNo": null, 
            "tagVlanNo": "11,20,30", 
            "vlanMode": "Tagged", 
            "port": "7"
        }
    ],
    "vlanSettings": [
        {
            "ipAddressVip": "99.99.99.99", 
            "vlanId": "10", 
            "subnetMask": "**", 
            "available": false, 
            "name": "VLAN_10"
            "ipAddressPrimary":"99.99.99.99",
            "ipAddressSecondary":"99.99.99.99"
        },
        {
            "ipAddressVip": "99.99.99.99", 
            "vlanId": "20", 
            "subnetMask": "**", 
            "available": true, 
            "managementName": "VLAN_15"
            "ipAddressPrimary":"99.99.99.99",
            "ipAddressSecondary":"99.99.99.99"
        }, 
        {
            "ipAddressVip": "99.99.99.99", 
            "vlanId": "30", 
            "subnetMask": "**", 
            "available": true, 
            "managementName": "VLAN_20"
            "ipAddressPrimary":"99.99.99.99",
            "ipAddressSecondary":"99.99.99.99"
        }
    ], 
    "lanRoutingSettings": [
        {
            "name": "Static2", 
            "ipAddress": "99.99.99.99", 
            "subnetMask": "**", 
            "gwIpAddress": "99.99.99.99"
        },
        {
            "name": "Static3", 
            "ipAddress": "99.99.99.99", 
            "subnetMask": "**", 
            "gwIpAddress": "99.99.99.99"
        },
        {
            "name": "Static4", 
            "ipAddress": "99.99.99.99", 
            "subnetMask": "**", 
            "gwIpAddress": "99.99.99.99"
        }
    ], 
    "dhcp": {
        "method": "Relay", 
        "server": { 
          "exclusionRange": null,
          "defaultRouter": null,
          "primaryDns": null,
          "secondaryDns": null,
          "domain": null, 
          "ipAddress": null, 
          "subnetMask": null, 
          "primaryWins": null, 
          "secondaryWins": null
    }, 
        "relay": { 
          "ipAddress1": "99.99.99.99",
          "ipAddress2": "99.99.99.99",
          "ipAddress3": "99.99.99.99",
          "ipAddress4": "99.99.99.99"
    }, 
    "ipFilterings": [
        {
            "targetInterface": "WAN1", 
            "settings": [
                {
                    "direction": "IN", 
                    "destinationIpAddress": "99.99.99.99", 
                    "destinationPortNo": "**", 
                    "destinationSubnetMask": "99.99.99.99", 
                    "protocol": "udp", 
                    "seqNo": "60", 
                    "sourceIpAddress": "99.99.99.99", 
                    "sourcePortNo": "**", 
                    "sourceSubnetMask": "99.99.99.99", 
                    "action": "deny"
                }
            ]
        },
        {
            "targetInterface": "WAN1", 
            "settings": [
                {
                    "packetDirection": "IN", 
                    "destinationIpAddress": "99.99.99.99", 
                    "destinationPortNo": "**", 
                    "destinationSubnetMask": "99.99.99.99", 
                    "destinationProtocol": "tcp", 
                    "seqNo": "80", 
                    "sourceIpAddress": "99.99.99.99", 
                    "sourcePortNo": "110", 
                    "sourceSubnetMask": "99.99.99.99", 
                    "action": "permit"
                }
            ]
        },
        {
            "targetInterface": "Vlan10", 
            "settings": [
                {
                    "packetDirection": "IN", 
                    "destinationIpAddress": "99.99.99.99", 
                    "destinationPortNo": null, 
                    "destinationSubnetMask": "99.99.99.99", 
                    "destinationProtocol": "tcp", 
                    "seqNo": "55", 
                    "sourceIpAddress": "99.99.99.99", 
                    "sourcePortNo": "80", 
                    "sourceSubnetMask": "99.99.99.99", 
                    "action": "deny"
                },
                {
                    "packetDirection": "IN", 
                    "destinationIpAddress": "99.99.99.99", 
                    "destinationPortNo": null, 
                    "destinationSubnetMask": "99.99.99.99", 
                    "destinationProtocol": "tcp", 
                    "seqNo": "65", 
                    "sourceIpAddress": "99.99.99.99", 
                    "sourcePortNo": null, 
                    "sourceSubnetMask": "99.99.99.99", 
                    "action": "deny"
                }
            ]
        }
    ], 
    "tosSettings": [
        {
            "tos":"7",
            "settings": [
                {
                    "direction": "IN",
                    "seqNo": "51",
                    "protocol": "tcp",
                    "sourceIpAddress": "99.99.99.99",
                    "sourceSubnetMask": "**",
                    "sourcePort": null,
                    "destinationIpAddress": "99.99.99.99",
                    "destinationSubnetMask": "**",
                    "destinationPort": "88",
                    "action": "permit"
                }
            ]
        },
        {
            "tos":"5",
            "settings": [
                {
                    "direction": "IN",
                    "seqNo": "51",
                    "protocol": "tcp",
                    "sourceIpAddress": "99.99.99.99",
                    "sourceSubnetMask": "**",
                    "sourcePort": null,
                    "destinationIpAddress": "99.99.99.99",
                    "destinationSubnetMask": "**",
                    "destinationPort": "88",
                    "action": "permit"
                }
            ]
        },
        {
            "tos":"4",
            "settings": []
        },
        {
            "tos":"3",
            "settings": []
        },
        {
            "tos":"2",
            "settings": []
        },
        {
            "tos":"1",
            "settings": []
        },
        {
            "tos":"default",
            "settings": []
        }
    ],
    "qos": "4class", 
    "internetBreakout": {
      "enable": true 
      "services": [
       {
        "serviceName":"office365",
        "breakout":true, 
       }
      ],
      "applications": [
      {
        "name": "app",
        "applicationName": "3pc"
      }
     ]
     "specificIpAddress": [
    {
      "listId" : "D9999999999_999999"
      "name":"****",
      "ipAddress":"99.99.99.99",
      "netmask":32,  
    }
  ]
}
    "secondaryWanConfigs": [
        {
            "perBgpAsNo": "****",
            "cerIpAddress": "99.99.99.99",
            "cerSubnetMask": "**",
            "perIpAddress": "99.99.99.99",
            "loopbackIpAddress": "99.99.99.99"
        }
    ],
  "installationInformation": {
    "customerPresenceContactInformation": "999-999-9999",
    "customerPresenceCorpName": "xxxxxx株式会社",
    "howToEnter": "memoxxxxxx",
    "customerPresenceCorpNameKana": "xxxxxxカブシキガイシャ",
    "installationCorpName": "株式会社xxxxxx",
    "workerContactInformation": "999-999-9999",
    "carInformation": "xxxxxx",
    "date": "2017-04-01",
    "workerInformation": "xxxxxx",
    "customerPresenceSectionName": "xxxxxx部"
    "time": "99:99",
    "customerPresenceName": "xxxxxx",
    "customerPresenceNameKana": "xxxxxx"
    },
  "secondaryTerminalId": "D9999999999",
  "internetBreakoutEnable": false,
  "gwId": "T9999999999",
  "primaryTerminalId": "D9999999999", 
  "remarks": "memoxxxxxx", 
  "name": "SD-NS-Txxxxxx**", 
  "secondaryName": "SD-NS-Txxxxxx**", 
  "orderStatus": "Completed", 
  "status": "Activated", 
  "secondaryStatus": "Activated", 
  "interLinkIpAddress":"99.99.99.99",
  "interLinkSubnetMask":"**",
  "terminalGroupId": "9999999999", 
  "preConfigureError": false, 
  "shippingInformation": {
      "address": "東京都xxxxxx", 
      "buildingName": "xxxxxxビル", 
      "email": "xxxxxx@xxx.xxx", 
      "contactTel": "999-999-9999", 
      "corpName": "xxxxxx株式会社", 
      "corpNameKana": "xxxxxxカブシキガイシャ", 
      "country": "Japan", 
      "equalInstallAddress": true, 
      "sectionName": "xxxxxx部", 
      "staffName": "xxxxxx", 
      "zipCode": "9999999"
      "foreignFlag": false, 
  }, 
  "installationSite": {
      "address": "東京都xxxxxx", 
      "buildingName": "xxxxxxビル", 
      "email": "xxxxxx@xxx.xxx", 
      "contactTel": "9999-999-9999", 
      "corpName": "xxxxxx株式会社", 
      "corpNameKana": "xxxxxxカブシキガイシャ", 
      "country": "Japan", 
      "sectionName": "xxxxxx部", 
      "staffName": "xxxxxx", 
      "zipCode": "9999999"
  }, 
  "basicInformation": {
      "terminalContractType": "Purchase", 
      "terminalType": "C4321", 
      "terminalConstructionType": "On-site",    
      "installRequestedDate": "2017-04-01", 
      "installRequestedTimeSlot": "9:99", 
      "installRequestedTimeZone": "+09:00", 
      "onSiteRepairOption": false, 
      "luggageTrackingNo": "xxxxxx-999999999", 
      "rackMount": "false", 
      "serialNo": "xxxxxx****", 
  }
}

Response Code

Code Description
202 成功
400 parameterの型不正
404 指定されたID、もしくはIDの組合せが存在しない

Response Parameters

Name Description Type Mandatory Remarks
orderId Order ID string yes 10桁の数字

Example Result

{
    "orderId": "9999999999"
}

端末設定変更(Office365経路の更新)

インターネットブレイクアウトのoffice365経路の手動更新を行います。
※office365の通信は1日に1度、自動更新を行っております。

PUT /v1/sdns/contracts/{contractId}/gateways/{gwId}/terminals/{terminalId}/internet_breakout/office365

Request Parameters

Name Description Type Mandatory Remarks
contractId サービス契約ID string yes 15桁の数字
gwId GW契約ID string yes T+10桁の数字
terminalId 端末ID string yes D+10桁の数字

Example Request

PUT /v1/sdns/contracts/999999999999999/gateways/T999999999/terminals/D999999999/internet_breakout/office365

{
}

Response Code

Code Description
202 成功
400 parameterの型不正
404 指定されたID、もしくはIDの組合せが存在しない

Response Parameters

Name Description Type Mandatory Remarks
orderId Order ID string yes 10桁の数字

Example Result

{
    "orderId": "9999999999"
}

端末設定変更(アプリケーション定義ファイル更新)

端末のアプリケーション定義ファイルを更新します

PUT /v1/sdns/contracts/{contractId}/gateways/{gwId}/terminals/{terminalId}/application_files

Request Parameters

Name Description Type Mandatory Remarks
contractId サービス契約ID string yes 15桁の数字
gwId GW契約ID string yes T+10桁の数字
terminalId 端末ID string yes D+10桁の数字

Example Request

PUT /v1/sdns/contracts/999999999999999/gateways/T999999999/terminals/D999999999/internet_breakout/application_files

{
}

Response Code

Code Description
202 成功
400 parameterの型不正
404 指定されたID、もしくはIDの組合せが存在しない

Response Parameters

Name Description Type Mandatory Remarks
orderId Order ID string yes 10桁の数字

Example Result

{
    "orderId": "9999999999"
}

端末一覧取得

端末の情報一覧を取得するAPIです。

GET /v1/sdns/contracts/{contractId}/gateways/{gwId}/terminals

Request Parameters

Name Description Type Mandatory Remarks
contractId サービス契約ID string yes 15桁の数字
gwId 端末に紐づくGWのID string yes T+10桁の数字

Example Request

GET /v1/sdns/contracts/999999999999999/gateways/T9999999999/terminals

Response Code

Code Description
200 成功
400 parameterの型不正
404 指定されたID、もしくはIDの組合せが存在しない

Response Parameters

Name Description Type Mandatory Remarks
gwId GW ID string yes T+10桁の数字
teminals 端末情報 array yes
   name 識別名 string yes
   terminalId 端末ID string yes D+10桁の数字 #1
   orderStatus 端末のオーダー状況 string yes #2
   basicInformation 基本情報 object yes
      installRequestedDate 工事希望日 object yes
      terminalGroupId 端末グループID string yes 10桁の数字
   status 端末の申込状況 string yes #3
   installationSite 設置先情報 object yes
      address 住所 string yes
      buildingName 住所(ビル名) string yes
   secondaryTerminalId 端末ID(Secondary) string no D+10桁の数字 #4
  • #1 端末冗長利用時はタグ名「primaryTerminalId」と応答
  • #2 Processing:変更中, Completed:完了, Error:エラー, Canceled:キャンセル
  • #3 Processing:変更中, Kitting:キッティング中, Deliverd:配送中, Activated:アクティベーション済み, WaitingSendBack,SendBack:端末廃止済み
  • #4 端末冗長利用時にのみ応答

Example Result

{
    "gwId": "T9999999999",
    "terminals": [
        {
            "name": "SD-NS-T1xxxxxx", 
            "primaryTeminalId": "D9999999999", 
            "orderStatus": "Completed", 
            "basicInformation": {
                "installRequestedDate": "2017-04-01",
                "terminalGroupId": "9999999999"
            },   
            "status": "Activated", 
            "installationSite": {
                "address": "東京都xxxxxx", 
                "buildingName": "xxxxxxビル"
            }
            "secondaryTerminalId" : "D9999999999",
        },
        {
            "name": "SD-NS-T2xxxxxx", 
            "primaryTeminalId": "D9999999999", 
            "orderStatus": "Completed", 
            "basicInformation": {
                "installRequestedDate": "2017-04-01",
                "terminalGroupId": "99999999999
            },   
            "status": "Activated", 
            "installationSite": {
                "address": "東京都xxxxxx", 
                "buildingName": "xxxxxxビル"
            }
            "secondaryTerminalId" : "D9999999999",
        },
        {
            "name": "SD-NS-T3xxxxxx", 
            "teminalId": "D9999999999", 
            "orderStatus": "Completed", 
            "basicInformation": {
                "installRequestedDate": "2017-04-01",
                "terminalGroupId": "9999999999"

            },   
            "status": "Activated", 
            "installationSite": {
                "address": "東京都xxxxxx", 
                "buildingName": "xxxxxxビル"
            }
        }
    ]
}

端末廃止

相互接続の廃止申込を行います。

DELETE /v1/sdns/contracts/{contractId}/gateways/{gwId}/terminals/{terminalId}

Request Parameters

Name Description Type Mandatory Remarks
contractId サービス契約ID string yes 15桁の数字
gwId 端末に紐づくGWのID string yes T+10桁の数字
terminalId 端末ID string yes D+10桁の数字

Example Request

DELETE /v1/sdns/contracts/999999999999999/gateways/T9999999999/terminals/D9999999999

Response Code

Code Description
202 成功
400 parameterの型不正
404 指定されたID、もしくはIDの組合せが存在しない

Response Parameters

Name Description Type Mandatory Remarks
orderId Order ID string yes 10桁の数字

Example Result

{
    "orderId": "9999999999"
}

端末廃止情報登録

端末廃止後に回収日や回収先の情報を登録します。

PUT /v1/sdns/contracts/{contractId}/gateways/{gwId}/terminals/{terminalId}/adjustments

Request Parameters

Name Description Type Mandatory Remarks
contractId サービス契約ID string yes 15桁の数字
gwId 端末に紐づくGWのID string yes T+10桁の数字
terminalId 端末ID string yes D+10桁の数字

Example Request

PUT /v1/sdns/contracts/999999999999999/gateways/T9999999999/terminals/D9999999999/adjustments

{

   "collectionRequestedDate" : "2018-07-31",
   "collectionRequestedTimeSlot" : "9:00"
   "collectionContactInformation" : {
      "country" : "Japan",
      "foreignFlag" : "false",
      "zipCode" : "9999999",
      "address" : "東京都xxxxxx",
      "buildingName" : "xxxxxxビル",
      "corpName" : "xxxxxx株式会社",
      "corpNameKana" : "xxxxxxカブシキガイシャ",
      "sectionName" : "xxxxxx部",
      "staffName" : "xxxxxx",
      "contactTel" : "999-9999-9999",
      "email" : "xxxxxx@xxx.xxx",
   },
   "redundancyOption" : true
}

Response Code

Code Description
202 成功
400 parameterの型不正
404 指定されたID、もしくはIDの組合せが存在しない

Response Parameters

Name Description Type Mandatory Remarks
orderId Order ID string yes 10桁の数字

Example Result

{
    "orderId": "9999999999"
}

端末グループ作成

端末グループを作成します。

POST /v1/sdns/contracts/{contractId}/terminal_groups

Request Parameters

Name Description Type Mandatory Remarks
contractId サービス契約ID string yes 15桁の数字
Name Description Type Mandatory Remarks
name 識別名 string yes

Example Request

POST /v1/sdns/contracts/99999999999999/terminal_groups

{
    "name": "Test1"
}

Response Code

Code Description
201 成功
400 parameterの型不正
404 指定されたID、もしくはIDの組合せが存在しない

Response Parameters

Name Description Type Mandatory Remarks
groupId 端末グループID string yes 10桁の数字
orderId Order ID string yes 10桁の数字

Example Result

{
    "groupId":"9999999999"
    "orderId":"9999999999"
}

端末グループ一覧取得

端末グループの情報一覧を取得するAPIです。

GET /v1/sdns/contracts/{contractId}/terminal_groups

Request Parameters

Name Description Type Mandatory Remarks
contractId サービス契約ID string yes 15桁の数字

Example Request

GET /v1/sdns/contracts/999999999999999/terminal_groups

Response Code

Code Description
200 成功
400 parameterの型不正
404 指定されたID、もしくはIDの組合せが存在しない

Response Parameters

Name Description Type Mandatory Remarks
terminalGroups 端末グループ情報 array yes
   terminalGroupId 端末グループID string yes 10桁の数字
   name 識別名 string yes
contractId サービス契約ID string yes 15桁の数字

Example Result

{
    "terminalGroups": [
        {
            "terminalGroupId": "9999999999", 
            "name": "default group"
        }, 
        {
            "terminalGroupId": "9999999999", 
            "name": "xxxxxx"
        }
    ], 
    "contractId": "999999999999999"
}

端末グループ設定変更

端末グループの設定変更を行います。

PUT /v1/sdns/contracts/{contractId}/terminal_groups/{terminalGroupId}

Request Parameters

Name Description Type Mandatory Remarks
contractId サービス契約ID string yes 15桁の数字
terminalGroupId ターミナルグループID string yes 10桁の数字
Name Description Type Mandatory Remarks
name 識別名 string yes

Example Request

PUT /v1/sdns/contracts/999999999999999/terminal_groups/9999999999

{
    "name": "Updated CE Group Name"
}

Response Code

Code Description
202 成功
400 parameterの型不正
404 指定されたID、もしくはIDの組合せが存在しない

Response Parameters

Name Description Type Mandatory Remarks
orderId Order ID string yes 10桁の数字

Example Result

{
    "orderId": "9999999999"
}

端末グループ削除

端末グループを削除します。

DELETE /v1/sdns/contracts/{contractId}/terminal_groups/{terminalGroupId}

Request Parameters

Name Description Type Mandatory Remarks
contractId サービス契約ID string yes 15桁の数字
terminalGroupID 端末グループID string yes 10桁の数字

Example Request

DELETE /v1/sdns/contracts/999999999999999/terminal_groups/9999999999

Response Code

Code Description
202 成功
400 parameterの型不正
404 指定されたID、もしくはIDの組合せが存在しない

Response Parameters

Name Description Type Mandatory Remarks
orderId Order ID string yes 10桁の数字

Example Result

{
    "orderId": "9999999999"
}

端末監視状態取得

端末の監視状態(監視中/非監視)を取得するAPIです。

GET /v1/sdns/contracts/{contractId}/gateways/{gwId}/terminals/{terminalId}/monitoring

Request Parameters

Name Description Type Mandatory Remarks
contractId サービス契約ID string yes 15桁の数字
gwId 端末に紐づくGWのID string yes T+10桁の数字
terminalId 端末ID string yes D+10桁の数字

Example Request

GET /v1/sdns/contracts/999999999999999/gateways/T9999999999/terminals/D9999999999/monitoring

Response Code

Code Description
200 成功
400 parameterの型不正
404 指定されたID、もしくはIDの組合せが存在しない

Response Parameters

Name Description Type Mandatory Remarks
status 端末の監視状態 number yes #1
  • #1 0:監視中, 1:監視停止中(アクティベーション前), 2:監視停止中

Example Result

{
 "status": 2
}

端末監視状態一覧取得

端末の監視状態(監視中/非監視)を取得するAPIです。

GET /v1/sdns/contracts/{contractId}/monitoring

Request Parameters

Name Description Type Mandatory Remarks
contractId サービス契約ID string yes 15桁の数字

Example Request

GET /v1/sdns/contracts/999999999999999/monitoring

Response Code

Code Description
200 成功
400 parameterの型不正
404 指定されたID、もしくはIDの組合せが存在しない

Response Parameters

Name Description Type Mandatory Remarks
time 取得時間 string yes
status 端末の監視状態 string yes #1
terminalId 端末ID string yes D+10桁の数字
userId お客様ID(オーダー者のメールアドレス) string yes
  • #1 0:監視中, 1:監視停止中(アクティベーション前), 2:監視停止中

Example Result

[
  { 
    "time":     "2018-02-01T00:00:00+09:00",
    "status":   1,
    "terminalId": "D999999999",
    "userId":   "sample@test.com"
  },
  {
    :
  }
]

端末監視状態切替

端末の監視状態(監視中/非監視)を切り替えるAPIです。

PUT /v1/sdns/contracts/{contractId}/gateways/{gwId}/terminals/{terminalId}/monitoring

Request Parameters

Name Description Type Mandatory Remarks
contractId サービス契約ID string yes 15桁の数字
gwId 端末に紐づくGWのID string yes T+10桁の数字
terminalId 端末ID string yes D+10桁の数字
status 端末の監視状態 number yes #1
  • #1 0:監視中, 1:監視停止中(アクティベーション前), 2:監視停止中

Example Request

PUT /v1/sdns/contracts/999999999999999/gateways/T9999999999/terminals/D9999999999/monitoring

{
 "status": 2
}

Response Code

Code Description
202 成功
400 parameterの型不正
404 指定されたID、もしくはIDの組合せが存在しない

端末状態取得

端末に対する故障/運用状態を取得するAPIです。

GET /v1/sdns/contracts/{contractId}/gateways/{gwId}/terminals/{terminalId}/alarms

Request Parameters

Name Description Type Mandatory Remarks
contractId サービス契約ID string yes 15桁の数字
gwId 端末に紐づくGWのID string yes T+10桁の数字
terminalId 端末ID string yes D+10桁の数字
from 指定した時刻以降の情報を取得 string yes iso8601形式のJST時間 #1 #2 #3
to 指定した時刻以前の情報を取得 string yes iso8601形式のJST時間 #1 #2 #3
  • #1 例 2017-04-01T00:00:00
  • #2 現在時刻より93日より前の情報は取得できない
  • #3 fromtoの差は24時間以内でなければならない

Example Request

GET /v1/sdwan/contracts/999999999999999/gateways/T9999999999/terminals/D9999999999/alarms?from=2017-04-01T00:00:00&to=2017-04-01T23:59:59

Response Code

Code Description
200 成功
400 parameterの型不正
404 指定されたID、もしくはIDの組合せが存在しない

Response Parameters

Name Description Type Mandatory Remarks
time 取得時刻 string no iso8601形式のJST時間 #1 #4
status 端末の状態 number no #5 #6
  • #4 端末状態は、5分間隔で取得/蓄積されている
  • #5 0:正常, 2000:wan1異常, 3000:wan2異常, 4000:lan異常, 9000:切断,
  • #6 端末冗長利用時のみのパラメーター 5001:渡り1系故障, 5002:渡り2系故障, 5100:渡り回線両系断, 8001:Primary機断, 8002:Secondary機断,

Example Result

[
{"time":"2017-04-01T00:00:00+09:00","status":0},
{"time":"2017-04-01T00:05:00+09:00","status":2000},
{"time":"2017-04-01T00:10:00+09:00","status":3000},
]

端末状態一覧取得

特定の契約に紐付く端末の状態を一覧で取得します。

GET /v1/sdns/contracts/{contractId}/alarms

Request Parameters

Name Description Type Mandatory Remarks
contractId サービス契約ID string yes 15桁の数字
from 指定した時刻以降の情報を取得 string no iso8601形式のJST時間 #1
to 指定した時刻以前の情報を取得 string no iso8601形式のJST時間 #1
to 指定した時刻以前の情報を取得 string no iso8601形式のJST時間 #1
only_change ステータス変更があった情報のみを取得 string no
  • #1 例 2017-04-01T00:00:00

Example Request

GET /v1/sdwan/contracts/999999999999999/alarms?only_change&from=2017-04-01T00:00:00&to=2017-04-01T23:59:59

Response Code

Code Description
200 成功
400 parameterの型不正
404 指定されたID、もしくはIDの組合せが存在しない

Response Parameters

Name Description Type Mandatory Remarks
time 最終取得時刻 string no iso8601形式のJST時間 #1 #2
status 端末の状態 number no #3 #4
  • #1 例 2017-04-01T00:00:00
  • #2 端末状態は、3時間以内に発生したログのみを表示
  • #3 0:正常, 2000:wan1異常, 3000:wan2異常, 4000:lan異常, 9000:切断,
  • #4 端末冗長利用時のみのパラメーター 5001:渡り1系故障, 5002:渡り2系故障, 5100:渡り回線両系断, 8001:Primary機断, 8002:Secondary断,

Example Result

{
  "D1234567891": { "status": 4000, "time": "2016-08-10T12:17:00+09:00" },
  "D1234567893": { "status": 2000, "time": "2016-08-10T12:18:00+09:00" },
  "D1234567892": { "status": 3000, "time": "2016-08-10T12:18:00+09:00" },
}

端末状態詳細取得

端末の運用状態詳細を取得するAPIです。

GET /v1/sdns/contracts/{contractId}/gateways/{gwId}/terminals/{terminalId}/status

Request Parameters

Name Description Type Mandatory Remarks
contractId サービス契約ID string yes 15桁の数字
gwId 端末に紐づくGWのID string yes T+10桁の数字
terminalId 端末ID string yes D+10桁の数字

Example Request

GET /v1/sdns/contracts/999999999999999/gateways/T9999999999/terminals/D9999999999/status

Response Code

Code Description
200 成功
400 parameterの型不正
404 指定されたID、もしくはIDの組合せが存在しない

Response Parameters

Name Description Type Mandatory Remarks
detail 端末のステータス等詳細を応答 object yes
   contractId サービス契約ID string yes
   gwId GW ID string yes
   terminalId 端末ID string yes
   time 実施時間 string yes
   connectivity 疎通確認結果 string yes
   errerReason NG理由 string yes
   wanInterface WAN側Interfaceのステータス object yes
      wan1 WAN1 array yes
      wan2 WAN2 array yes
      type Underlay/Overlay string yes
      port ポート(Interface番号/Tunnel) string yes
      config 設定(Down/Up) string yes
      status ステータス(Down/Up) string yes
   lanInterfaces LAN側Interfaceのステータス object yes
      port ポート(Interface番号) string yes
      config 設定(Down/Up) string yes
      status ステータス(Down/Up) string yes
   underlayStatus アンダーレイ回線のステータス array yes
      interface Interface(wan1/wan2) string yes
      lineType 回線種別(MPLS/Internet) string yes
      pingStatus Pingのステータス string yes
      pingGw Ping先 string yes
      bgpStatus BGPのステータス string yes
      bgpUpTime BGPのアップタイム string yes
      pppoeStatus PPPoEのステータス string yes
   overlayStatus オーバーレイのステータス array yes
      bgpPath WAN側回線情報 string yes
      bgpStatus BGPステータス string yes
      bgpUpTime BGPアップタイム string yes
   ipFilterCounters IPフィルタリング array yes
      interface Interface(wan1/wan2/vlan) string yes
      settings 内容 array yes
         action deny/parmit string yes
         protocol プロトコル string yes
         srcIpaddress 送信元IPアドレス string yes
         srcSubnetMask 送信元サブネットマスク string yes
         srcPortNo 送信元ポート番号 string yes
         dstIpaddress あて先IPアドレス string yes
         dstSubnetMask あて先サブネットマスク string yes
         dstPortNo あて先ポート番号 string yes
         count 該当パケット数 string yes
   pppoeStatus PPPoEのステータス(Up/Down) string yes
   ospfStatus ospfのステータス array yes
      neighborId Neighbor ID string yes
      status Full/BDR string yes
      neighborAddress Neighbor Address string yes
      port ポート(Interface番号/vlan番号) string yes
      upTime アップタイム string yes
   terminalHistory 端末情報 object yes
      reload 再起動時間 string yes
      lastConfigChange 最終設定変更時間 string yes

Example Result

{
  "detail": {
    "contractId": "999999999999999",
    "gwId": "T9999999999",
    "terminalId": "D9999999999",
    "time": "2018/07/20 17:25:00 JST",
    "connectivity": "OK",
    "errorReason": "null",
    "wanInterfaces": {
      "wan1": [
        {
          "type": "Underlay",
          "port": "GE0/0/0",
          "config": "up",
          "status": "up"
        },
        {
          "type": "Overlay",
          "port": "Tunnel",
          "config": "up",
          "status": "up"
        }
      ],
      "wan2": [
        {
          "type": "Underlay",
          "port": "GE0/0/1",
          "config": "up",
          "status": "up"
        },
        {
          "type": "Overlay",
          "port": "Tunnel",
          "config": "up",
          "status": "up"
        }
      ]
    },
    "lanInterfaces": [
      {
        "port": "GE0",
        "config": "up",
        "status": "up"
      },
      {
        "port": "GE1",
        "config": "ad-down",
        "status": "down"
      },
      {
        "port": "GE2",
        "config": "up",
        "status": "up"
      },
      {
        "port": "GE3",
        "config": "ad-down",
        "status": "down"
      },
      {
        "port": "GE4",
        "config": "up",
        "status": "up"
      },
      {
        "port": "GE5",
        "config": "ad-down",
        "status": "down"
      },
      {
        "port": "GE6",
        "config": "up",
        "status": "up"
      },
      {
        "port": "GE7",
        "config": "ad-down",
        "status": "down"
      }
    ],
    "underlayStatus": [
      {
        "interface": "wan1",
        "lineType": "MPLS",
        "pingStatus": "OK",
        "pingGw": "192.168.2.1",
        "pppoeStatus": "null",
        "bgpStatus": UP
        "bgpUpTime": 05:15
      },
      {
        "interface": "wan2",
        "lineType": "INET",
        "pingStatus": null,
        "pingGw": null,
        "pppoeStatus": "UP",
        "bgpStatus": null
        "bgpUpTime": null
      }
    ],
    "overlayStatus": [
      {
        "bgpPath": "wan1-1",
        "bgpStatus": "Established"
        "bgpUpTime": "5w1d"
      },
      {
        "bgpPath": "wan1-2",
        "bgpStatus": "Established"
        "bgpUpTime": "5w1d"
      },
      {
        "bgpPath": "wan2-1",
        "bgpStatus": "Idle"
        "bgpUpTime": "5w1d"
      },
      {
        "bgpPath": "wan2-2",
        "bgpStatus": "Active"
        "bgpUpTime": "5w1d"
      }
    ],
    "ipFilterCounters": [
      {
        "interface": "wan1",
        "settings": [
          {
            "action": "deny",
            "protocol": "udp",
            "srcIpaddress": "99.99.99.99",
            "srcSubnetMask": "**",
            "srcPortNo": "http",
            "dstIpaddress": "99.99.99.99",
            "dstSubnetMask": "**",
            "dstPortNo": "123",
            "count": "3"
          },
          {
            "action": "deny",
            "protocol": "udp",
            "srcIpaddress": "any",
            "srcSubnetMask": "any",
            "srcPortNo": "http",
            "dstIpaddress": "99.99.99.99",
            "dstSubnetMask": "**",
            "dstPortNo": "123",
            "count": "3"
          }
        ]
      },
      {
        "interface": "wan2",
        "settings": [
          {
            "action": "deny",
            "protocol": "udp",
            "srcIpaddress": "any",
            "srcSubnetMask": "any",
            "srcPortNo": null,
            "dstIpaddress": "99.99.99.99",
            "dstSubnetMask": "**",
            "dstPortNo": "ssh",
            "count": "3"
          }
        ]
      },
      {
        "interface": "vlan10",
        "settings": [
          {
            "action": "deny",
            "protocol": "ip",
            "srcIpaddress": "any",
            "srcSubnetMask": "any",
            "srcPortNo": null,
            "dstIpaddress": "any",
            "dstSubnetMask": "any",
            "dstPortNo": null,
            "count": "3"
          }
        ]
      }
    ],
    "pppoeStatus": "UP",
    "ospfStatus": [
      {
        "neighborId": "1.1.1.1",
        "status": "Full/BDR",
        "neighborAddress": "99.99.99.99",
        "port": "Vlan300"
        "upTime": "1w2d"
      },
      {
        "neighborId": "2.2.2.2",
        "status": "Full/DR",
        "neighborAddress": "99.99.99.99",
        "port": "Vlan200"
        "upTime": "05:10"
      }
    ],
    "terminalHistory": {
      "reload": "at 15:01:26 JST Tue Jul 17 2018", 
      "lastConfigChange": "at 17:15:13 JST Wed Jul 16 2018"
    }
  }
}

Traffic取得(5分単位)

端末のTraffic情報(5分単位の平均値)を取得するAPIです。

GET /v1/sdns/contracts/{contractId}/gateways/{gwId}/terminals/{terminalId}/traffics

Request Parameters

Name Description Type Mandatory Remarks
contractId サービス契約ID string yes 15桁の数字
gwId 端末に紐づくGWのID string yes T+10桁の数字
terminalId 端末ID string yes D+10桁の数字
port 指定したportの情報を取得 string yes #1
from 指定した時刻以降の情報を取得 string yes iso8601形式のJST時間 #2 #3 #4
to 指定した時刻以前の情報を取得 string yes iso8601形式のJST時間 #2 #3 #4
  • #1 wan1(VPN)またはwan2(Internet)を指定
  • #2 例 2017-04-01T00:00:00
  • #3 現在時刻より93日より前の情報は取得できない
  • #4 fromtoの差は24時間以内でなければならない

Example Request

GET /v1/sdns/contracts/999999999999999/gateways/T9999999999/terminals/D9999999999/traffics?port=wan1&from=2017-04-01T00:00:00&to=2017-04-01T23:59:59

Response Code

Code Description
200 成功
400 parameterの型不正
404 指定されたID、もしくはIDの組合せが存在しない

Response Parameters

Name Description Type Mandatory Remarks
time 取得時刻 string no iso8601形式のJST時間 #2 #5
avgInTraffic ポートに対する受信側の平均トラフィック量(bps) number no 小数点以下2桁まで
avgOutTraffic ポートに対する送信側の平均トラフィック量(bps) number no 小数点以下2桁まで
  • #5 Traffic情報は、5分間隔で取得、蓄積される

Example Result

[
    {
        "time": "2017-04-01T17:00:00+09:00",
        "avgInTraffic": 60395.52,
        "avgOutTraffic": 60012.45
    },
    {
        "time": "2017-04-01T17:05:00+09:00",
        "avgInTraffic": 59172.83,
        "avgOutTraffic": 58777.38
    },
    {
        "time": "2017-04-01T17:10:00+09:00",
        "avgInTraffic": 59387.12,
        "avgOutTraffic": 59001.46
    },
    {
        "time": "2017-04-01T17:55:00+09:00",
        "avgInTraffic": 59186.41,
        "avgOutTraffic": 58802.07
    }
]

Traffic取得(1日単位)

端末のTraffic情報(1日単位の最小/最大/平均値)を取得するAPIです。

GET /v1/sdns/contracts/{contractId}/gateways/{gwId}/terminals/{terminalId}/traffic_stats

Request Parameters

Name Description Type Mandatory Remarks
contractId サービス契約ID string yes 15桁の数字
gwId 端末に紐づくGWのID string yes T+10桁の数字
terminalId 端末ID string yes D+10桁の数字
port 指定したportの情報を取得 string yes #1
from 指定した時刻以降の情報を取得 string yes iso8601形式のJST時間 #2 #3 #4
to 指定した時刻以前の情報を取得 string yes iso8601形式のJST時間 #2 #3 #4
  • #1 wan1(VPN)またはwan2(Internet)を指定
  • #2 例 2017-04-01T00:00:00
  • #3 現在時刻より365日より前の情報は取得できない
  • #4 fromtoの差は31日以内でなければならない

Example Request

GET /v1/sdns/contracts/999999999999999/gateways/T9999999999/terminals/D9999999999/traffic_stats?port=wan1&from=2017-04-01T00:00:00&to=2017-04-02T23:59:59

Response Code

Code Description
200 成功
400 parameterの型不正
404 指定されたID、もしくはIDの組合せが存在しない

Response Parameters

Name Description Type Mandatory Remarks
time 取得時刻 string no iso8601形式のJST時間 #2 #5
avgInTraffic ポートに対する受信側の1日の平均トラフィック量(bps) string no 小数点以下2桁まで
avgOutTraffic ポートに対する送信側の1日の平均トラフィック量(bps) string no 小数点以下2桁まで
maxInTraffic ポートに対する受信側の1日の最大トラフィック量(bps) string no 小数点以下2桁まで
maxOutTraffic ポートに対する送信側の1日の最大トラフィック量(bps) string no 小数点以下2桁まで
minInTraffic ポートに対する受信側の1日の最小トラフィック量(bps) string no 小数点以下2桁まで
minOutTraffic ポートに対する送信側の1日の最小トラフィック量(bps) string no 小数点以下2桁まで
  • #5 Traffic情報は、1日間隔で取得、蓄積される

Example Result

[
    {
        "minOutTraffic": 57980.53,
        "minInTraffic": 58399.63,
        "maxOutTraffic": 60044.90,
        "time": "2017-04-01T00:00:00+09:00",
        "avgInTraffic": 59388.97,
        "avgOutTraffic": 59007.98,
        "maxInTraffic": 60416.48
    },
    {
        "minOutTraffic": 58169.73,
        "minInTraffic": 58583.57,
        "maxOutTraffic": 60232.32,
        "time": "2017-04-01T00:00:00+09:00",
        "avgInTraffic": 59386.01,
        "avgOutTraffic": 59003.89,
        "maxInTraffic": 60604.84
    },
    {
        "minOutTraffic": 57979.57,
        "minInTraffic": 58362.82,
        "maxOutTraffic": 60251.95,
        "time": "2017-04-01T00:00:00+09:00",
        "avgInTraffic": 59387.13,
        "avgOutTraffic": 59005.47,
        "maxInTraffic": 60647.14
    },
    {
        "minOutTraffic": 58166.31,
        "minInTraffic": 58550.92,
        "maxOutTraffic": 65765.11,
        "time": "2017-04-01T00:00:00+09:00",
        "avgInTraffic": 59399.24,
        "avgOutTraffic": 59027.96,
        "maxInTraffic": 62957.16
    }
]

Error取得(5分単位)

端末のError情報(5分単位の平均値)を取得するAPIです。

GET /v1/sdns/contracts/{contractId}/gateways/{gwId}/terminals/{terminalId}/error_packets

Request Parameters

Name Description Type Mandatory Remarks
contractId サービス契約ID string yes 15桁の数字
gwId 端末に紐づくGWのID string yes T+10桁の数字
terminalId 端末ID string yes D+10桁の数字
port 指定したportの情報を取得 string yes #1
from 指定した時刻以降の情報を取得 string yes iso8601形式のJST時間 #2 #3 #4
to 指定した時刻以前の情報を取得 string yes iso8601形式のJST時間 #2 #3 #4
  • #1 wan1(VPN)またはwan2(Internet)を指定
  • #2 例 2017-04-01T00:00:00
  • #3 現在時刻より93日より前の情報は取得できない
  • #4 fromtoの差は31日以内でなければならない

Example Request

GET /v1/sdns/contracts/999999999999999/gateways/T9999999999/terminals/D9999999999/error_packets?port=wan1&from=2017-04-01T00:00:00&to=2017-04-01T23:59:59

Response Code

Code Description
200 成功
400 parameterの型不正
404 指定されたID、もしくはIDの組合せが存在しない

Response Parameters

Name Description Type Mandatory Remarks
time 取得時刻 string no iso8601形式のJST時間 #2 #5
avgInDiscard ポートに対する受信側のディスカードパケット数の平均値(pps) number no 小数点以下2桁まで
avgOutDiscard ポートに対する送信側のディスカードパケット数の平均値(pps) number no 小数点以下2桁まで
avgInError ポートに対する受信側のエラーパケット数の平均値(pps) number no 小数点以下2桁まで
avgOutError ポートに対する送信側のエラーパケット数の平均値(pps) number no 小数点以下2桁まで
  • #5 Error情報は5分間隔で取得、蓄積される

Example Result

[
    {
        "avgInDiscard": 1,
        "avgOutDiscard": 48,
        "avgInError": 5,
        "avgOutError": 2,
        "time": "2017-04-01T00:00:00+09:00"
    },
    {
        "avgInDiscard": 10,
        "avgOutDiscard": 34,
        "avgInError": 15,
        "avgOutError": 7,
        "time": "2017-04-01T00:05:00+09:00"
    },
    {
        "avgInDiscard": 20,
        "avgOutDiscard": 9,
        "avgInError": 35,
        "avgOutError": 10,
        "time": "2017-04-01T00:10:00+09:00"
    }
]

Error取得(1日単位)

端末のError情報(1日単位の最小/最大/平均値)を取得するAPIです。

GET /v1/sdns/contracts/{contractId}/gateways/{gwId}/terminals/{terminalId}/error_packet_stats

Request Parameters

Name Description Type Mandatory Remarks
contractId サービス契約ID string yes 15桁の数字
gwId 端末に紐づくGWのID string yes T+10桁の数字
terminalId 端末ID string yes D+10桁の数字
port 指定したportの情報を取得 string yes #1
from 指定した時刻以降の情報を取得 string yes iso8601形式のJST時間 #2 #3 #4
to 指定した時刻以前の情報を取得 string yes iso8601形式のJST時間 #2 #3 #4
  • #1 wan1(VPN)またはwan2(Internet)を指定
  • #2 例 2017-04-01T00:00:00
  • #3 現在時刻より365日より前の情報は取得できない
  • #4 fromtoの差は31日以内でなければならない

Example Request

GET /v1/sdns/contracts/999999999999999/gateways/T9999999999/terminals/D9999999999/error_packet_stats?port=wan1&from=2017-04-01T00:00:00&to=2017-04-02T23:59:59

Response Code

Code Description
200 成功
400 parameterの型不正
404 指定されたID、もしくはIDの組合せが存在しない

Response Parameters

Name Description Type Mandatory Remarks
time 取得時刻 string no iso8601形式のJST時間 #2 #5
avgInDiscard ポートに対する受信側のディスカードパケット数の平均値(pps) number no 小数点以下2桁まで
avgOutDiscard ポートに対する送信側のディスカードパケット数の平均値(pps) number no 小数点以下2桁まで
avgInError ポートに対する受信側のエラーパケット数の平均値(pps) number no 小数点以下2桁まで
avgOutError ポートに対する送信側のエラーパケット数の平均値(pps) number no 小数点以下2桁まで
maxInDiscard ポートに対する受信側のディスカード
パケット数の最大値(pps)
number no 小数点以下2桁まで
maxOutDiscard ポートに対する送信側のディスカードパケット数の最大値(pps) number no 小数点以下2桁まで
maxInError ポートに対する受信側のエラーパケット数の最大値(pps) number no 小数点以下2桁まで
maxOutError ポートに対する送信側のエラーパケット数の最大値(pps) number no 小数点以下2桁まで
minInDiscard ポートに対する受信側のディスカードパケット数の最小値(pps) number no 小数点以下2桁まで
minOutDiscard ポートに対する送信側のディスカードパケット数の最小値(pps) number no 小数点以下2桁まで
minInError ポートに対する受信側のエラーパケット数の最小値(pps) number no 小数点以下2桁まで
minOutError ポートに対する送信側のエラーパケット数の最小値(pps) number no 小数点以下2桁まで
  • #5 Error情報は、1日間隔で取得、蓄積される

Example Result

[
    {
        "minInDiscard": 0,
        "minOutDiscard": 0,
        "maxOutDiscard": 0.03,
        "maxOutError": 0,
        "avgInDiscard": 0.01,
        "avgOutDiscard": 0.0,
        "avgInError": 0.01,
        "maxInError": 0.03,
        "maxInDiscard": 0.03,
        "minInError": 0,
        "time": "2017-04-01T00:00:00+09:00",
        "avgOutError": 0,
        "minOutError": 0
    },
    {
        "minInDiscard": 5,
        "minOutDiscard": 0,
        "maxOutDiscard": 88,
        "maxOutError": 74,
        "avgInDiscard": 31,
        "avgOutDiscard": 2,
        "avgInError": 34,
        "maxInError": 79,
        "maxInDiscard": 13,
        "minInError": 11,
        "time": "2017-04-01T00:00:00+09:00",
        "avgOutError": 12,
        "minOutError": 3
    }
]

アプリケーション取得(5分単位)

端末のアプリケーション情報(5分単位の平均値)を取得するAPIです。

GET /v1/sdns/contracts/{contractId}/gateways/{gwId}/terminals/{terminalId}/accumulated_flows

Request Parameters

Name Description Type Mandatory Remarks
contractId サービス契約ID string yes 15桁の数字
gwId 端末に紐づくGWのID string yes T+10桁の数字
terminalId 端末ID string yes D+10桁の数字
unit フローの集計単位を指定 string yes #7
direction IN/OUT string yes
port 指定したportの情報を取得 string yes #1
from 指定した時刻以降の情報を取得 string yes iso8601形式のJST時間 #2 #3 #4
to 指定した時刻以前の情報を取得 string yes iso8601形式のJST時間 #2 #3 #4
tos 指定したtosの情報を取得 string no #5
src_ip_addr 送信元IPアドレスを指定 string no
src_ip_mask 送信元サブネットマスク指定 string no
dst_ip_addr 宛先IPアドレスを指定 string no
dst_ip_mask 宛先サブネットマスク指定 string no
dst_port 宛先ポート番号を指定 string no
protocol プロトコルを指定 string no #6
application_id アプリケーションIDを指定 string no
  • #1 "tunnel1","tunnel2","wan2","ppp2"指定
  • #2 例 2017-04-01T00:00:00
  • #3 現在時刻より93日より前の情報は取得できない
  • #4 fromtoの差は31日以内でなければならない
  • #5 複数指定可能。指定可能なToS値は-1(ToS値なし)、0-7(6を除く)
  • #6 複数指定可能、指定可能なプロトコルはtcp,udp,icmp
  • #7 bit(ビット数),packet(パケット数),count(個数)

Example Request

GET /v1/sdns/contracts/999999999999999/gateways/T9999999999/terminals/D9999999999/accumulated_flows?unit=bit&direction=IN&port=wan1&from=2017-04-01T00:00:00&to=2017-04-01T23:59:59

Response Code

Code Description
200 成功
400 parameterの型不正
404 指定されたID、もしくはIDの組合せが存在しない

Response Parameters

Name Description Type Mandatory Remarks
time 取得時刻 string no iso8601形式のJST時間 #1 #2
avgBit フローの平均ビット数(bps) number no 小数点以下2桁まで
avgPacket フローの平均パケット数(pps) number no 小数点以下2桁まで
count フローの個数 number no
  • #1 例 2017-04-01T00:00:00
  • #2 情報は5分間隔で取得、蓄積される

Example Result

[
    {
        "time": "2017-04-01T00:00:00+09:00"
        "avgBit": 100.12
    },
    {
        "time": "2017-04-01T00:05:00+09:00"
        "avgBit": 0 
    },
    {
        "time": "2017-04-01T00:10:00+09:00"
        "avgBit": 200.34
    }
]

Traffic詳細取得

端末のTraffic情報を詳細条件を指定し取得します

GET /v1/sdns/contracts/{contractId}/gateways/{gwId}/terminals/{terminalId}/flows

Request Parameters

Name Description Type Mandatory Remarks
contractId サービス契約ID string yes 15桁の数字
gwId GW ID string yes T+10桁の数字
terminalId 端末ID string yes D+10桁の数字
direction in/out string yes
port インターフェイス指定 string no #1
from 開始時間 string no #2
to 終了時間 string no #2
dscp dscp値 string no #3
src_ip_addr 送信元IPアドレス string no
dst_ip_addr 宛先IPアドレス string no
src_ip_mask 送信元サブネットマスク string no
dst_ip_mask 宛先サブネットマスク string no
src_port 送信元ポート番号 string no
dst_port 宛先ポート番号 string no
protocol プロトコル string no #4
application_id アプリケーションID string no
application_name アプリケーション名 string no
limit 取得件数 number no #5 整数
continue tokenを指定 string no
  • #1 "tunnel1""tunnel2""wan2""ppp2"から指定
  • #2 iso8601形式のJST時間で指定"YYYY-MM-DDT00:00:00+09:00"
  • #3 8,16等
  • #4 "tcp""udp""icmp"にて指定
  • #5 上限は5000

Example Request

GET /v1/sdns/contracts/999999999999999/gateways/T9999999999/terminals/D9999999999/flows?direction=in

Response Code

Code Description
200 成功
400 parameterの型不正
404 指定されたID、もしくはIDの組合せが存在しない

Response Parameters

Name Description Type Mandatory Remarks
srcIpAddr 送信元IPアドレス string no
terminalId アプリケーション名 string no
applicationId アプリケーションID string no
packets パケット数 string no
srcPort 送信元ポート番号 string no
protocol プロトコル string no
dscp dscp値 string no
port Interface string no
dstIpAddr あて先IPアドレス string no
bytes バイト数 string no
dstPort 送信元ポート番号 string no
time 時間 string no
customerId お客様ID string no
networkDelaySample delayのサンプリング数 string no
networkDelaySum サンプリングの合計 string no
tos ToS値 string no
direction in/out string no

Example Result

    [
      {
        "srcIpAddr": "192.168.1.1",
        "terminaId": "D0000000005",
        "applicationId": "1:104"
        "packets": "10",
        "srcPort": "8111",
        "protocol": "6",
        "dscp": "0",
        "port": "tunnel1",
        "dstIpAddr": "10.146.1.11",
        "bytes": "495",
        "dstPort": "8211",
        "time": "2017-07-31T23:55:00+09:00",
        "customerId": "C0250124868",
        "networkDelaySample": "0",
        "networkDelaySum": "0",
        "tos": "-1",
        "direction": "in",
        "token": "MTUzMDQ1NzIwMDAwMAlkZWZhdWx0I0FXUldXZDFOMHdQTmhOY2hZT2to",
      },
      {
        :
      }
    ]

アプリケーションリスト取得

アプリケーションのリストを取得します。

GET /v1/sdns/contracts/{contractId}/applications

Request Parameters

Name Description Type Mandatory Remarks
contractId サービス契約ID string yes 15桁の数字

Example Request

GET /v1/sdnscontracts/99999999999999/applications

Response Code

Code Description
200 成功
400 parameterの型不正
404 指定されたID、もしくはIDの組合せが存在しない

Response Parameters

Name Description Type Mandatory Remarks
applicationId アプリケーションID string no
applicationName アプリケーション名 string no
description 説明 string no

Example Result

[
  {
    "applicationId":          "1:34",
    "applicationName":        "gmail",
    "description":            "Third Party Connect Protocol"
  },
  {
    "applicationId":          "1:107",
    "applicationName":        "an",
    "description":            "Active Networks"
  },
  {
    "applicationId":          "1:61",
    "applicationName":        "any-host-internal",
    "description":            "any host internal protocol"
  },
  {
   :
  },
  {
    "applicationId":          "13:751",
    "applicationName":        "zulily",
    "description":            "Zulily - Online shopping aimed for Moms apparel and hom"
  }
]

Trafficランキング取得

指定された条件のTraffic量のランキングを取得します。

GET /v1/sdns/contracts/{contractId}/gateways/{gwId}/terminals/{terminalId}/rankings

Request Parameters

Name Description Type Mandatory Remarks
contractId サービス契約ID string yes 15桁の数字
gwId GW ID string yes T+10桁の数字
terminalId 端末ID string yes D+10桁の数字
direction traffic方向 string yes #1
property 条件指定 string yes #2
port インターフェイス指定 string no #3
from 開始時間 string no #4
to 終了時間 string no #4
tos tos値 string no #5
src_ip_addr 送信元IPアドレス string no
dst_ip_addr 宛先IPアドレス string no
src_port 送信元ポート番号 string no
dst_port 宛先ポート番号 string no
protocol プロトコル string no #6
application_id アプリケーションID string no #7
application_name アプリケーション名 string no #8
size ランキング数 string no #9
  • #1 受信情報"in"か送信情報"out"を指定
  • #2 送信元IPv4アドレス"src_ip_addr"、宛先IPv4アドレス"dst_ip_addr"、アプリケーションID"application_id"、アプリケーション名"application_name"、送信元ポート番号"src_port"、宛先ポート番号"dst_port"、ToS値"tos"
  • #3 "tunnel1"、"tunnel2"、"wan2"、"ppp2"から指定
  • #4 iso8601形式のJST時間で指定"YYYY-MM-DDT00:00:00+09:00"
  • #5 tosなしの場合は-1を指定、0-7より指定
  • #6 "tcp""udp""icmp"より指定
  • #7 trafficを取得したいアプリケーションのIDを指定
  • #8 trafficを取得したいアプリケーション名を指定
  • #9 取得したいランキング数を1-100にて指定

Example Request

GET /v1/sdns/contracts/999999999999999/gateways/T9999999999/terminals/D9999999999/rankings?direction=in&property=src_ip_addr&src_ip_addr=99.99.99.99&size=10

Response Code

Code Description
200 成功
400 parameterの型不正
404 指定されたID、もしくはIDの組合せが存在しない

Response Parameters

Name Description Type Mandatory Remarks
srcIpAddr 送信元IPアドレス string no
rankings ランキング string no
description 説明 string no

Example Result

[
  {
    "srcIpAddr": "99.99.99.99",
    "ranking":   1
  },
  {
    "srcIpAddr": "99.99.99.99",
    "ranking":   2
  },
  {
    "srcIpAddr": "99.99.99.99",
    "ranking":   3
  },
  {
    : 
  },
  {
    "srcIpAddr":  "99.99.99.99",
    "ranking":    10
  }
]

遅延値詳細取得

端末の遅延値詳細を取得します。

GET /v1/sdns/contracts/{contractId}/gateways/{gwId}/terminals/{terminalId}/rtt

Request Parameters

Name Description Type Mandatory Remarks
contractId サービス契約ID string yes 15桁の数字
gwId GW ID string yes T+10桁の数字
terminalId 端末ID string yes D+10桁の数字
from 開始時間 string no #1
to 終了時間 string no #1
src_ip_addr 送信元IPアドレス string no
dst_ip_addr 宛先IPアドレス string no
src_ip_mask 送信元サブネットマスク string no
dst_ip_mask 宛先サブネットマスク string no
src_port 送信元ポート番号 string no
dst_port 宛先ポート番号 string no
application_id アプリケーションID string no #2
  • #1 iso8601形式のJST時間で指定"YYYY-MM-DDT00:00:00+09:00"
  • #2 trafficを取得したいアプリケーションのIDを指定

Example Request

GET /v1/sdns/contracts/999999999999999/gateways/T9999999999/terminals/D9999999999/rtt?from=2017-04-01T00:00:00&to=2017-04-01T23:59:59

Response Code

Code Description
200 成功
400 parameterの型不正
404 指定されたID、もしくはIDの組合せが存在しない

Response Parameters

Name Description Type Mandatory Remarks
avgApplicationDelay サーバアプリの平均応答時間 string no
avgServerNetworkDelay ルータ~サーバの平均通信時間 string no
avgClientNetworkDelay クライアント~ルータの平均通信時間 string no

Example Result

{
  "avgApplicationDelay": 5,
  "avgServerNetworkDelay": 5,
  "avgClientNetworkDelay": 5
}

通信品質取得

端末の遅延、ジッタ、パケロス値を取得します。

GET /v1/sdns/contracts/{contractId}/gateways/{gwId}/terminals/{terminalId}/qualities

Request Parameters

Name Description Type Mandatory Remarks
contractId サービス契約ID string yes 15桁の数字
gwId GW ID string yes T+10桁の数字
terminalId 端末ID string yes D+10桁の数字
port インターフェイス指定 string no #1
from 開始時間 string no #2
to 終了時間 string no #2
interval_min 集計間隔を指定 string no #3
  • #1 "tunnel1"、"tunnel2"から指定
  • #2 iso8601形式のJST時間で指定"YYYY-MM-DDT00:00:00+09:00"
  • #3 集計する間隔を分単位で指定

Example Request

GET /v1/sdns/contracts/999999999999999/gateways/T9999999999/terminals/D9999999999/qualities?port=tunnel1&from=2017-04-01T00:00:00&to=2017-04-01T23:59:59

Response Code

Code Description
200 成功
400 parameterの型不正
404 指定されたID、もしくはIDの組合せが存在しない

Response Parameters

Name Description Type Mandatory Remarks
time 取得時間 string no
networkDelayPerPacket 遅延値 string no
packetsLostRate パケットロス値 string no
rtpJitterMean jitter string no

Example Result

  [
    {
      "time": "2017-07-31T23:55:00+09:00",
      "networkDelayPerPacket": 5,
      "packetsLostRate": 5,
      "rtpJitterMean": 5
    },
    {
      :
    }
  ]

マルチパス切替り情報取得

マルチパスの切替り情報を取得します。

GET /v1/sdns/contracts/{contractId}/routing_event

Request Parameters

Name Description Type Mandatory Remarks
contractId サービス契約ID string yes 15桁の数字
from 開始時間 string no #1
to 終了時間 string no #1
  • #1 iso8601形式のJST時間で指定"YYYY-MM-DDT00:00:00+09:00"

Example Request

GET /v1/sdns/contracts/999999999999999/routing_event?from=2017-04-01T00:00:00&to=2017-04-01T23:59:59

Response Code

Code Description
200 成功
400 parameterの型不正
404 指定されたID、もしくはIDの組合せが存在しない

Response Parameters

Name Description Type Mandatory Remarks
time 発生時間 string no
terminalId 端末ID string no
reason 切替り理由 string no
originalIf 切替り前のパス string no
newIf 切替り後のパス string no
flow 通信フロー string no
applicationId アプリケーションID string no
applicatioName アプリケーション名 string no
tos Tos値 string no

Example Result

[
  {
    "time": "2017-04-01T00:00:00+09:00",
    "deviceId": "D0000000001",
    "reason": "delay",
    "originlIf": "tunnel1",
    "newIf": "tunnel2",
    "flow": [
      {
        "applicationId": "1:88",
        "applicationName": "eigrp", 
        "tos": 1
      },
      {
        "applicationId": "3:355",
        "applicationName": "datex-asn", 
        "tos": 0
      }
    ]
  }
]

相互接続申込

相互接続申込を行います。

POST /v1/sdns/contracts/{contractId}/gateways/{gwId}/interconnections

Request Parameters

Name Description Type Mandatory Remarks
contractId サービス契約ID string yes 15桁の数字
gwId GW ID string yes T+10桁の数字
Name Description Type Mandatory Remarks
connectionParameters 相互接続契約内容 object yes
   vpnNo VPN番号 string yes V+8桁の数字
   representativeNNo 代表N番 string yes N+9桁の数字
   name 識別名 string yes
   remarks 備考 string yes
   bandwidth 帯域 string yes #1
  • #1 "100"か"1000"からGW申込時と同様の帯域を指定

Example Request

POST /v1/sdns/contracts/{contractId}/gateways/{gwId}/interconnections

{
    "connectionParameters": {
        "vpnNo": "V99999999",
        "representativeNNo": "N99999999",
        "name": "SD-NS_NW_xxxxxx",
        "remarks": "-"
        "bandwidth": "100"
    }

Response Code

Code Description
201 成功
400 parameterの型不正
404 指定されたID、もしくはIDの組合せが存在しない

Response Parameters

Name Description Type Mandatory Remarks
interconnectionId 相互接続ID string yes U+10桁の数字
orderId Order ID string yes 10桁の数字

Example Result

{
"interconectionId":"U9999999999"
"orderId":"9999999999"
}

相互接続詳細取得

相互接続の情報を取得するAPIです。

GET /v1/sdns/contracts/{contractId}/gateways/{gwId}/interconnections/{interconnectionId}

Request Parameters

Name Description Type Mandatory Remarks
contractId サービス契約ID string yes 15桁の数字
gwId GW契約ID string yes T+10桁の数字
interconnectionId 相互接続ID string yes U+10桁の数字

Example Request

GET /v1/sdns/contracts/999999999999999/gateways/T9999999999/interconnections/U9999999999

Response Code

Code Description
200 成功
400 parameterの型不正
404 指定されたID、もしくはIDの組合せが存在しない

Response Parameters

Name Description Type Mandatory Remarks
connectionParameters 相互接続契約内容 object yes
   name 識別名 string yes
   vpnNo VPN番号 string yes V+8桁の数字
   representativeNNo 代表N番 string yes N+9桁の数字
   multiCloudConnectNNo マルチクラウドN番号 string yes N+9桁の数字
   remarks 備考 string yes
   orderStatus 相互接続のオーダー状況 string yes #1
   bandwidth 帯域 string yes
  • #1 Processing:変更中, Completed:完了, Error:エラー, Canceled:キャンセル

Example Result

{
            "connectionParameters":{
                "vpnNo":"V99999999",
                "representativeNNo":"N999999999",
                "multiCloudConnectNNo":"N99999999",
                "name":"xxxxx",
                "remarks":"xxxxx",
                "bandwidth":"100",
                "orderStatus": "Processing", 
            },

相互接続一覧取得

相互接続の情報一覧を取得するAPIです。

GET /v1/sdns/contracts/{contractId}/gateways/{gwId}/interconnections

Request Parameters

Name Description Type Mandatory Remarks
contractId サービス契約ID string yes 15桁の数字
gwId GW契約ID string yes T+10桁の数字

Example Request

GET /v1/sdns/contracts/999999999999999/gateways/T9999999999/interconnections

Response Code

Code Description
200 成功
400 parameterの型不正
404 指定されたID、もしくはIDの組合せが存在しない

Response Parameters

Name Description Type Mandatory Remarks
gwId GW契約ID string yes T+10桁の数字
interconnections 契約中の相互接続一覧 array yes
   connectionParameters 相互接続契約内容 object yes
   interconnectionId 相互接続ID object yes U+10桁の数字
      name 識別名 string yes
      vpnNo VPN番号 string yes V+8桁の数字
      representativeNNo 代表N番 string yes N+9桁の数字
      multiCloudConnectNNo マルチクラウドN番号 string yes N+9桁の数字
      remarks 備考 string yes
      orderStatus 相互接続のオーダー状況 string yes #1
      bandwidth 帯域 string yes
  • #1 Processing:変更中, Completed:完了, Error:エラー, Canceled:キャンセル

Example Result

{
    "gwId": "T9999999999", 
    "interconnections": [
        {
            "interconnectionId": "U9999999999", 
            "connectionParameters": {
                "name": "SD-NS-NWxxxxxx", 
                "vpnNo": "V9999999"
                "representativeNNo": "N999999999", 
                "multiCloudConnectNNo": "N999999999", 
                "remarks": "memoxxxxxx", 
                "orderStatus": "Completed", 
                "bandwidth": "100", 
            }
        }
   ]
}

相互接続設定変更

相互接続の設定変更を行います。

PUT /v1/sdns/contracts/{contractId}/gateways/{gwId}/interconnections/{interconnectionId}

Request Parameters

Name Description Type Mandatory Remarks
contractId サービス契約ID string yes 15桁の数字
gwId GW ID string no T+10桁の数字
interconnectionId 相互接続ID string yes U+10桁の数字
Name Description Type Mandatory Remarks
connectionParameters 相互接続契約内容 object yes
   vpnNo VPN番号 string yes V+8桁の数字 #1
   multiCloudConnectNNo マルチクラウドN番号 string yes N+9桁の数字 #1
   representativeNNo 代表N番 string yes N+9桁の数字 #1
   name 識別名 string yes
   remarks 備考 string yes
   orderStatus 相互接続のオーダー状況 string yes #1
   bandwidth 帯域 string yes #1
  • #1 変更不可項目

Example Request

PUT /v1/sdns/contracts/999999999999999/gateways/T9999999999/interconnections/U9999999999

{
    "connectionParameters": {
        "vpnNo": "V99999999",
        "multiCloudConnectNNo":"N999999999"
        "representativeNNo": "N999999999",
        "name": "SD-NS_NW_xxxxxx",
        "remarks": "-"
        "orderStatus": "Processing"
        "bandwidth": "100"
    }
}

Response Code

Code Description
202 成功
400 parameterの型不正
404 指定されたID、もしくはIDの組合せが存在しない

Response Parameters

Name Description Type Mandatory Remarks
orderId Order ID string yes 10桁の数字

Example Result

{
    "orderId": "9999999999"
}

相互接続廃止申込

相互接続の廃止申込を行います。

DELETE /v1/sdns/contracts/{contractId}/gateways/{gwId}/interconnections/{interconnectionId}

Request Parameters

Name Description Type Mandatory Remarks
contractId サービス契約ID string yes 15桁の数字
gwId 端末に紐づくGWのID string yes T+10桁の数字
interconnectionId 相互接続ID string yes U+10桁の数字

Example Request

DELETE /v1/sdns/contracts/999999999999999/gateways/T9999999999/interconnections/U9999999999

Response Code

Code Description
202 成功
400 parameterの型不正
404 指定されたID、もしくはIDの組合せが存在しない

Response Parameters

Name Description Type Mandatory Remarks
orderId Order ID string yes 10桁の数字

Example Result

{
    "orderId": "9999999999"
}

マネージドオプション申込

マネージドオプションの申込を行います。

POST /v1/sdns/contracts/{contractId}/managed_options

Request Parameters

Name Description Type Mandatory Remarks
contractId サービス契約ID string yes 15桁の数字
Name Description Type Mandatory Remarks
name マネージドオプション名 string yes #1
projectId 案件ID string yes MG+8桁の数字
serviceStartRequestedDate サービス提供開始希望日 string yes #2
  • #1 運用管理"Operation Management"、リアクションプラン"Reaction Plan"、設計"Initial Settings"、デリバリ管理"Delivery Management"、設定変更作業代行"Config by Agent"より指定
  • #2 "YYYY-MM-DD"にて指定

Example Request

POST /v1/sdns/contracts/99999999999999/managed_options

{
    "name": "Delivery Management",
    "projectId": "MGxxxxxx",
    "serviceStartRequestedDate": "YYYY-MM-DD",
}

Response Code

Code Description
201 成功
400 parameterの型不正
404 指定されたID、もしくはIDの組合せが存在しない

Response Parameters

Name Description Type Mandatory Remarks
managedOptionId マネージドオプションID string yes M+10桁の数字
orderId Order ID string yes 10桁の数字

Example Result

{
   "managedOptionId":"M9999999999"
   "orderId": "9999999999"
}

マネージドオプション一覧取得

マネージドオプションの情報一覧を取得するAPIです。

GET /v1/sdns/contracts/{contractId}/managed_options

Request Parameters

Name Description Type Mandatory Remarks
contractId サービス契約ID string yes 15桁の数字

Example Request

GET /v1/sdns/contracts/999999999999999/managed_options

Response Code

Code Description
200 成功
400 parameterの型不正
404 指定されたID、もしくはIDの組合せが存在しない

Response Parameters

Name Description Type Mandatory Remarks
managedOptions マネージドオプション一覧 array yes
   serviceStartDate サービス開始日 string no
   name 識別名 string no
   projectId 案件ID string no MG+8桁の数字
   serviceStartRequestedDate サービス提供開始希望日 string no
   status マネージドオプションの申込状況 string no #1
  • #1 Processing:変更中, Completed:完了, Error;エラー, Canceled:キャンセル

Example Result

{
    "managedOptions": [
        {
            "serviceStartDate": "2017-04-01", 
            "name": "Operation Management", 
            "projectId": "MG99999999", 
            "serviceStartRequestedDate": "2017-04-01", 
            "status": "Completed", 
        }, 
        {
            "serviceStartDate": null, 
            "name": "Delivery Management", 
            "projectId": "MG99999999", 
            "serviceStartRequestedDate": "2017-04-01", 
            "status": "Processing", 
        }
    ]
}

マネージドオプション廃止

マネージドオプションの廃止申込を行います。

DELETE /v1/sdns/contracts/{contractId}/managed_options/{managedOptionId}

Request Parameters

Name Description Type Mandatory Remarks
contractId サービス契約ID string yes 15桁の数字
managedOptionId マネージドオプションID string yes M+10桁の数字

Example Request

DELETE /v1/sdns/contracts/999999999999999/managed_options/M9999999999

Response Code

Code Description
202 成功
400 parameterの型不正
404 指定されたID、もしくはIDの組合せが存在しない

Response Parameters

Name Description Type Mandatory Remarks
orderId Order ID string yes 10桁の数字

Example Result

{
    "orderId": "9999999999"
}

オーダー詳細取得

オーダーの詳細情報を取得するAPIです。

GET /v1/sdns/contracts/{contractId}/orders/{orderId}

Request Parameters

Name Description Type Mandatory Remarks
contractId サービス契約ID string yes 15桁の数字
orderId オーダーに紐づくID string yes 10桁の数字

Example Request

GET /v1/sdns/contracts/999999999999999/orders/999999999

Response Code

Code Description
200 成功
400 parameterの型不正
404 指定されたID、もしくはIDの組合せが存在しない

Response Parameters

Name Description Type Mandatory Remarks
acceptTime 受付日時 string yes iso8601形式のJST時間 #1
lastUpdateTime 完了日時 string yes iso8601形式のJST時間 #1
orderServiceType 種別 string yes #2
orderApplicationType 内容 string yes #3
  • #1 例 2017-04-01T00:00:00
  • #2 上記以外のResponse Parametersについては、orderServiceTypeで応答された値により、各APIのResponse Parametersを参照(Initial Subscription:基本契約情報取得API,Terminal:端末個別情報取得API,Gateway:GW個別情報取得API,Interconnection Option:相互接続一覧情報取得API,Managed Option:マネージドオプション一覧情報取得API)
  • #3 New:新規申込,Change:変更,Termination:廃止

Example Result

基本契約のオーダー情報を取得した場合のResultです。

{
  "acceptTime": "2017-04-01T00:00:00+09:00", 
  "lastUpdateTime": "2017-04-01T00:00:00+09:00", 
  "orderServiceType": "Initial Subscription",
  "orderApplicationType": "Change",
  "customerId": "C9999999999", 
  "contractor": {
        "sectionName": "xxxxxx部", 
        "staffName": "xxxxxx", 
        "contactTel": "9999-999-9999", 
        "email": "xxxxxx@xxx.xxx", 
        "zipCode": "9999999",
        "address": "東京都xxxxxx", 
        "buildingName": "xxxxxxビル" 
   },
    "name": "SD-NSxxxxxx", 
    "salesChannelCode": "999999",
    "remarks": "memoxxxxxx", 
    "billingAddress": {
        "equalContractor": true, 
        "corpName": "xxxxxx株式会社", 
        "corpNameKana": "xxxxxxカブシキガイシャ", 
        "sectionName": "xxxxxx部", 
        "staffName": "xxxxxx", 
        "contactTel": "9999-999-999", 
        "email": "xxxxxx@xxx.xxx", 
        "zipCode": "9999999",
        "address": "東京都xxxxxx", 
        "buildingName": "xxxxxxビル"
    }, 
    "technicalContactPerson": {
        "equalContractor": true, 
        "corpName": "xxxxxx株式会社", 
        "corpNameKana": "xxxxxxカブシキガイシャ", 
        "sectionName": "xxxxxx部", 
        "staffName": "xxxxxx", 
        "contactTel": "9999-999-999",
        "email": "xxxxxx@xxx.xxx"
    }, 
}

オーダー一覧取得

オーダーの情報一覧を取得するAPIです。

GET /v1/sdns/contracts/{contractId}/orders

Request Parameters

Name Description Type Mandatory Remarks
contractId サービス契約ID string yes 15桁の数字
sorting 応答順 string no #1
count 応答件数総数 number no #2 整数
offset 一件の応答あたりの件数 number no #2 整数
terget 絞り込むIDを指定 string no #3
status 絞り込むOrder Statusを指定 string no #4
name 絞り込む識別名を指定 string no
  • #1 昇順:asc,降順:desc
  • #2 応答を開始する番号を指定
    例)100個のオーダーを50個ずつ2回に別けて応答する場合は
    1回目 count:50,offset:0と指定 Result:1-50までのオーダーを応答
    2回目 count:50,offset:50と指定 Result:51-100までのオーダーを応答
  • #3 絞り込みたい契約ID、GW ID、相互接続ID、端末ID、マネージドオプションIDを指定
  • #4 絞り込みたいオーダーステータスを"Completed", "Processing", "Cancelled", "Canceling", "Error", "Preset_Error"から指定

Example Request

GET /v1/sdns/contracts/999999999999999/orders?sorting=asc&count=30&offset=0&target=D999999999&status=Completed&name=SD-NS-Terminalxxxxxx

Response Code

Code Description
200 成功
400 parameterの型不正、offsetの値に存在しているオーダー数より大きい数を指定した場合
404 指定されたID、もしくはIDの組合せが存在しない

Response Parameters

Name Description Type Mandatory Remarks
contractId サービス契約ID string yes 15桁の数字
orders オーダー一覧 array yes
   orderId オーダーID string no 10桁の数字
   acceptTime 受付日時 string no iso8601形式のJST時間 #1
   applicationType 内容 string no #2
   remarks 備考 string no
   lastUpdateTime 完了日時 string no iso8601形式のJST時間 #1
   serviceType 種別 string no #3
   status オーダーの状況 string no #4
   errorCode エラーコード string no
   errorMessage エラー理由 string no
   object 対象 string no
orderCount オーダー数 string yes
  • #1 例 2017-04-01T00:00:00
  • #2 New:新規申込, Change:変更, Termination:廃止
  • #3 Initial Subscription:基本契約, Terminal:端末, Gateway:GW, Interconnection Option:相互接続, Managed Option:マネージドオプション
  • #4 Processing:変更中, Completed:完了, Error;エラー, Canceled:キャンセル

Example Result

{
    "contractId": "999999999999999", 
    "orders": [
        {
            "orderId": "9999999999", 
            "acceptTime": "2017-04-02T00:00:00+09:00", 
            "applicationType": "Change", 
            "remarks": "memoxxxxxx", 
            "lastUpdateTime": "2017-04-02T00:00:00+09:00", 
            "serviceType": "Terminal", 
            "status": "Completed", 
            "object": "D9999999999",
            "name": "SD-NS-Terminalxxxxxxx"
        }
    ], 
    "orderCount": "99"
}

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