Software-Defined Network Service API

Overview

This page explains how-to-use "Software-Defined Network Service (SD-NS)" APIs.

SD-NS provides the following functions;

  • enabling you to connect easily to your cloud, Arcstar Universal One sites, various web services, etc
  • making your network more efficitently by using your MPLS and Internet circuits as Active-Active by connecting them to our terminal
  • offering integrated management environment with our Web portal and APIs

For further information about SD-NS, please check this page (Japanses only).
These APIs are available after SD-NS application procedure is completed.


API List

SD-NS APIs include as follows :

API Description Method
Contract informatin
Post basic contract Order a basic contract. POST
Get basic contract Return a basic contract information. GET
Put basic contract Update a basic contract information. PUT
Delete basic contract Terminate a basic contract. DELETE
Get contract items Returns a number of contracts for GW,interconnection options and terminals. GET
Get contract summary Returns a list and summary for a contracted items. GET
GW
Post GW Order for a GW. POST
Get GW details Returns the configuration for a specific GW. GET
Put GW Change configuration for a spsecific GW. PUT
Get GW list Returns a list and summary for a GW. GET
Delete GW Terminate a GW. DELETE
Terminal
Post terminal Order terminal. POST
Put terminal order change Change a terminal order. PUT
Put terminal order cancel Cancel of a terminal order. PUT
Get terminal detail Return the configuration change for a specific terminal. GET
Put terminal preconfiguration Preconfigure the terminal settings. PUT
Put terminal activation Activate of a terminal. PUT
Put terminal Change the configuration for a specific terminal. PUT
Put terminal (Route reflection of Office365) Reflect for the internet breakout. PUT
Put terminal (Application definition file Upddate) Update a terminal Application definition file terminal application definition file. PUT
Get terminal list Returns the list and summary for a terminal. GET
Delete terminal Terminate a terminal subscription. DELETE
Put terminal information registration Resigter a collection date and place after the terminal delition. PUT
Post terminal group Create for a terminal group. POST
Get terminal group list Returns the list and summary for a terminal group list. GET
Put terminal group Change the terminal group settings. PUT
Delete terminal group Delete the terminal group. DELETE
Get terminal monitoring status Return the terminal monitoring status(monitored/unmonitored). GET
Get Terminal monitoring status list Retrun the terminal monitoring status list. GET
Put terminal monitoring status Change the terminal monitoring status(monitored/unmonitored). PUT
Get terminal status Return the terminal status. GET
Get terminal status list Return the terminal status list. GET
Get terminal status detail Return the terminal status detail. GET
Statistics
Get traffic information (at 5 minutes intervals) Return the terminal traffic information (at 5 minutes intervals)
* Time and date can be specified.
GET
Get traffic information (at 1 day intervals) Return the terminal traffic information (minimum/maximum/average at 1 day intervals)
* Time and date can be specified.
GET
Get error information (at 5 minutes intervals) Return the terminal Error information (at 5 minutes intervals)
* Time and date can be specified.
GET
Get error information (at 1 day intervals) Return the terminal error information (minimum/maximum/average at
1 day intervals)
* Time and date can be specified.
GET
Get application information (at 5 minutes intervals) Return the terminal application information (at 5 minutes intervals)
* Time and date can be specified.
GET
Get traffic details Return the traffic details of terminal. GET
Get application list Return the application list. GET
Get traffic ranking Return the traffic ranking. GET |terminal information registration
Get terminal resource Return the terminal information such as CPU utilization. GET
Get latency Specifics Return the latency details GET
Get connection quality Return latency, Jitter, Packet loss Rate on terminal GET
Get multipath infomation Return a multipath information GET
Interconnection
Post interconnection Order for an interconnection option. POST
Get interconnection details Return the interconnection details. GET
Get interconnection list Return the interconnection option list. GET
Put interconnection Change settings for an interconnection option. PUT
Delete interconnection Terminate interconnection option. DELETE
Managed option
Post managed option Order for a maneged option. POST
Get managed option llist Return maneged option list.
※ Only monthly charge
GET
Delete managed option Terminate managed option DELETE
Order history
Get order Return the order detailes. GET
Get order list Return the order list. GET

Resource URL

Please use global common domain or individual region domain.
When using the global common domain, connect to the nearest API gateway according to the situation of the customer's place of use.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 is jp|us|uk
  • e.g. https://us.api.ntt.com/v1/sdns
  • Specifiable regions will be expanded in the future

Resource Information

Key Value
Request Format JSON
Response Format JSON
Authentication (OAuth) Yes

Post basic contract

Order a basic contract.

POST /v1/sdns/contracts

Request Parameters

Name Description Type Mandatory Remarks
contractor contractor name object yes
   zipCode ZIP code string yes
   address Address string yes
   buildingName Building Name string yes
   sectionName Depertment Name string yes
   staffName Contract Person string yes
   contactTel Phone Number string yes
   email E-mail string yes
salesChannelCode Sales Channel Code string no
name Name string yes
remarks Remarks string no
billingAddress Billing Address object yes
   zipCode ZIP Code string yes
   address Address string yes
   buildingName Building Name string yes
   corpName Company Name string yes
   corpNameKana Company Name(Kana) string yes
   sectionName Department Name string yes
   staffName Contact Person string yes
   contactTel Phone Number string yes
   email E-mail string yes
technicalContactPerson Technical Contact Person object yes
   corpName Company Name string yes
   corpNameKana Company Name(Kana) string yes
   sectionName Department Name string yes
   staffName Contact Person string yes
   contactTel Phone Number string yes
   email E-mail string yes
   corpName company name string yes

Example Request

POST /v1/sdns/contracts

{
    "contractor": {
        "zipCode": "9999999",
        "address": "xxxxxxTokyo",
        "buildingName": "xxxxxxbuilding",
        "sectionName": "xxxxxxdepartment",
        "staffName": "xxxxxx",
       "contactTel": "999-9999-9999",
        "email": "xxxxxx@xxx.xxx"
    },
    "salesChannelCode": "xxxxxx***",
    "name": "SD-NSxxxxxx",
    "remarks": "-",
    "billingAddress": {
        "zipCode": "9999999",
        "address": "xxxxxxTokyo",
        "buildingName": "xxxxxxbuilding",
        "corpName": "xxxxxx", 
        "corpNameKana": "xxxxxx",
        "sectionName": "xxxxxxdepartment",
        "staffName": "xxxxxx",
        "contactTel": "999-9999-9999",
        "emaill": "xxxxxx@xxx.xxx"
    },
    "technicalContactPerson": {
        "corpName": "xxxxxx", 
        "corpNameKana": "xxxxxx",
        "sectionName": "xxxxxxdepartment",
        "staffName": "xxxxxx",
        "contactTel": "999-9999-9999",
        "emaill": "xxxxxx@xxx.xxx"
    }
        "corpName": "xxxxxx"
  }

Response Code

Code Description
201 Success
400 Invalid type of parameter
404 Absent ID

Response Parameters

Name Description Type Mandatory Remarks
contractId Service contract ID string no 15 digit number
orderId Order ID string yes 10 digit number

Example Result

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

Get basic contract

Return a basic contract information.

GET /v1/sdns/contracts/{contractId}

Request Parameters

Name Description Type Mandatory Remarks
contractId Service Contract ID string yes 15 digit number

Example Request

GET /v1/sdns/contracts/999999999999999

Response Code

Code Description
200 Success
400 Invalid type of parameter
404 Absent ID

Response Parameters

Name Description Type Mandatory Remarks
customerId Customer Id string yes C+10 digit number
contractor Contractor object yes
   sectionName Department Name string yes
   staffName Contact Person string yes
   contactTel Phone Number string yes
   email E-mail string yes
   zipCode ZIP Code string yes
   address Address string yes
   buildingName Building Name string yes
name Name string yes
salesChannelCode Sales Channel Code string yes
remarks Remarks string yes
billingAddress Billing Address object yes
   equalContractor Sales channel code boolean yes
   corpName Company Name string yes
   corpNameKana Company Name(Kana) string yes
   sectionName Department Name string yes
   staffName Contact Person string yes
   contactTel Phone Number string yes
   email E-mail string yes
   zipCode ZIP Code string yes
   address Address string yes
   buildingName Building Name string yes
technicalContactPerson Technical Contact Person object yes
   equalContractor Same as contract address boolean yes
   corpName Company Name string yes
   corpNameKana Company Name(Kan) string yes
   sectionName Department Name string yes
   staffName Contact Person string yes
   contactTel Phone Number string yes
   email E-mail string yes
   corpName company name string yes

Example Result

{
    "customerId": "C9999999999", 
    "contractor": {
        "sectionName": "xxxxxxdepartment", 
        "staffName": "xxxxxx", 
        "contactTel": "9999-999-9999", 
        "email": "xxxxxx@xxx.xxx", 
        "zipCode": "9999999",
        "address": "xxxxxxTokyo", 
        "buildingName": "xxxxxxbuilding" 
    },
    "name": "SD-NSxxxxxx", 
    "salesChannelCode": "999999",
    "remarks": "memoxxxxxx",  
    "corpName": "xxxxxx",
    "billingAddress": {
        "equalContractor": true, 
        "corpName": "xxxxxx", 
        "corpNameKana": "xxxxxx", 
        "sectionName": "xxxxxxdepartment", 
        "staffName": "xxxxxx", 
        "contactTel": "9999-999-999", 
        "email": "xxxxxx@xxx.xxx", 
        "zipCode": "9999999",
        "address": "xxxxxxTokyo", 
        "buildingName": "xxxxxxbuilding"
    }, 
    "technicalContactPerson": {
        "equalContractor": true, 
        "corpName": "xxxxxx", 
        "corpNameKana": "xxxxxx", 
        "sectionName": "xxxxxxdepart", 
        "staffName": "xxxxxx", 
        "contactTel": "9999-999-999",
        "email": "xxxxxx@xxx.xxx"
    }, 
}

Put basic contract

Update a basic contract information.

PUT /v1/sdns/contracts/{contractId}

Request Parameters

Name Description Type Mandatory Remarks
contractId Contract ID string yes 15 digit number
Name Description Type Mandatory Remarks
contractor Contractor object yes
   zipCode ZIP Code string yes
   address Address string yes
   buildingName Building Name string yes
   sectionName Department Name string yes
   staffName Contact Person string yes
   contactTel Phone Number string yes
   email E-mail string yes
salesChannelCode Sales Channel Code string no
name Name string yes
remarks Remarks string no
billingAddress Billing Address object yes
   equalContractor Same as contract address boolean yes #1 #2
   zipCode ZIP Code string yes
   address Address string yes
   buildingName Building Name string yes
   corpName Company Name string yes
   corpNameKana Company Name(Kana) string yes
   sectionName Department Name string yes
   staffName Contact Person string yes
   contactTel Phone Number string yes
   email E-mail string yes
technicalContactPerson Technical Contact Person object yes
   equalContractor Same as contract address boolean yes #1 #2
   corpName Company Name string yes
   corpNameKana Company Name(Kana) string yes
   sectionName Department Name string yes
   staffName Contact Person string yes
   contactTel Phone Number string yes
   email E-mail string yes
   corpName company name string no #1
  • #1 Cannot be changed.
  • #2 Because of true / false is responded to the value of equalContractor when its order, choose “false”when its order, and responding as“false”when manually input the same information as Contractor.

Example Request

PUT /v1/sdns/contracts/99999999999999

{
    "contractor": {
        "zipCode": "9999999",
        "address": "xxxxxxTokyo", 
        "buildingName": "xxxxxxbuilding" 
        "sectionName": "xxxxxxdepartment", 
        "staffName": "xxxxxx", 
        "contactTel": "9999-999-9999", 
        "email": "xxxxxx@xxx.xxx", 
    },
    "name": "SD-NSxxxxxx", 
    "salesChannelCode": "999999",
    "remarks": "memoxxxxxx", 
    "billingAddress": {
        "equalContractor": true, 
        "corpName": "xxxxxxLtd.", 
        "corpNameKana": "xxxxxx", 
        "sectionName": "xxxxxxdepartment", 
        "staffName": "xxxxxx", 
        "contactTel": "9999-999-999", 
        "email": "xxxxxx@xxx.xxx", 
        "zipCode": "9999999",
        "address": "xxxxxxTokyo", 
        "buildingName": "xxxxxxbuilding"
   },
    "technicalContactPerson": {
        "equalContractor": true, 
        "corpName": "xxxxxxLtd.", 
        "corpNameKana": "xxxxxx", 
        "sectionName": "xxxxxxdepartment", 
        "staffName": "xxxxxx", 
        "contactTel": "9999-999-999",
        "email": "xxxxxx@xxx.xxx"
    }
}

Response Code

Code Description
202 Success
400 Invalid type of parameter
404 Absent ID

Response Parameters

Name Description Type Mandatory Remarks
orderId Order ID string yes 10 digit number

Example Result

{
  "orderId": "9999999999"
}

Delete basic contract

Terminate a basic contract.

DELETE /v1/sdns/contracts/{contractId}

Request Parameters

Name Description Type Mandatory Remarks
contractId Contract ID string yes 15 digit number

Example Request

DELETE /v1/sdns/contracts/999999999999999

Response Code

Code Description
200 Success
400 Invalid type of parameter
404 Absent ID

Response Parameters

Name Description Type Mandatory Remarks
orderId Order ID string no 10 digit number

Example Result

{
  "orderId": "9999999999"
}

Get contract items

Returns a number of contracts for GW,interconnection options and terminals.

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

Request Parameters

Name Description Type Mandatory Remarks
contractId Contract ID string yes 15 digit number

Example Request

GET /v1/sdns/contracts/999999999999999/counts

Response Code

Code Description
200 Success
400 Invalid type of parameter
404 Absent ID

Response Parameters

Name Description Type Mandatory Remarks
terminalCount Terminal Count number yes
contractId Contract ID string yes 15 digit number
gwCount GW Count number yes
interconnectionCount Interconnection Count number yes
managedOptionCount Managed Option Count number yes #1
  • #1 A number of contract for a exsting monthly subscription charged.

Example Result

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

Get contract summary

Returns a list and summary for a contracted items.

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

Request Parameters

Name Description Type Mandatory Remarks
contractId Service contract ID string yes 15 digit number

Example Request

GET /v1/sdns/contracts/999999999999999/summary

Response Code

Code Description
200 Success
400 Invalid type of parameter
404 Absent ID

Response Parameters

Interconnection options
Name Description Type Mandatory Remarks
interconnections Interconnections array yes
gwId GW ID string no T+10 digit number
name Name string no
vpnNo VPN number string no V+8 digit number
representativeNNo Representative N number string no N+9 digit number
multiCloudConnectNNo Multi-Cloud connect N number string no N+9 digit number
orderStatus Order status of interconnections string no Response #1
  • #1 Processing, Completed, Error, Cancellaion.
GW
Name Description Type Mandatory Remarks
gateways Gateways array yes
gwId GW ID string no T+10 digit number
orderStatus Order status of GW string no Response #2
name name string no
  • #2 Processing, Completion, Error, Cancellation.
Terminal
Name Description Type Mandatory Remarks
terminals Terminals array yes
gwId GW ID string no T+10 digit number
terminalId Terminal ID string no D+10 digit number #3
status Status string no Response #4
orderStatus Terminal order status string no Response #5
installRequestedDate Installation requested date string no yyyy-mm-dd
secondaryTerminalId Terminal ID(Secondary) string no D+10 digit number #6
name name string no
terminalType Terminal Type string no
terminalGroupId terminal group ID string no
address address string no
buildingName Building Name string no
  • #3 primaryTerminalID respond to use when terminal redundancy happen.
  • #4 Processing: Changing, Kitting, Delivery, Activation.
  • #5 Processing, Completion, Error, Cancellation.
  • #6 Responding when only use Terminal redundancy.

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ビル"
      }
   ]
}

Post GW

Order for a GW.

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

Request Parameters

Name Description Type Mandatory Remarks
contractId Contract ID string yes 15 digit number
Name Description Type Mandatory Remarks
region Region string yes #1
bandwidth Bandwidth string yes #2
gwManagementIpAddress GW management IP address object yes
   ipAddress IP Address string yes
   subnetMask Subnetmask string yes #3
overlay1IpAddress Overlay 1 IP Address object yes
   ipAddress IP Address string yes
   subnetMask Subnetmask string yes #4
overlay2IpAddress Overlauy 2 IP Address object yes
   ipAddress IP Address string yes
   subnetMask Subnetmask string yes #3
terminalManagementIpAddress Terminal Management IP Address object yes
   ipAddress IP Address string yes
   subnetMask Subnetmask string yes #4
vpnNo VPN Number string yes V+8 digit number
representativeNNo Representative N Number string yes N+9 digit number
name Name string yes
remarks Remarks string no
  • #1 "JapanEast"to designate.
  • #2 Designate one or the other "100Mbps" or "1000Mbps".
  • #3 Designate to 22-24 of subnet musk.
  • #4 Designate to 22-25 of subnet musk.

Example Request

POST /v1/sdns/contracts/12345678012345/gateways

{
    "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"
    }, 
    "vpnNo": "V99999999",
    "representativeNNo": "Nxxxxxx**",
    "name": "SD-NSxxxxxx",
    "remarks": "-",
   }
}

Response Code

Code Description
201 Success
400 Invalid type of parameter
404 Absent ID

Response Parameters

Name Description Type Mandatory Remarks
gwId GW ID string yes T+10 digit number
orderId Order ID string yes 10 digit number

Example Result

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

Get GW details

Returns the configuration for a specific GW.

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

Request Parameters

Name Description Type Mandatory Remarks
contractId Service Contract ID string yes 15 digit number
gwId GW ID string yes T+10 digit number

Example Request

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

Response Code

Code Description
200 Success
400 Invalid type of parameter
404 Absent ID

Response Parameters

Name Description Type Mandatory Remarks
gwId GW ID string yes T+10 digit number
region Region string yes
bandwidth Bandwidth string yes
gwManagementIpAddress GW management IP address object yes
   ipAddress IP address string yes
   subnetMask Subnet mask string yes
overlay1IpAddress Overlay 1 IP address object yes
   ipAddress IP address string yes
   subnetMask Subnet mask string yes
overlay2IpAddress Overlay 2 IP address object yes
   ipAddress IP address string yes
   subnetMask Subnet mask string yes
terminalManagementIpAddress Terminal management IP address object yes
   ipAddress IP address string yes
   subnetMask Subnet mask string yes
terminalConnectionNw1 Terminal connection NW (VPN) string yes
terminalConnectionNw2 Terminal connection NW (Internet) string yes
vpnNo VPN number string yes V+8 digit number
representativeNNo Representative N number string yes N+9 digit number
name Name string yes
remarks Remarks string yes
orderStatus Order status of GW string yes #1
multipathControl Multipath control array yes
   seqNo Priority string yes
   applicationName Application Name string yes
   name Name string yes
   tos ToS string yes #2
   primaryPath Primary Path string yes
   secondaryPath Secondary Path string yes
   policy Policy string yes
   loss loss string yes
   latency latency string no
   jitter Jitter string no
tosSettings ToS Settings array yes
   tos ToS string yes #2
   settings Settings array yes
      direction IN/OUT string no
      seqNo Priority string no
      protocol Protocol string no
      surceIpAddress Surce IP Address string no
      surceSubnetMask Surce Subnetmask string no
      surcePort Surce Port Number string no
      destinationIpAddress Destination IP Address string no
      destinationSubnetMask Destination Subnetmask string no
      destinationPort Destination Port Number string no
      action Set/Except string no
  • #1 Processing, Completion, Error, Cancellation
  • #2 Default,0-7(Except 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": [
            ]
        }
    ]
}

Put GW

Change configuration for a spsecific GW.

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

Request Parameters

Name Description Type Mandatory Remarks
contractId Contract ID string yes 15 digit number
gwId GW ID string yes T+10 digit number
Name Description Type Mandatory Remarks
gwId GW ID string yes T+10 digit number #1
region Region string yes #1
bandwidth Bandwidth string yes #1
gwManagementIpAddress GW Management IP Address object yes #1
   ipAddress IP Address string yes #1
   subnetMask Subnetmask string yes #1
overlay1IpAddress Overlay 1 IP Address object yes #1
   ipAddress IP Address string yes #1
   subnetMask Subnetmask string yes #1
overlay2IpAddress Overlay 2 IP Address object yes #1
   ipAddress IP Address string yes #1
   subnetMask Subnetmask string yes #1
terminalManagementIpAddress Terminal Management IP Address object yes #1
   ipAddress IP Address string yes #1
   subnetMask Subnetmask string yes #1
terminalConnectionNw1 Terminal Connection NW(VPN) string yes #1
terminalConnectionNw2 Terminal Connection NW(Internet) string yes #1
vpnNo VPN Number string yes V+8 digit number #1
representativeNNo Representative N Number string yes N+9 digit number #1
name Name string yes
remarks Remarks string yes
orderStatus GW Order Status string yes #1 #2
multipathControl Multipath Control array yes #14 #15
   seqNo Priority string yes #3
   applicationName Application Name string yes #17
   name Name string yes
   tos ToS string yes #1
   primaryPath Primary Path string yes #4
   secondaryPath Secondaru Path string yes #4
   policy Policy string yes #5
   loss loss string yes #6
   latency latency string yes #7
   jitter Jitter string yes #8
tosSettings ToS Settings array yes #14 #16
   tos ToS string yes #1 #9
   settings Settings array yes #10
      direction IN string yes #1
      seqNo Priority string yes #11
      protocol Protocol string yes #12
      surceIpAddress Source IP Address string yes #13
      surceSubnetMask Source Subnetmask string yes #13
      surcePort Source Port string yes #13
      destinationIpAddress Destination IP Address string yes #13
      destinationSubnetMask Destination Subnetmask string yes #13
      destinationPort Destination Port Number string yes #13
      action Set/Except string yes
  • #1 Cannot be changed.
  • #2 Processing, Completio, Error, Cancellation
  • #3 Application priority is prioritized than ToS: input with 1-2000 and prioritize ToS: input with 3000-5000.in case of ToS can be input ToS7:2010、ToS5:2020、ToS4:2030、ToS3:2040、ToS2:2050、ToS1:2060、ToS0:2070. Up to total 60 applications.
  • #4 Designate either one or the other "WAN1","WAN2"
  • #5 Designate one out of the default/Real-time-video/Voice/Best-effort/custom.
  • #6 Default:100,Real-time-video/Voice:1,Best-effort:10,custom:1.00-100.00 (Designated to until two decimal places)
  • #7 Default:None,Real-time-video/Voice:150,Best-effort:500,custom:1-65535
  • #8 Default:None,Real-time-video/Voice:20,Best-effort:None,custom:1-200
  • #9 Default,1~7(Except 6).
  • #10 120 one each ToS.
  • #11 Enter of the 1-9999. If you got already same value in case of the error.
  • #12 Designate one out of the tcp/udp/ip.
  • #13 Enter of the "any" if you do not designate.
  • #14 It is possible to change the Multhpath Setting and ToS Setting at the same time.
  • #17 "null" when case of Multipath setting on ToS.

Example Request

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

{
    "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": "Vxxxxxx",
    "representativeNNo": "Nxxxxxx",
    "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": [
            ]
        }
    ]
}    

Response Code

Code Description
202 Success
400 Invalid type of parameter
404 Absent ID

Response Parameters

Name Description Type Mandatory Remarks
orderId Order ID string yes 10 digit number

Example Result

{
    "orderId": "9999999999"
}

Get GW list

Returns a list and summary for a GW.

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

Request Parameters

Name Description Type Mandatory Remarks
contractId Service Contract ID string yes 15 digit number

Example Request

GET /v1/sdns/contracts/999999999999999/gateways

Response Code

Code Description
200 Success
400 Invalid type of parameter
404 Absent ID

Response Parameters

Name Description Type Mandatory Remarks
gateways Gateways array yes
   gwId GW ID string yes T+10 digit number
   name Name string yes
   region Region string yes
   bandwidth Bandwidth string yes
   terminalConnectionNw1 Terminal Connection NW(VPN) string yes
   vpnNo VPN Number string yes V+8 digit number
   representativeNNo Representative N Number string yes N+9 digit number
   terminalConnectionNw2 Terminal Connection NW(Internet) string yes
   remarks Remarks string yes
   orderStatus Order status 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-GWxxxxxx", 
            "remarks": "-", 
            "orderStatus": "Completed", 
        }   
    ]
}

Delete GW

erminate a GW.

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

Request Parameters

Name Description Type Mandatory Remarks
contractId Service Contract ID string yes 15 digit number
gwId GW ID string yes T+10 digit number

Example Request

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

Response Code

Code Description
200 Success
400 Invalid type of parameter
404 Absent ID

Response Parameters

Name Description Type Mandatory Remarks
orderId Order ID string yes 10 digit number

Example Result

{
    "orderId": "9999999999"
}

Post terminal

Order for a terminal.

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

Request Parameters

Name Description Type Mandatory Remarks
contractId Service Contract ID string yes 15 digit number
gwId GW ID string yes T+10 digit number
Basic Information
Name Description Type Mandatory Remarks
basicInformation Basic Information object yes
   terminalType Terminal Type string yes #2
   terminalContractType Terminal Contract Type string yes #3
   terminalConstructionType Terminal Construction Type string yes #4
   installRequestedDate On-site Installation requested date string yes #5
   installRequestedTimeSlot On-site Installation requested time string yes #6
   installRequestedTimeZone On-site Installation requested time zone string yes #7
   onSiteRepairOption On-site Repair option(true/false) boolean yes
   rackMount Rackm mount kit(true/false) boolean yes
  • #2 Designate one out of the "C4321", "C891F","ASR1K"
  • #3 Degignate either one or the other "Purchase" , "Rental" for Contract Type. It is required to our sales representative in advance if you select "Purchase".
  • #4 "DIY" to designate.
  • #5 "YYYY-MM-DD" to designate.
  • #6 Select one out of the "9:00","13:00","15:00","17:00"
  • #7 "+9:00"to designate.
  • #8 It is necessary or not shall be described if only selected the terminalType either "ASR1K" or "C4321". When only selected "C891F" will be "false".
Installation Site Information
Name Description Type Mandatory Remarks
installationSite Installation Site Information object yes
   foreignFlag false boolean yes #8
   country Japan string yes #9
   zipCode ZIP Code string yes
   address Address string yes
   buildingName Building Name string yes
   corpName Company Name string yes
   corpNameKana Company Name(Kana) string yes
   sectionName Department Name string yes
   staffName Contract Parson string yes
   contactTel Phone Number string yes
   email E-mail string yes
  • #8 "false"to designate.
  • #9 "Japan"to designate.
Shipping Information
Name Description Type Mandatory Remarks
shippingInformation Shipping Information object yes
   foreignFlag false boolean yes #8
   country Japan string yes #9
   zipCode ZIP Code string yes
   address Address string yes
   buildingName Building Name string yes
   corpName Company Name string yes
   corpNameKana Company Name(Kana) string yes
   sectionName Department Name string yes
   staffName Contact Parson string yes
   contactTel Phone Number string yes
   email E-mail string yes
Circuit Information
Name Description Type Mandatory Remarks
wanConfigs Circuit Information array yes
Circuit Information (WAN1)
   circuitTypeWan1 Circuit Type string yes #10
   circuitServiceType Circuit Service Type string yes #11
   circuitServiceName Circuit Service Name string yes
   circuitContractId Circuit Contract ID string yes
   bandwidth Bandwidth string yes #12
   interfaceSpeed WAN IF (Speed) string yes #13
   interfaceDuplex WAN IF (Duplex) string yes #14
   ipAddress CER WAN Port IP Address string yes
   subnetMask CER WAN Port Subnetmask string yes
   routingSetting Routing Setting string yes #15
   defaultGw Default GW string yes #16
   perBgpAsNo AS Number(PER) string yes #17
   cerBgpAsNo AS Number(CER) string yes #17 #26
   perWanPortIpAddress PER WAN Port IP Adress string yes #17
   pppoeId PPPoE ID string yes
   pppoePassword PPPoE Password string yes
   pppoeAuthenticationMethod PPPoE Authentication Method string yes
Circuit Information (WAN2)
   circuitTypeWan2 Circuit Type string yes #18
   circuitServiceType Circuit Service Type string yes #11
   circuitServiceName Circuit Service Name string yes
   circuitContractId Circuit Contract ID string yes
   bandwidth Bandwidth string yes #12
   interfaceSpeed WAN IF (Speed) string yes #19
   interfaceDuplex WAN IF (Duplex) string yes #14
   ipMethod WAN IP Method string yes #20
   ipAddress WAN IP Address string yes #21
   subnetMask WAN IP Subnetmask string yes #21
   defaultGw Default GW string yes #22
   pppoeId PPPoE ID string yes #23
   pppoePassword PPPoE Password string yes #23
   pppoeAuthenticationMethod PPPoE Authentication Method string yes #24
   perBgpAsNo AS Number(PER) string yes #25
   cerBgpAsNo AS Number(CER) string yes #25 #26
   perWanPortIpAddress WAN IP address (PER) string yes #25
  • #10 "null" when using single constitution to internet of WAN, other than that "VPN"
  • #11 Designate either one or the other "ntt_japan","other_japan".
  • #12 Designate from 1-9999 in the case of selecting one either "terminalType:C4321" or "terminalType:ASR1K". Designate from 1-1000 in the case of "terminalType:C891F".
  • #13 Designate from "10","100","1000","auto" in the case of selecting either "C4321" or "C891F". Designate from "auto" in the case of "ASR1K".
  • #14 Designate "auto" when selecting interfaceSpeed"auto" other than that "full".
  • #15 Designate either one or the other "Static","bgp". Designate "static" in the case of circuitServiceType"other_japan".
  • #16 Designate in the case of routingSetting"Static". "null" in the case of routingSetting"bgp".
  • #17 Designate in the case of routingSetting"BGP". "null" in the case of routingSetting"Static".
  • #18 Designate one either or the other "Internet",VPN.
  • #19 Designate one out of the "10","100","1000","auto. When in the case of C4321,C891F constitute by single circuit to internet on WAN. Designate "10","100","auto" when in the case of C891F constitute two circuit on WAN. Designate "auto" in the case of ASR1K.
  • #20 Designate either one or the other "PPPoE", "StaticIP" when selected "INTERNET,"circuitTypeWan2". Designate either one or the other "static","bgp"(Designate "Static" in the case of circuitServiceType"other_japan")
  • #21 Designate one out of the "StatucIp","Static","BGP","circuitTypeWan2". Designate "null" in case of "PPPoE"
  • #22 Designate one out of the "StatucIp","Static" on "circuitTypeWan2", Designate "null" in case of "StatucIp","Static","BGP"
  • #23 Designate in case of "PPPoE", Designate "null" in case of "StatucIp","Static","BGP"
  • #24 Designate "CHAP" in case of "PPPoE" on "circuitTypeWan2", Designate "null" in case of "StatucIp","Static","BGP".
  • #25 Designate from 1-65535 in case of selecting "BGP" on "circuitTypeWan2", Designate "null" in case of "StatucIp","Static","PPPoE".
  • #26 Enter the same BGP number in case of both two circuits on WAN is VPN.
Others
Name Description Type Mandatory Remarks
redundancyOption Redundancy Option(true/false) string yes #27
name Name string yes #28
terminalGroupId Terminal Group ID string yes 10 digit number
gwId GW ID string yes
remarks Remarks string no
interLinkIpAddress Terminal Redundancy IP address string no #28
interLinkSubnetMask Terminal Redundancy IP subnetmask string no #29
secondaryName Terminal Redundancy Secondary Terminal Name string no #30
  • #26 Designate "fales" in case of terminalType:C891F.
  • #27 Designate "primaryName" in case of redundancyOption"true".
  • #28 Designate this parameter in case of redundancyOption"true".
  • #29 Designate "29" in case of redundancyOption"true".
  • #30 Designate in case of 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": "YYYY-MM-DD",
        "installRequestedTimeSlot": "+09:00",
        "installRequestedTimeZone": "+09:00",
        "onSiteRepairOption": false,
        "rackMount": false, 
    },
    "installationSite": {
        "foreignFlag": true,
        "country":  "Japan",
        "zipCode": "9999999",
        "address": "xxxxxxTokyo",
        "buildingName": "xxxxxxbuilding",
        "corpName": "xxxxxx",
        "corpNameKana": "xxxxxx",
        "sectionName": "xxxxxxdepartment",
        "staffName": "xxxxxx",
        "contactTel": "999-9999-9999",
        "email": "xxxxxx@xxx.xxx",
    },
    "shippingInformation": {
        "foreignFlag": true,
        "country": "Japan",
        "zipCode": "9999999",
        "address": "xxxxxxTokyo",
        "buildingName": "xxxxxxbuilding",
        "corpName": "xxxxxx",
        "corpNameKana": "xxxxxx",
        "sectionName": "xxxxxxdepartment",
        "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": "99", 
            "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": "99", 
            "defaultGw": "99.99.99.99",
            "pppoeId": null, 
            "pppoePassword": null,
            "pppoeAuthenticationMethod": null
   },
   ]
}

Response Code

Code Description
201 Success
400 Invalid type of parameter
404 AbsentID

Response Parameters

Name Description Type Mandatory Remarks
terminalId Terminal ID string yes D+10 digit number #31
orderId Order ID string yes 10 digit number
  • #31 Response either one or the other "primaryTerminalId","secondaryTerminalId" in the case of redundancyOption"true"

Example Result

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

Put terminal order change

Change a terminal order.

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

Request Parameters

Name Description Type Mandatory Remarks
contractId Service Contract ID string yes 15 digit number
gwId GW ID string yes T+10 digit number
terminalId Terminal ID string yes D+10 digit number
Basic Information
Name Description Type Mandatory Remarks
basicInformation Basic Information object yes
   terminalType Terminal Type string yes #1
   terminalContractType Terminal Contract Type string yes
   terminalConstructionType Terminal Construction Type string yes #1
   installRequestedDate On-site Installation requested date string yes
   installRequestedTimeSlot On-site Installation requested time string yes
   installRequestedTimeZone On-site Installation requested time zone string yes #1
   onSiteRepairOption On-site Repair option(true/false) boolean yes
   rackMount Rackm mount kit(true/false) boolean yes
  • #1 Cannot be change.
Installation Site Information
Name Description Type Mandatory Remarks
installationSite Installation Site Information object yes
   foreignFlag Overseas shipping(false) boolean yes #1
   country Japan string yes #1
   zipCode ZIP Code string yes
   address Address string yes
   buildingName Building Name string yes
   corpName Company Name string yes
   corpNameKana Company Name(Kana) string yes
   sectionName Department Name string yes
   staffName Contract Parson string yes
   contactTel Phone Number string yes
   email E-mail string yes
Shipping Information
Name Description Type Mandatory Remarks
shippingInformation Shipping Information object yes
   foreignFlag Overseas shipping (false) boolean yes #1
   country Japan string yes #1
   zipCode ZIP Code string yes
   address Address string yes
   buildingName Building Name string yes
   corpName Company Name string yes
   corpNameKana Company Name(Kana) string yes
   sectionName Department Name string yes
   staffName Contact Parson string yes
   contactTel Phone Number string yes
   email E-mail string yes
Circuit Information
Name Description Type Mandatory Remarks
wanConfigs WAN interface on terminal array yes
wanConfigs Circuit Information (WAN1)
   circuitTypeWan1 Circuit Type string yes #1
   circuitServiceType Circuit Service Type string yes #1
   circuitServiceName Circuit Service Name string yes
   circuitContractId Circuit Contract ID string yes
   bandwidth Bandwidth string yes
   interfaceSpeed WAN IF (Speed) string yes
   interfaceDuplex WAN IF (Duplex) string yes
   ipAddress CER WAN Port IP Address string yes
   subnetMask CER WAN Port Subnetmask string yes
   routingSetting Routing Setting string yes
   defaultGw Default GW string yes
   perBgpAsNo AS Number(PER) string yes
   cerBgpAsNo AS Number(CER) string yes
   perWanPortIpAddress PER WAN Port IP Address string yes
    Circuit Information (WAN2)
   circuitServiceType Circuit Type string yes #1
   circuitServiceType Circuit Service Type string yes #1
   circuitServiceName Circuit Service Name string yes
   circuitContractId Circuit Contract ID string yes
   bandwidth Bandwidth string yes
   interfaceSpeed WAN IF (Speed) string yes
   interfaceDuplex WAN IF (Duplex) string yes
   ipMethod WAN IP Method string yes
   ipAddress WAN IP Address string yes
   subnetMask WAN IP Subnetmask string yes
   defaultGw Default GW string yes
   pppoeId PPPoE ID string yes
   pppoePassword PPPoE Password string yes
   pppoeAuthenticationMethod PPPoE Authentication Method string yes
   perBgpAsNo AS Number (PER) string yes
    AS Number(CER) string yes
   perWanPortIpAddress PER WAN Port IP Address string yes
Circuit Information(Secondary)
Name Description Type Mandatory Remarks
secondaryWanConfigs Circuit Information (Secondary) array yes
   perBgpAsNo AS Number (PER)(Secondary) string yes #1
   cerIpAddress WAN IP Address(CER)(Secondary) string yes #1
   cerSubnetMask WAN IP Subnetmask(CER)(Secondary) string yes #1
   perIpAddress WAN IP Address(PER)(Secondary) string yes #1
   loopbackIpAddress Loopback IP Address string yes #1
Others
Name Description Type Mandatory Remarks
redundancyOption Terminal Redundancy Option(true/false) boolean yes #1
name Name string yes #2
terminalGroupId Terminal Group ID string yes 10 digit number
gwId GW ID string yes T+10 digit number #1
remarks Remarks string yes
interLinkIpAddress Terminal Redundancy IP Address string yes
interLinkSubnetMask Terminal Redundancy IP Subnetmask string yes
secondaryName Secondary Terminal Name when terminal redundancy string yes
  • #2 Degignate "primaryName"in the case of "redundancyOption"true"

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": "YYYY-MM-DD",
        "installRequestedTimeSlot": "+09:00",
        "installRequestedTimeZone": "+09:00",
        "onSiteRepairOption": false,
        "rackMount": false, 
    },
    "installationSite": {
        "foreignFlag": true,
        "country":  "Japan",
        "zipCode": "xxxxxx",
        "address": "xxxxxxTokyo",
        "buildingName": "xxxxxxbuilding",
        "corpName": "xxxxxx",
        "corpNameKana": "xxxxxx",
        "sectionName": "xxxxxxdepartment",
        "staffName": "xxxxxx",
        "contactTel": "999-9999-9999",
        "email": "xxxxxx@xxx.xxx",
    },
    "shippingInformation": {
        "foreignFlag": true,
        "country": "Japan",
        "zipCode": "9999999",
        "address": "xxxxxxTokyo",
        "buildingName": "xxxxxxbuilding",
        "corpName": "xxxxxx",
        "corpNameKana": "xxxxxx",
        "sectionName": "xxxxxxdepartment",
        "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": "99", 
            "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": "99", 
            "defaultGw": "99.99.99.99",
            "pppoeId": null, 
            "pppoePassword": null,
            "pppoeAuthenticationMethod": null
   },
       "secondaryWanConfigs": [
    {
        "perBgpAsNo": "9999",
        "cerIpAddress": "99.99.99.99",
        "cerSubnetMask": "99",
        "perIpAddress": "99.99.99.99",
        "loopbackIpAddress": "99.99.99.99"
    }
    ]
   }
}

Response Code

Code Description
202 Success
400 Invalid type of parameter
404 AbsentID

Response Parameters

Name Description Type Mandatory Remarks
orderId Order ID string yes 10 digit number

Example Result

{
  "orderId": "9999999999"
}

Put terminal order cancel

Cancel of a terminal order.

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

Request Parameters

Name Description Type Mandatory Remarks
contractId Service Contract ID string yes 15 digit number
gwId GW ID string yes T+10 digit number
terminalId Terminal ID string yes D+10 digit number

Example Request

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

Response Code

Code Description
202 Success
400 Invalid type of parameter
404 AbsentID

Response Parameters

Name Description Type Mandatory Remarks
orderId Order ID string yes 10 digit number

Example Result

{
    "orderId": "9999999999"
}

Get terminal detail

Return the configuration change for a specific terminal.

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

Request Parameters

Name Description Type Mandatory Remarks
contractId Service contract ID string yes 15 digit number
gwId GW ID string yes T+10 digit number
terminalId Terminal ID string yes D+10 digit number

Example Request

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

Response Code

Code Description
200 Success
400 Invalid type of parameter
404 AbsentID

Response Parameters

Circuit Information
Name Description Type Mandatory Remarks
wanConfigs Circuit information array yes
Circuit Information (WAN1)
   interface Port number string yes
   circuitTypeWan1 Circuit Type string yes
   circuitServiceType Circuit service type string yes
   circuitServiceName Circuit service name string yes
   circuitContractId Circuit contract ID string yes
   bandwidth Bandwidth string yes
   interfaceSpeed WAN IF (Speed) string yes
   interfaceDuplex WAN IF (Duplex) string yes
   ipAddress CER WAN port IP address string yes
   subnetMask CER WAN port IP address(subnet mask) string yes
   routingSetting Routing setting string yes
   defaultGw Default gateway string yes
   perBgpAsNo AS number(PER) string yes
   cerBgpAsNo AS number(CER) string yes
   perWanPortIpAddress PER WAN port IP address string yes
   pppoeId PPPoE ID string yes
   pppoePassword PPPoE Password string yes
   pppoeAuthenticationMethod PPPoE Method string yes
Circuit Information (WAN2)
   interface Port Number string yes
   circuitTypeWan2 Circuit Type string yes
   circuitTypeWan2 CircuitServiceType string yes
   circuitServiceName Circuit service name string yes
   circuitContractId Circuit Contract ID string yes
   bandwidth Bandwidth string yes
   interfaceSpeed WAN IF (Speed) string yes
   interfaceDuplex WAN IF (Duplex) string yes
   ipMethod WAN IP setting string yes
   ipAddress WAN IP address string yes
   subnetMask WAN IP address(subnetmask) string yes
   defaultGw Default GW string yes
   pppoeId PPPoE ID string yes
   pppoePassword PPPoE Password string yes
   pppoeAuthenticationMethod PPPoE Authentication Method string yes
   pppoeAuthenticationMethod AS Number(PER) string yes
   cerBgpAsNo AS Number(CER) string yes
   perWanPortIpAddress PER WAN Port IP Address string yes
LAN Port Setting
Name Description Type Mandatory Remarks
lanPortSettings LAN port setting array yes
   available true/false boolean yes
   name Name string yes
   portVlanNo Untag VLAN ID string yes
   tagVlanNo Tag VLAN ID string yes
   vlanMode Tagged/Untagged string yes
   port Port number string yes
VLAN Network Address Setting
Name Description Type Mandatory Remarks
vlanSettings VLAN Network address setting array yes
   ipAddress IPアドレス string no #1
   vlanId VLAN ID string no
   subnetMask Subnet mask string no
   available true/false boolean no
   name Name string no
   ipAddressPrimary IP address(Primary) string no
   ipAddressSecondary IP addres(Secondary) string no
   portNo port number string no
   tagging Tagged/Untagged string no
  • #1 Respond「ipAddressVip」when using terminal redundancy.
LAN Routing Setting (Static)
Name Description Type Mandatory Remarks
lanRoutingSettings LAN routing setting(Static) array yes
   name Name string no
   ipAddress Destination IP address string no
   subnetMask Destination IP address(Subnet Mask) string no
   gwIpAddress GW Router IP address string no
LAN Routig Setting(Dynamic)
Name Description Type Mandatory Remarks
lanRoutigSettingDynamic LAN Routig Setting(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 Interface to Configure OSPF array no
         port interface number string no
         vlan VLAN ID string no
      distributionRouteToNetwork Distribution route to Network array yes
         name Name string no
         ipAddress IP Address string no
         subnetMask Subnet Mask string no
  • #2 Display if only selected "authenticationType""text"
  • #3 Display if only selected "authenticationType""MD5"
DHCP
Name Description Type Mandatory Remarks
dhcpServer DHCP setting object yes
   method Server/Relay/No string yes
   server Server object yes
      exclusionRange Exclusion Range string yes #4
      defaultRouter Default Router string yes #4
      primaryDns Primary DNS string yes #4
      secondaryDns Secondary DNS string yes #4
      domain DHCP domain address string yes #4
      ipAddress DHCP Applicable Network Address (IP address) string yes #4
      subnetMask DHCP Appricable Network Address (Subnetmask) string yes #4
      primaryWins Primary WINS string yes #4
      secondaryWins Secondary WINS string yes #4
   relay Relay object yes
      ipAddress1 DHCP Server Address1 string yes #5
      ipAddress2 DHCP Server Address2 string yes #5
      ipAddress2 DHCP Server Address3 string yes #5
      ipAddress2 DHCP Server Address4 string yes #5
  • #4 "null" when selected "Relay" on its method.
  • #5 "null" when selected "Server"on its method.
IP Filtering
Name Description Type Mandatory Remarks
ipFilterings IP filtering array yes
   portName Target interface name string no
   targetInterface Target interface string no #6
   settings Settings array no
      direction IN/OUT string no
      destinationIpAddress Destination IP address string no
      destinationPortNo Destination port number string no
      destinationSubnetMask Destination IP address(Subnetmask) string no
      protocol Protocol string no
      seqNo Sequence number string no
      sourceIpAddress Source IP address string no
      sourcePortNo Source port number string no
      sourceSubnetMask Source subnet mask string no
      action deny/permit string no
  • #6 It is response to each setting interface (VPN、Internet、VLAN ID) of IP filtering.
ToS Setting
Name Description Type Mandatory Remarks
tosSettings ToS settings array yes
   tos ToS string yes #7
   settings Settings array yes
      direction IN/OUT string no
      seqNo Sequence number string no
      protocol Protocol string no
      sourceIpAddress Source IP address string no
      sourceSubnetMask Source IP address(Subnetmask) string no
      sourcePort Source port number string no
      destinationIpAddress Destination IP address string no
      destinationPortNo Destination port number string no
      destinationSubnetMask Destination IP address(Subnetmask) string no
      action deny/permit string no
  • #7 Default,1-7(Except 6)
QoS
Name Description Type Mandatory Remarks
qos QoS string yes #8
  • #8 If you selected set by the response to none/4clsss/6class.
Internet Breakout
Name Description Type Mandatory Remarks
internetBreakout Internet breakout setting object yes
   enable true/fals boolean yes
   services Specific service array no
      name service name string yes
      breakout true/false boolean yes
   applications Application array yes
      name Name string no
      applicationName Application Name string no
   specificIpAddress Specific IP address array yes
      listId List ID string yes Terminal ID+6 digit number
      name name string no
      ipAddress Destination IP Address string no
      subnetmask Destination Subnetmask string no
WAN Interface Configuration(Secondary)
Name Description Type Mandatory Remarks
secondaryWanConfigs WAN Interface configuration(Secondary) array no #9
   perBgpAsNo AS number (PER)(Secondary) string no
   cerIpAddress CER WAN port IP address(Secondary) string no
   cerSubNetmask CER WAN port IP address(Subnetmask)(Secondary) string no
   perIpAddress PER WAN port IP address(Secondary) string no
   loopbackIpAddress Loopback IP address string no
  • #9 When using this Arcstar Universal One (Except Japan Site) response to your order after completion.
Installation Information
Name Description Type Mandatory Remarks
installationInformation Installation information object yes
   customerPresenceContactInformation Customer presence information string yes
   customerPresenceCorpName Customer presence:Corporation name string yes
   howToEnter How to enter string yes
   customerPresenceCorpNameKana Customer presence:Corporation name(Kana) string yes
   installationCorpName Installation cprpration name string yes
   workerContactInformation Worker contact information string yes
   carInformation Car information string yes
   date Confirmed installation date string yes
   workerInformation Worker information string yes
   customerPresenceSectionName Customer presence:Section name string yes
   time Confirmed installation time string yes
   customerPresenceName Customer presence:Name string yes
   customerPresenceNameKana Customer presence:Name(Kana) string yes
Shipping Information
Name Description Type Mandatory Remarks
shippingInformation Shipping information object yes
   address Address string yes
   buildingName Building name string yes
   email E-mail string yes
   contactTel Phone number string yes
   corpName Corporation name string yes
   corpNameKana Corporation name(Kana) string yes
   country Country string yes
   equalInstallAddress Same as installation site boolean yes
   sectionName Section name string yes
   staffName Contact Person string yes
   zipCode ZIP code string yes
   foreignFlag Overseas shipping boolean yes
Installation Site
Name Description Type Mandatory Remarks
installationSite Installation site object yes
   address Address string yes
   buildingName Building name string yes
   email E-mail string yes
   contactTel Phone number string yes
   corpName Corporation name string yes
   corpNameKana Corporation name(Kana) string yes
   country Country string yes
   sectionName Section name string yes
   staffName Section name string yes
   zipCode ZIP code string yes
   foreignFlag Overseas shipping boolean yes
Basic Information
Name Description Type Mandatory Remarks
basicInformation Basic Information object yes
   terminalContractType Terminal order type string yes #10
   terminalType Terminal type string yes
   terminalConstructionType Construction method string yes
   installRequestedDate Installation requested date string yes
   installRequestedTimeSlot Installation requested time string yes
   installRequestedTimeZone Installation requested time(Time Zone) string yes
   onSiteRepairOption On-site repair option boolean yes
   rackMount Ruck mountkit(true/false) string yes
   primary primary terminal object no #10
   luggageTrackingNo Luggage tracking number string yes
      serialNo Serial number string yes
   secondary secondary terminal object no #10
      luggageTrackingNo luggage tracking number string no #10
      serialNo Serial number string no #10
  • #10 Responding when only using terminal redandancy.
Termination Information
Name Description Type Mandatory Remarks
collectionRequestedDate Terminal collection requested date string no
collectionRequestedTimeSlot Terminal collection requested time string no
collectionContactInformation Terminal collection contact information object no
   country Country string no
   foreignFlag Foreing Flag(true/false) boolean no
   zipCode Zip Code string no
   address Address string no
   buildingName Building Name string no
   corpName Corporation name string no
   corpNameKana Corporation name KANA string no
   sectionName Section Name string no
   staffName Staff Name string no
   contactTel Contact tel string no
   email email string no
Others
Name Description Type Mandatory Remarks
terminalId Terminal ID string yes D+10 digit number #12
secondaryTerminalId Terminal ID(Secondary) string no D+10 digit number #11
gwId GW ID string yes T+10 digit number
terminalGroupId Terminal group ID string yes 10 digit number
remarks Remarks string yes
name Name string yes
secondaryName Secondary name string yes
gwId GW ID string yes T+10 digit number
orderStatus Order status string yes #13
status Terminal status string yes #14
secondaryStatus Secondary terminal status string yes #14
interLinkIpAddress Terminal redundancy IP address string no #11
interLinkSubnetMask Terminal redundancy IP address(Subnetmask) string no #11
preConfigureError terminal preconfiguration error boolean yes #15
  • #11 Terminal redundancy for only use be response.
  • #12 Tag name "primaryTerminalID" is response to use at the time of terminal redundancy.
  • #13 Processing, Completed, Error, Canceled.
  • #14 Processing:Accepting, Kitting:During,kitting, Shipping, Activated, WaitingSendBack,SendBack:terminaled.
  • #15 true:Initiate the terminal preconfiguration but it is not avtivated, fals:Not having done preconfiguration or already preconfigured.

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": "9999",
            "cerBgpAsNo": "9999", 
            "defaultGw": "99.99.99.99", 
            "ipAddress": "99.99.99.99, 
            "subnetMask": "99", 
            "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": "99", 
            "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": "99", 
            "available": false, 
            "name": "VLAN_10"
            "ipAddressPrimary":"99.99.99.99",
            "ipAddressSecondary":"99.99.99.99"
        },
        {
            "ipAddressVip": "99.99.99.99", 
            "vlanId": "20", 
            "subnetMask": "99", 
            "available": true, 
            "managementName": "VLAN_15"
            "ipAddressPrimary":"99.99.99.99",
            "ipAddressSecondary":"99.99.99.99"
        }, 
        {
            "ipAddressVip": "99.99.99.99", 
            "vlanId": "30", 
            "subnetMask": "99", 
            "available": true, 
            "managementName": "VLAN_20"
            "ipAddressPrimary":"99.99.99.99",
            "ipAddressSecondary":"99.99.99.99"
        }
    ], 
    "lanRoutingSettings": [
        {
            "name": "Static2", 
            "ipAddress": "99.99.99.99", 
            "subnetMask": "99", 
            "gwIpAddress": "99.99.99.99"
        },
        {
            "name": "Static3", 
            "ipAddress": "99.99.99.99", 
            "subnetMask": "99", 
            "gwIpAddress": "99.99.99.99"
        },
        {
            "name": "Static4", 
            "ipAddress": "99.99.99.99", 
            "subnetMask": "99", 
            "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": "99", 
                    "destinationSubnetMask": "99.99.99.99", 
                    "protocol": "udp", 
                    "seqNo": "60", 
                    "sourceIpAddress": "99.99.99.99", 
                    "sourcePortNo": "99", 
                    "sourceSubnetMask": "99.99.99.99", 
                    "action": "deny"
                }
            ]
        },
        {
            "targetInterface": "WAN2", 
            "settings": [
                {
                    "packetDirection": "IN", 
                    "destinationIpAddress": "99.99.99.99", 
                    "destinationPortNo": "99", 
                    "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": "99",
                    "sourcePort": null,
                    "destinationIpAddress": "99.99.99.99",
                    "destinationSubnetMask": "99",
                    "destinationPort": "88",
                    "action": "permit"
                }
            ]
        },
        {
            "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": "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":"xxxxxx",
      "ipAddress":"99.99.99.99",
      "netmask":32,   
    }
  ]
}
    "secondaryWanConfigs": [
        {
            "perBgpAsNo": "9999",
            "cerIpAddress": "99.99.99.99",
            "cerSubnetMask": "99",
            "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": "xxxxxxdepartment"
    "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":"99",
  "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": "xxxxxxdepartment", 
      "staffName": "xxxxxx", 
      "zipCode": "9999999"
      "foreignFlag": false,
  }, 
  "installationSite": {
      "address": "xxxxxxTokyo", 
      "buildingName": "xxxxxxbuilding", 
      "email": "xxxxxx@xxx.xxx", 
      "contactTel": "9999-999-9999", 
      "corpName": "xxxxxx", 
      "corpNameKana": "xxxxxx", 
      "country": "Japan", 
      "sectionName": "xxxxxxdepartment", 
      "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 terminal preconfigutaion

Preconfigure the terminal settings.

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

Request Parameters

Name Description Type Mandatory Remarks
contractId Service contract ID string yes 15 digit number
gwId GW ID string yes T+10 digit number
terminalId Terminal ID string yes D+10 digit number
Basic information
Name Description Type Mandatory Remarks
redundancyOption terminal redundancy boolean yes #1
basicInformation basic information object yes
   terminalType Terminal type string yes #1
  • #1 unable to change this section
LAN port setting
Name Description Type Mandatory Remarks
lanPortSettings terminal LAN interface setting array yes
   available true/false boolean yes #13
   name Name string yes
   portVlanNo Untag VLAN Number string yes #14 #15
   tagVlanNo Tag VLAN Number string yes #14 #16
   vlanMode Tagged/Untagged string yes #17
   port Port Number string yes #18
  • #13 Port Enable:true, Unenable:false.
  • #14 Designate out of the 2-4094,(Except 1002-1005 and 2350-2449) Vlan total is until 30 (C4321) and until 10 (C891)
  • #15 Enter only one from 2-4094 by Vlan ID in the case Untag.
  • #16 Available enter maximum 10 , separated commas 2-4094 of Tag Vlan ID.
  • #17 Designate either one or the other "Tagged""Untagged".
  • #18 designate to 1-8. Designate to 1-7 when using terminal redundancy. Designate ASR1K in the case of ASR1K and 3-5 to designate when using teminal redundancy.
VLAN Network Address Setting
Name Description Type Mandatory Remarks
vlanSettings VLAN Network address setting array yes
   ipAddress IP address string no #19
   vlanId VLAN ID string no #14
   subnetMask Subnet mask string no
   available true/false boolean no #20
   name Name string no
   ipAddressPrimary IP Address Primary string no #21
   ipAddressSecondary IP Address Secondary string no #21
   portNo Port number string no #22
   tagging tagged/untagged string no #23
  • #19 When using terminal redundancy response to「ipAddressVip」
  • #20 Enable:true, Un enable:fals
  • #21 Only under using terminal redundancy.
  • #22 Designate 2-5 when using ASR1K, Designate 3-5 in case of ASR1K terminal redundancy. "null" in the case of C4321,C891.
  • #23 Designate to "Tagged","Untagged" when using ASR1K, When using C4321,C891 will be "null".
LAN Routig Setting (Static)
Name Description Type Mandatory Remarks
lanRoutingSettings LAN routing setting(Static) array yes
   name Name string no
   ipAddress Destination IP address string no
   subnetMask Destination IP address(Subnetmask) string no
   gwIpAddress GW Router IP address string no
LAN routing setting (Dynamic)
Name Description Type Mandatory Remarks
lanRoutingSettingDynamic LAN routing setting (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 Interface applicable OSPF array no
         port port number string no #29
         vlan VLAN ID string no #30
      distributionRouteToNetwork Distribution route to Network array no
         name Name string no
         ipAddress IP Address string no
         subnetmask Subnet Mask string no
  • #24 Fixed "fales" when using C891F.
  • #25 Designate to 0-65535
  • #26 Designate one out of the "none","TEXT","MD5"
  • #27 Designate only being selected "TEXT" in authenticationType. "null" in the case designate "none","MD5"
  • #28 Designate only being selected "MD5" in authenticationType. "null" in the case designate "none","TEXT"
  • #29 Designate 3-6 when only using ASR1K. Designate 3-5 in case of terminal redundancy on ASR1K."null" designate in the case C4321.
  • #30 Designate VLAN ID
DHCP
Name Description Type Mandatory Remarks
dhcp DHCP setting object yes
   method Server/Relay/None string yes #31
   server Server object yes
      exclusionRange Exclusion Range string yes #32
      defaultRouter defaultRouter string yes #32
      primaryDns Primary DNS string yes #32
      secondaryDns secondary DNS string yes #32
      domain DHCP Domain string yes #32
      ipAddress DHCP Applicable Network Address(IP address) string yes #32
      subnetMask DHCP Applicable Network Address(subnetMask) string yes #32
      primaryWins Primary WINS string yes #32
      secondaryWins Secondary WINS string yes #32
   relay Relay object yes
      ipAddress1 DHCP Server address 1 string yes #33
      ipAddress2 DHCP Server address 2 string yes #33
      ipAddress2 DHCP Server address 3 string yes #33
      ipAddress2 DHCP Server address 4 string yes #33
  • #31 Designate one out of the"Server""Relay""None"
  • #32 "null"Designate one out of the "Relay""None"
  • #33 "null"Designate one out of the "Server""None"
IP Filtering
Name Description Type Mandatory Remarks
ipFilterings ipFilterings array yes
   portName Target Interface string no #34
   targetInterface Target Interface string no #35
   settings setting array no
      direction IN string no
      destinationIpAddress Destination IP address string no #36
      destinationPortNo Destination port number string no #36
      destinationSubnetMask Destination Subnet Mask string no #36
      protocol Protocol string no #37
      seqNo Priority string no #38
      sourceIpAddress Source IP Address string no #36
      sourcePortNo Source Port Number string no #36
      sourceSubnetMask Source Subnetmask string no #36
      action deny/permit string no
  • #34 Designate to 2-5 when using ASR1K. Degignate to 3-5 when using terminal redundancy on ASR1K."null" when using either one or the other C4321,C891.
  • #35 Designate one out of the setting interface "WAN1""WAN2""VLANXX"(XX:VLAN ID) of IP filtering.
  • #36 Enter of the "any" if you do not designate
  • #37 Designate one out of the tcp/udp/ip.
  • #38 Designate from 1-9999, 60 one each setting.
ToS settings
Name Description Type Mandatory Remarks
tosSettings ToS Settings array yes
   tos ToS string yes #39
   settings Settings array yes
      direction IN string no #1
      seqNo Priority string no #40
      protocol Protocol string no #37
      sourceIpAddress Source IP address string no #36
      sourceSubnetMask Source Subnetmask string no #36
      sourcePort Source Port Number string no #36
      destinationIpAddress Source IP Address string no #36
      destinationPortNo Source Port Number string no #36
      destinationSubnetMask Source Subnetmask string no #36
      action deny/permit string no
  • #39 Default,1-7(Except 6)
  • #40 Designate from 1-9999, 120 one each setting.
QoS
Name Description Type Mandatory Remarks
qos QoS string yes #41
  • #41 QoS(none)/If you selected set by the response to none/4clsss/6class.
Internet Breakout
Name Description Type Mandatory Remarks
internetBreakout Internet breakout setting object yes
   enable true/fals boolean yes
   services breakout with its service array yes
      serviceName Service Name string yes #1 #43
      breakout true/false string no
   applications breakout with its application array no
      name Name string no
      applicationName Application Name string no #44
   specificIpAddress breakout over IP Address array yes
      listId List ID string no Terminal ID+6 digit number
      name Name string no
      ipAddress Destination IP Addredss string no
      netmask Destination subnetmask string no
  • #43 "office365"
  • #44 Degignate from exisiting application list. It will be got "Get application list for API" to applicationName.

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
201 Success
400 Invalid type of parameter
404 AbsentID

Response Parameters

Name Description Type Mandatory Remarks
orderId Order ID string yes 10 digit number

Example Result

{
    "orderId": "9999999999"
}

Put terminal activation

Activate of a terminal.

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

Request Parameters

Name Description Type Mandatory Remarks
contractId Service Contract ID string yes 15 digit number
gwId GW ID string yes T+10 digit number
terminalId Terminal ID string yes D+10 digit number

Example Request

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

{
}

Response Code

Code Description
201 Success
400 Invalid type of parameter
404 AbsentID

Response Parameters

Name Description Type Mandatory Remarks
orderId Order ID string yes 10 digit number

Example Result

{
    "orderId": "9999999999"
}

Put terminal

Change the configuration for a specific terminal.

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

Request Parameters

Name Description Type Mandatory Remarks
contractId Service Contract ID string yes 15 digit number
gwId GW ID string yes T+10 digit number
terminalId terminalID string yes D+10 digit number

※Parts below unable to change the setting at tha same time. Setting change should be initiated by each item.

Circuit information
Name Description Type Mandatory Remarks
wanConfigs Circuit Information array yes
Circuit Information (WAN1)
   circuitTypeWan1 Circuit Type string yes #1
   circuitServiceType Circuit service type string yes #1
   circuitServiceName Circuit service name string yes
   circuitContractId Circuit contract ID string yes
   bandwidth Bandwidth string yes #2
   interfaceSpeed WAN IF (Speed) string yes #3
   interfaceDuplex WAN IF (Duplex) string yes #4
   ipAddress CER WAN port IP address string yes #1
   subnetMask CER WAN port IP address(subnet mask) string yes #1
   routingSetting Routing setting string yes #1
   perWanPortIpAddress PER WAN Port IP Address string yes #1 \
   perBgpAsNo AS numberPER) string yes #1
   cerBgpAsNo AS Number(CER) string yes #1
   defaultGw Default gateway string yes #1
   pppoeId PPPoE ID string yes #1
   pppoePassword PPPoE Password string yes #1
   pppoeAuthenticationMethod PPPoE Method string yes #1
Circuit Information (WAN2)
   circuitTypeWan2 Circuit Type string yes #1
   circuitServiceType CircuitServiceType string yes #1
   circuitServiceName Circuit service name string yes
   circuitContractId Circuit Contract ID string yes
   bandwidth Bandwidth string yes #2
   interfaceSpeed WAN IF (Speed) string yes #5
   interfaceDuplex WAN IF (Duplex) string yes #4
   ipMethod WAN IP setting string yes #6
   ipAddress WAN IP address string yes #7
   subnetMask WAN IP address(subnetmask) string yes #7
   defaultGw Default GW string yes #7
   pppoeId PPPoE ID string yes #8
   pppoePassword PPPoE Password string yes #8
   pppoeAuthenticationMethod PPPoE Method string yes #8 #9
   perWanPortIpAddress PER WAN Port IP Address string yes #1
   perBgpAsNo AS Number(PER) string yes #1
   cerBgpAsNo AS Number(CER) string yes #1
  • #1 Cannot be change.
  • #2 Designate one out of the 1-9999 in case of select "terminalType:C4321". Designate one out of the 1-1000 in case of Select "terminalType:c891F".
  • #3 Designate one out of the "10","100","1000","auto"
  • #4 "full" in case of other than "auto" by interfaceSpeed, "auto" in the case of the interfaceSpeed"auto"
  • #5 Designate in case of terminalType C4321. Designate in the caes of ASR1K: 100,1000,auto. Designate in case of C891:10,100,auto.(can be choose 1000 only in the case of internet single configuration)
  • #6 Designate in case of circuitTypeWan2. Designate in the caes of INTERNET: "PPPoE""StaticIP". Unable to change for settings in the case of VPN on circuitTypeWan2.
  • #7 "null" designate in the case "PPPoE" by ipMethod. Unable to change for settings in the case of VPN on circuitTypeWan2.
  • #8 "null" designate in the case "StaticIP" by ipMethod. Unable to change for settings in the case of VPN on circuitTypeWan2.
  • #9 Designate to "CHAP"
LAN Port Setting
Name Description Type Mandatory Remarks
lanPortSettings terminal LAN interface setting array yes
   available true/false boolean yes #13
   name Name string yes
   portVlanNo Untag VLAN Number string yes #14 #15
   tagVlanNo Tag VLAN Number string yes #14 #16
   vlanMode Tagged/Untagged string yes #17
   port Port Number string yes #18
  • #13 Port Enable:true, Unenable:false.
  • #14 Designate out of the 2-4094,(Except 1002-1005 and 2350-2449) Vlan total is until 30 (C4321) and until 10 (C891)
  • #15 Enter only one from 2-4094 by Vlan ID in the case Untag.
  • #16 Available enter maximum 10 , separated commas 2-4094 of Tag Vlan ID.
  • #17 Designate either one or the other "Tagged""Untagged".
  • #18 Designate 1-8. Designate 1-7 when using terminal redundancy. Designate 3-6 in the case of ASR1K and designate 3-5 when using teminal redundancy.
VLAN Network Address Setting
Name Description Type Mandatory Remarks
vlanSettings VLAN Network address setting array yes
   ipAddress IP address string no #19
   vlanId VLAN ID string no #14
   subnetMask Subnet mask string no
   available true/false boolean no #20
   name Name string no
   ipAddressPrimary IP Address Primary string no #21
   ipAddressSecondary IP Address Secondary string no #21
   portNo Port number string no #22
   tagging tagged/untagged string no #23
  • #19 When using terminal redundancy response to「ipAddressVip」
  • #20 Enable:true, Un enable:fals
  • #21 When only using terminal redundancy.
  • #22 Designate 2-5 when using ASR1K, Designate 3-5 in case of ASR1K terminal redundancy. "null" in the case of C4321,C891.
  • #23 Designate to "Tagged","Untagged" when using ASR1K, When using C4321,C891 is "null".
LAN routing setting (Static)
Name Description Type Mandatory Remarks
lanRoutingSettings LAN Routig Setting (Static) array yes
   name Name string no
   ipAddress Destination NW Address string no
   subnetMask Destination NW Address (Subnet) string no
   gwIpAddress Default GW IP address string no
LAN routing setting (Dynamic)
Name Description Type Mandatory Remarks
lanRoutingSettingDynamic LAN routing setting (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 Interface applicable OSPF array no
         port port number string no #29
         vlan VLAN ID string no #30
      distributionRouteToNetwork Distribution route to Network array no
         name Name string no
         ipAddress IP Address string no
         subnetmask Subnet Mask string no
  • #24 Fixed "fales" when using C891F.
  • #25 Designate to 0-65535
  • #26 Designate one out of the "none","TEXT","MD5"
  • #27 Designate only being selected "TEXT" in authenticationType. "null" in the case designate "none","MD5"
  • #28 Designate only being selected "MD5" in authenticationType. "null" in the case designate "none","TEXT"
  • #29 Designate to 3-6 when only using ASR1K. Designate 3-5 in case of terminal redundancy on ASR1K. "null" designate in the case C4321.
  • #30 Designate VLAN ID
DHCP
Name Description Type Mandatory Remarks
dhcp DHCP setting object yes
   method Server/Relay/None string yes #31
   server Server object yes
      exclusionRange Exclusion Range string yes #32
      defaultRouter DefaultRouter string yes #32
      primaryDns Primary DNS string yes #32
      secondaryDns secondary DNS string yes #32
      domain DHCP Domain string yes #32
      ipAddress DHCP Applicable Network Address(IP address) string yes #32
      subnetMask DHCP Applicable Network Address(subnetMask) string yes #32
      primaryWins Primary WINS string yes #32
      secondaryWins Secondary WINS string yes #32
   relay Relay object yes
      ipAddress1 DHCP Server address 1 string yes #33
      ipAddress2 DHCP Server address 2 string yes #33
      ipAddress2 DHCP Server address 3 string yes #33
      ipAddress2 DHCP Server address 4 string yes #33
  • #31 Designate one out of the"Server""Relay""None"
  • #32 "null"Designate one out of the "Relay""None"
  • #33 "null"Designate one out of the "Server""None"
IP Filtering
Name Description Type Mandatory Remarks
ipFilterings ipFilterings array yes
   portName Target Interface string no #34
   targetInterface Target Interface string no #35
   settings setting array no
      direction IN string no
      destinationIpAddress Destination IP address string no #36
      destinationPortNo Destination port number string no #36
      destinationSubnetMask Destination Subnet Mask string no #36
      protocol Protocol string no #37
      seqNo Priority string no #38
      sourceIpAddress Source IP Address string no #36
      sourcePortNo Source Port Number string no #36
      sourceSubnetMask Source Subnetmask string no #36
      action deny/permit string no
  • #34 Designate to 2-5 when using ASR1K. Degignate to 3-5 when using terminal redundancy on ASR1K."null" when using either one or the other C4321,C891.
  • #35 Designate one out of the setting interface "WAN1""WAN2""VLANXX"(XX:VLAN ID) of IP filtering.
  • #36 Enter of the "any" if you do not designate
  • #37 Designate one out of the tcp/udp/ip.
  • #38 Designate from 1-9999, 60 one each setting.
ToS設定
Name Description Type Mandatory Remarks
tosSettings TOS Settings array yes
   tos TOS string yes #39
   settings Settings array yes
      direction IN string no #1
      seqNo seqNo string no #40
      protocol Protocol string no #37
      sourceIpAddress Source IP address string no #36
      sourceSubnetMask Source Subnetmask string no #36
      sourcePort Source Port Number string no #36
      destinationIpAddress Source IP Address string no #36
      destinationPortNo Source Port Number string no #36
      destinationSubnetMask Source Subnetmask string no #36
      action deny/permit string no
  • #39 Default,1-7(Except 6)
  • #40 Designate from 1-9999, 120 one each setting.
QoS
Name Description Type Mandatory Remarks
qos QoS string yes #41
  • #41 QoS(none)/If you selected set by the response to none/4clsss/6class.
Internet Breakout
Name Description Type Mandatory Remarks
internetBreakout Internet breakout setting object yes
   enable true/fals boolean yes
   services Services array yes
      serviceName Name string yes #1 #43
      breakout true/false string no
   applications Breakout for office365(true/false) array no
      name Name string no
      applicationName Application Name string no #44
   specificIpAddress Specific IP Address array yes
      listId List ID string no ID+6 digit number
      name Name string no
      ipAddress Destination IP Addredss string no
      netmask Destination IP subnetmask string no
  • #43 "office365"
  • #44 Degignate from exisiting application list. It will be got "Get application list for API" to applicationName.
WAN Interface Configuration(Secondary)
Name Description Type Mandatory Remarks
secondaryWanConfigs WAN Interface configuration(Secondary) array no #1
   perBgpAsNo AS number (PER)(Secondary) string no #1
   cerIpAddress CER WAN port IP address(Secondary) string no #1
   cerSubNetmask CER WAN port IP address(Subnetmask)(Secondary) string no #1
   perIpAddress PER WAN port IP address(Secondary) string no #1
   loopbackIpAddress Loopback IP address string no #1
Installation Information
Name Description Type Mandatory Remarks
installationInformation Installation information object yes
   customerPresenceContactInformation Customer presence information string yes #1
   customerPresenceCorpName Customer presence:Corporation name string yes #1
   howToEnter How to enter string yes #1
   customerPresenceCorpNameKana Customer presence:Corporation name(KANA) string yes #1
   installationCorpName Installation cprpration name string yes #1
   workerContactInformation Worker contact information string yes #1
   carInformation Car information string yes #1
   date Confirmed installation date string yes #1
   workerInformation Worker information string yes #1
   customerPresenceSectionName Customer presence:Section name string yes #1
   time Confirmed installation time string yes #1
   customerPresenceName Customer presence:Name string yes #1
   customerPresenceNameKana Customer presence:Name(KANA) string yes #1
Shipping Information
Name Description Type Mandatory Remarks
shippingInformation Shipping information object yes
   address Address string yes #1
   buildingName Building name string yes #1
   email E-mail string yes
   contactTel Phone number string yes
   corpName Corporation name string yes
   corpNameKana Corporation name(KANA) string yes
   country Country string yes #1
   equalInstallAddress Same as installation site boolean yes
   sectionName Section name string yes
   staffName Contact Person string yes
   zipCode ZIP code string yes #1
   foreignFlag Foreign Flag boolean yes
Installation Site
Name Description Type Mandatory Remarks
installationSite Installation site object yes
   address Address string yes
   buildingName Building name string yes
   email E-mail string yes
   contactTel Phone number string yes
   corpName Corporation name string yes
   corpNameKana Corporation name(Kana) string yes
   country Country string yes
   sectionName Section name string yes
   staffName Section name string yes
   zipCode ZIP code string yes
Basic Information
Name Description Type Mandatory Remarks
basicInformation Basic Information object yes
   terminalContractType Terminal order type string yes #1
   terminalType Terminal type string yes #1
   terminalConstructionType Construction method string yes #1
   installRequestedDate Installation requested date string yes #1
   installRequestedTimeSlot Installation requested time string yes #1
   installRequestedTimeZone Installation requested time(Time Zone) string yes #1
   onSiteRepairOption On-site repair option boolean yes #1
   rackMount Ruck mountkit(true/false) string yes #1
   primary primary Terminal object no #1 #45
      luggageTrackingNo luggage tracking number string yes #1
      serialNo Serial number string yes #1
   secondary serondary terminal object no #1 #45
      luggageTrackingNo luggage tracking number string no #1 #45
      serialNo Serial number string no #1 #45
  • #45 Only use when a terminal redundancy.
Others
Name Description Type Mandatory Remarks
redundancyOption Terminal redundancy option string yes #1
secondaryTerminalId Terminal ID (Secondary) string yes D+10 digit number #45 #1
gwId GW ID string yes T+10 digit number #1
terminalId Terminal ID string yes D+10 digit number #35 #1
terminalGroupId Terminal Group ID string yes 10 digit number
remarks Remarks string yes
name Name string yes
secondaryName Terminal Name (Secondary) string yes #45
gwId GW ID string yes #1
orderStatus Order status string yes #1
status terminal Status string yes #1
secondaryStatus Order status secondary string yes #1 #45
interLinkIpAddress Terminal redundancy IP address string yes #1 #45
interLinkSubnetMask Terminal redundancy IP address(Subnetmask) string yes #1 #45
preConfigureError Preconfiguration error(true/false) boolean yes
  • #45 Only terminal redundancy.
  • #46 Tag name "primaryTerminalID" is used at the time of terminal redundancy.

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 Success
400 Invalid type of parameter
404 AbsentID

Response Parameters

Name Description Type Mandatory Remarks
orderId Order ID string yes 10 digit number

Example Result

{
    "orderId": "9999999999"
}

Put terminal (Route reflection of Office365)

Reflect for internet breakout.
office365 connection is updated automatically once a day.

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

Request Parameters

Name Description Type Mandatory Remarks
contractId Service contract ID string yes 15 digit number
gwId GW ID string yes T+10 digit number
terminalId Terminal ID string yes D+10 digit number

Example Request

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

{
}

Response Code

Code Description
202 Success
400 Invalid type of parameter
404 AbsentID

Response Parameters

Name Description Type Mandatory Remarks
orderId Order ID string yes 10 digit number

Example Result

{
    "orderId": "9999999999"
}

Put terminal (Application definition file Update)

Update a terminal Application definition file.

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

Request Parameters

Name Description Type Mandatory Remarks
contractId Service contract ID string yes 15 digit number
gwId GW ID string yes T+10 digit number
terminalId Terminal ID string yes D+10 digit number

Example Request

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

{
}

Response Code

Code Description
200 Success
400 Invalid type of parameter
404 Absent ID

Response Parameters

Name Description Type Mandatory Remarks
orderId Order ID string yes 10 digit number

Example Result

{
    "orderId": "9999999999"
}

Get terminal list

Returns the list and summary for a terminal.

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

Request Parameters

Name Description Type Mandatory Remarks
contractId Service contract ID string yes 15 digit number
gwId GW contract ID string yes T+10 digit number

Example Request

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

Response Code

Code Description
200 Success
400 Invalid type of parameter
404 AbsentID

Response Parameters

Name Description Type Mandatory Remarks
gwId GW ID string yes T+10 digit number
teminals Terminal information array yes
   name Name string yes
   terminalId Terminal ID string yes D+10 digit number #1
   orderStatus Order status of terminal string yes Response #2
   basicInformation Basic information object yes
      install RequestedDate Installation requested date object yes
      terminalGroupId Terminal group ID string yes 10 digit number
   status Order status string yes Response #3
   installationSite Installation site information object yes
      address Address string yes
      buildingName Building name string yes
   secondaryTerminalId Terminal ID(Secondary) string no D+10 digit number #4
  • #1 "primaryTerminalID" is response to use at the time of terminal redundancy.
  • #2 Processing,Completion,Error,Cancellation
  • #3 Processing,Kitting, Deliverd, Activated, WaitingSendBack/SendBack:abolished
  • #4 Responding when only using terminal redundancy.

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 terminal

Terminate a terminal subscription.

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

Request Parameters

Name Description Type Mandatory Remarks
contractId Service contract ID string yes 15 digit number
gwId GW ID string yes T+10 digit number
terminalId Terminal ID string yes D+10 digit number

Example Request

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

Response Code

Code Description
200 Success
400 Invalid type of parameter
404 Absent ID

Response Parameters

Name Description Type Mandatory Remarks
orderId Order ID string yes 10 digit number

Example Result

{
    "orderId": "9999999999"
}

Put a terminal information registration

Resigter a collection date and place after the terminal delition.

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

Requst Parameters

Name Description Type Mandatory Remarks
contractId service contract ID string yes 15 digit number
gwId GW ID string yes T+10 digit number
terminalId Terminal ID string yes D+10 digit number

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 Success
400 Invalid type of parameter
404 Absent ID

Response Parameters

Name Description Type Mandatory Remarks
orderId Order ID string yes 10 digit number

Example Result

{
    "orderId": "9999999999"
}

Post terminal group

Create for a terminal group

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

Request Parameters

Name Description Type Mandatory Remarks
contractId Service contract ID string yes 15 digit number
Name Description Type Mandatory Remarks
name Name string yes

Example Request

POST /v1/sdns/contracts/99999999999999/terminal_groups

{
    "name": "Test1"
}

Response Code

Code Description
200 Success
400 Invalid type of parameter
404 Absent ID

Response Parameters

Name Description Type Mandatory Remarks
orderId Order ID string yes 10 digit number
orderId Order ID string yes 10 digit number

Example Result

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

Get terminal group list

Returns the list and summary for a terminal group list.

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

Request Parameters

Name Description Type Mandatory Remarks
contractId Service contract ID string yes 15 digit number

Example Request

GET /v1/sdns/contracts/999999999999999/terminal_groups

Response Code

Code Description
200 Success
400 Invalid type of parameter
404 Absent ID

Response Parameters

Name Description Type Mandatory Remarks
terminalGroups Terminal group information array yes
   terminalGroupId Terminal group ID string yes 10 digit number
   name Name string yes
contractId Service contract ID string yes 15 digit number

Example Result

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

Put terminal group

Change the terminal group settings.

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

Request Parameters

Name Description Type Mandatory Remarks
contractId Service contract ID string yes 15 digit number
terminalGroupId Terminal group ID string yes 10 digit number
Name Description Type Mandatory Remarks
name Name string yes

Example Request

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

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

Response Code

Code Description
202 Success
400 Invalid type of parameter
404 Absent ID

Response Parameters

Name Description Type Mandatory Remarks
orderId Order ID string yes 10digit number

Example Resul

{
        "orderId": "9999999999"
}

Delete Terminal Group

Delete the teminal group.

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

Request Parameters

Name Description Type Mandatory Remarks
contractId Service contract ID string yes 15 digit number
terminalGroupId Terminal group ID string yes 10 digit number

Example Request

DELETE /v1/sdns/contracts/99999999999999/terminal_groups/9999999999

Response Code

Code Description
200 Success
400 Invalid type of parameter
404 Absent ID

Response Parameters

Name Description Type Mandatory Remarks
orderId Order ID string yes 10digit number

Example Result

{
        "orderId": "9999999999"
}

Get terminal monitoring status

Return the terminal monitoring status(monitored/unmonitored).

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

Request Parameters

Name Description Type Mandatory Remarks
contractId Service contract ID string yes 15 digit number
gwId GW ID in which the terminal is located string yes T+10 digit number
terminalId terminal ID string yes D+10 digit number

Example Request

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

Response Code

Code Description
200 Success
400 Invalid type of parameter
404 Absent ID

Response Parameters

Name Description Type Mandatory Remarks
status Terminal monitoring status number yes Response #1
  • #1 0:Monitoring,1:Not monitoring(Before activation),2:Not monitoring

Example Result

{
 "status": 2
}

Get terminal monitoring status list

Retrun the terminal monitoring status list.

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

Request Parameters

Name Description Type Mandatory Remarks
contractId Service contract ID string yes 15 digit number

Example Request

GET /v1/sdns/contracts/999999999999999/monitoring

Response Code

Code Description
201 Success
400 Invalid type of parameter
404 Absent ID

Response Parameters

Name Description Type Mandatory Remarks
time time string yes
status terminal monitoring status string yes #1
terminalId terminal ID string yes D+10 digit number
userId customer ID (Orderer email address) string yes
  • #1 0:Monitoring,1:Not monitoring(Before activation),2:Not monitoring

Example Result

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

Put terminal monitoring status

Change the terminal monitoring status(monitored/unmonitored).

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

Request Parameters

Name Description Type Mandatory Remarks
contractId Service contract ID string yes 15 digit number
gwId GW ID in which the terminal is located string yes T+10 digit number
terminalId Terminal ID string yes D+10 digit number
status Terminal monitoring status number yes #1
  • #1 0:monitoring,1:not monitoring(Before activation)2:not monitoring

Example Request

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

{
 "status": 2
}

Response Code

Code Description
200 Success
400 Invalid type of parameter
404 Absent ID

Get terminal status

Return the terminal status.

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

Request Parameters

Name Description Type Mandatory Remarks
contractId service contract ID string yes 15 digit number
gwId GW ID string yes T+10 digit number
terminalId Terminal ID string yes D+10 digit number
from Start of date and time string yes JST time in iso 8601 format #1 #2 #3
to End of date and time string yes JST time in iso 8601 format #1 #2 #3
  • #1 Ex:2017-04-01T00:00:00
  • #2 Information order than 93days from the current time can not be got.
  • #3 The difference between from and to must be within 24 hours.

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 Success
400 Invalid type of parameter
404 AbsentID

Response Parameters

Name Description Type Mandatory Remarks
time Time string no JST time in iso 8601 format #1 #4
status Terminal status number no Response #5 #6
  • #4 The terminal status is got and accumulated every 5 minutes.
  • #5 0:Up, 2000:Down(WAN1), 3000:Down(WAN2), 4000:partial(LAN), 9000:Disconnected
  • #6 Only under using terminal redundancy 5001:Down(HA-link1), 5002:Down(HA-link2), 5100:Down(All HA-link), 8001:Down(primary), 8002:Down(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 terminal status list

Return the terminal status list.

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

Request Parameters

Name Description Type Mandatory Remarks
contractId service contract ID string yes 15 digit number
from Get info after a specific time string no JST time in iso 8601 format #1
to Get info after a specific time string no JST time in iso 8601 format #1
to Get info after a specific time string no JST time in iso 8601 format #1
only_change Get info if only had status change string no
  • #1 ex: 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 Success
400 Invalid type of parameter
404 AbsentID

Response Parameters

Name Description Type Mandatory Remarks
time Getting time string no JST time in iso 8601 format #1 #2
status Terminal status number no #3 #4
  • #1 Ex:2017-04-01T00:00:00
  • #2 Will occurred only logs within 3 hours.
  • #3 0:Up, 2000:Down(WAN1), 3000:Down(WAN2), 4000:partial(LAN), 9000:Disconnected
  • #4 Only under using terminal redundancy 5001:Down(HA-link1), 5002:Down(HA-link2), 5100:Down(All HA-link), 8001:Down(primary), 8002:Down(Secondary)

Example Request

{
  "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" },
}

Get terminal status detail

Return the terminal status detail.

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

Request Parameters

Name Description Type Mandatory Remarks
contractId service contract ID string yes 15 digit number
gwId GW ID in which the terminal is localed string yes T+10 digit number
terminalId Terminal ID string yes D+10 digit number

Example Request

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

Response Code

Code Description
200 Success
400 Invalid type of parameter
404 Absent ID

Response Parameters

Name Description Type Mandatory Remarks
detail Responding the terminal status object yes
   contractId Contract ID string yes
   gwId GW ID string yes
   terminalId terminal ID string yes
   time time string yes
   connectivity connectivity string yes
   errerReason error reason string yes
   wanInterface WAN Interface object yes
      wan1 WAN1 array yes
      wan2 WAN2 array yes
      type Underlay/Overlay string yes
      port Port (Interface number/Tunnel) string yes
      config Setting(Down/Up) string yes
      status Status(Down/Up) string yes
   lanInterfaces LAN Interface status object yes
      port Port (Interface number) string yes
      config Config (Down/Up) string yes
      status Status (Down/Up) string yes
   underlayStatus Underlay status array yes
      interface Interface(wan1/wan2) string yes
      lineType Circuit type (MPLS/Internet) string yes
      pingStatus Ping status string yes
      pingGw Ping GW string yes
      bgpStatus BGP status string yes
      bgpUpTime BGP UpTime string yes
      pppoeStatus PPPoE status string yes
   overlayStatus Overlay status array yes
      bgpPath WAN Circuit info string yes
      bgpStatus BGP status string yes
      bgpUpTime BGP uptime string yes
   ipFilterCounters IP Filtering array yes
      interface Interface(wan1/wan2/vlan) string yes
      settings Contents array yes
         action deny/parmit string yes
         protocol Protocol string yes
         srcIpaddress Source IP address string yes
         srcSubnetMask Source SubnetMask string yes
         srcPortNo Source port number string yes
         dstIpaddress Destination IP address string yes
         dstSubnetMask Destination subnetmask string yes
         dstPortNo Destination port number string yes
         count number of packets string yes
   pppoeStatus PPPoE status (Up/Down) string yes
   ospfStatus ospf status array yes
      neighborId Neighbor ID string yes
      status Full/BDR string yes
      neighborAddress Neighbor Address string yes
      port port (Interface number/vlan number) string yes
      upTime Uptime string yes
   terminalHistory terminal history object yes
      reload Reload string yes
      lastConfigChange Last configuration change 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"
    }
  }
}

Get traffic information(at 5 minutes intervals)

Returns terminal traffic information(at 5 minutes intervals).

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

Request Parameters

Name Description Type Mandatory Remarks
contractId Service contract ID string yes 15 digit number
gwId GW ID string yes T+10 digit number
terminalId Terminal ID string yes D+10 digit number
port WAN port string yes #1
from Start of date and time string yes JST time in iso 8601 format #2 #3 #4
to End of date and time string yes JST time in iso 8601 format #2 #3 #4
  • #1 Designate wan1 or wan2
  • #2 Ex:2017-04-01T00:00:00
  • #3 Information older than 93 days from the current time can not be got.
  • #4 The difference between from and to must be within 24 hours.

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 Success
400 Invalid type of parameter
404 Absent ID

Response Parameters

Name Description Type Mandatory Remarks
time Gettng time string no JST time in iso 8601 format #2 #5
avgInTraffic Average amount of traffic on the receiving side for
port(bps)
number no Effective digits 2
digits
avgOutTraffic Average amount of traffic on the sender side for
port(bps)
number no Effective digits 2
digits
  • #5 The traffic information is got and accumulated every 5 minutes.

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
    }
]

Get traffic information(at 1 day intervals)

Returns terminal traffic information (minimum/maximum/average at 1 day intervals)
* Date and time can be specified.

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

Request Parameters

Name Description Type Mandatory Remarks
contractId Service contract ID string yes 15 digit number
gwId GW ID string yes T+10 digit number
terminalId Terminal ID string yes D+10 digit number
port WAN port string yes #1
from Start of date and time string yes JST time in iso 8601 format #2 #3 #4
to End of date and time string yes JST time in iso 8601 format #2 #3 #4
  • #1 Designate wan1(VPN)or wan2(Internet)
  • #2 Ex: 2017-04-01T00:00:00
  • #3 Information older than 365 days from the current time can not be got.
  • #4 The difference between 'from' and 'to' must be within 31 days.

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 Success
400 Invalid type of parameter
404 Absent ID

Response Parameters

Name Description Type Mandatory Remarks
time Getting time string no JST time in iso 8601 format #2 #5
avgInTraffic Average amount of traffic per day on the receiving
side for port(bps)
string no Effective digits 2
digits
avgOutTraffic Average amount of traffic per day on the sender side
for port(bps)
string no Effective digits 2
digits
maxInTraffic Maximum amount of traffic per day on the receiving
side for port(bps)
string no Effective digits 2
digits
maxOutTraffic Maximum amount of traffic per day on the sender side
for port(bps)
string no Effective digits 2
digits
minInTraffic Minimum amount of traffic per day on the receiving
side for port(bps)
string no Effective digits 2
digits
minOutTraffic Minimum amount of traffic per day on the sender side
for port(bps)
string no Effective digits 2
digits
  • #5 The Traffic information is got and accumulated every 1 day.

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
    }
]

Get error information (at 5 minutes intervals)

Return the terminal Error information (at 5 minutes intervals)
* Time and date can be specified.

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

Request Parameters

Name Description Type Mandatory Remarks
contractId Service contract ID string yes 15 digit number
gwId GW ID string yes T+10 digit number
terminalId Terminal ID string yes D+10 digit number
port WAN port string yes #1
from Start of date and time string yes JST time in iso 8601 format #2 #3 #4
to End of date and time string yes JST time in iso 8601 format #2 #3 #4
  • #1 Designate wan1 or wan2
  • #2 Ex:2017-04-01T00:00:00
  • #3 Information older than 93 days from the current time can not be got.
  • #4 The difference between from and to must be within 24 hours.

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 Success
400 Invalid type of parameter
404 Absent ID

Response Parameters

Name Description Type Mandatory Remarks
time Gettng time string no JST time in iso 8601 format #2 #5
avgInDiscard Average amount of discard packets on the receiving side for
port(bps)
number no Effective digits 2
digits
avgOutDiscard Average amount of discard packets on the sender side for
port(bps)
number no Effective digits 2
digits
avgInError Average amout of error packets on the
sender side for the port(pps)
number no Effective digits 2
digits
avgOutError Average amout of error packets on the
sender side for the port(pps)
number no Effective digits 2
digits
  • #5 The traffic information is got and accumulated every 5 minutes.

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"
    }
]

Get error information (at 1 day intervals)

Return the terminal error information (minimum/maximum/average at
1 day intervals)
* Time and date can be specified.

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

Request Parameters

Name Description Type Mandatory Remarks
contractId Service contract ID string yes 15 digit number
gwId GW ID string yes T+10 digit number
terminalId Terminal ID string yes D+10 digit number
port WAN port string yes #1
from Start of date and time string yes JST time in iso 8601 format #2 #3 #4
to End of date and time string yes JST time in iso 8601 format #2 #3 #4
  • #1 Designate wan1(VPN)or wan2(Internet)
  • #2 Ex: 2017-04-01T00:00:00
  • #3 Information older than 365 days from the current time can not be got.
  • #4 The difference between 'from' and 'to' must be within 31 days.

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 Success
400 Invalid type of parameter
404 Absent ID

Response Parameters

  

Name Description Type Mandatory Remarks
time Getting time string no JST time in iso 8601 format #2 #5
avgInDiscard Average value of the number of discard packets on the
receiving side for the port(pps)
number no Effective digits 2
digits
avgOutDiscard Average value of the number of discard packets on the
sender side for the port(pps)
number no Effective digits 2
digits
avgInError Average value of the number of error packets on the
receiving side for the port(pps)
number no Effective digits 2
digits
avgOutError Average value of the number of error packets on the
sender side for the port(pps)
number no Effective digits 2
digits
maxInDiscard Maximum value of the number of discard packets on
the receiving side for the port(pps)
number no Effective digits 2
digits
maxOutDiscard Maximum value of the number of discard packets on
the sender side for the port(pps)
number no Effective digits 2
digits
maxInError Maximum value of the number of error packets on the
receiving side for the port(pps)
number no Effective digits 2
digits
maxOutError Maximum value of the number of error packets on the
sender side for the port(pps)
number no Effective digits 2
digits
minInDiscard Minimum value of the number of discard packets on
the receiving side for the port(pps)
number no Effective digits 2
digits
minOutDiscard Minimum value of the number of discard packets on
the sender side for the port(pps)
number no Effective digits 2
digits
minInError Minimum value of the number of error packets on the
receiving side for the port(pps)
number no Effective digits 2
digits
minOutError Minimum value of the number of error packets on the
sender side for the port(pps)
number no Effective digits 2
digits

  • #5 The Traffic information is got and accumulated every 1 day.

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
    }
]

Get application information(at 5 minutes intervals)

Return the terminal application information (at 5 minutes intervals) * Time and date can be specified.

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

Request Parameters

Name Description Type Mandatory Remarks
contractId Service contract ID string yes 15 digit number
gwId GW ID string yes T+10 digit number
terminalId Terminal ID string yes D+10 digit number
unit Aggregate unit of flow string yes #7
direction IN/OUT string yes
port WAN port string yes #1
from Start of date and time string yes JST time in iso 8601 format #2 #3 #4
to End of date and time string yes JST time in iso 8601 format #2 #3 #4
tos ToS string no #5
src_ip_addr Surce IP address string no
src_ip_mask Surce IP address(subnetmask) string no
dst_ip_addr Destination IP address string no
dst_ip_mask Destination IP address(subnetmask) string no
dst_port Destination Port number string no
protocol Protocol string no #6
application_id Application ID string no
  • #1 Designate one out of the "tunnel1","tunnel2","wan2","ppp2"
  • #2 Ex: 2017-04-01T00:00:00
  • #3 Information older than 93 days from the current time can not be got.
  • #4 The difference between 'from' and 'to' must be within 31 days.
  • #5 -1(ToS:None),Default,1-7(Except 6).Available multiple.
  • #6 Available multiple.
  • #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 Success
400 Invalid type of parameter
404 Absent ID

Response Parameters

Name Description Type Mandatory Remarks
time Time string no JST time in iso 8601 format #1 #2
avgBit Average amount of flow for bit(bps) number no Effective digits 2
digits
avgPacket Average amount of flow for packet(bps) number no Effective digits 2
digits
count Counting of flow number no
  • #1 Ex: 2017-04-01T00:00:00
  • #2 The traffic information is got and accumulated every 5 minutes.

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
    }
]

Get traffic details

Return the traffic details of terminal.

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

Request Parameters

Name Description Type Mandatory Remarks
contractId Service Contract ID string yes 15 digit number
gwId GW ID string yes T+10 digit number
terminalId Terminal ID string yes D+10 digit number
direction in/out string yes
port Interface ID string no #1
from from string no JST time in iso 8601 format #2
to to string no #2
dscp dscp string no
src_ip_addr Source IP Address string no
dst_ip_addr Destination IP Address string no
src_ip_mask Source IP Address string no
dst_ip_mask Dest IP Subnetmask string no
src_port Source Port Number string no
dst_port Destination Port Number string no
protocol Protocol string no #4
application_id Application ID string no
application_name Application Name string no
limit Response total order number no #5 Integer
continue degignate token string no
  • #1 Designate one out of the "tunnel1""tunnel2""wan2""ppp2".
  • #2 Ex: 2017-04-01T00:00:00
  • #3 Ex: 8,16
  • #4 Designate one out of the "tcp""udp""ip".
  • #5 Upper limit is 5000

Example Request

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

Response Code

Code Description
200 Success
400 Invalid type of parameter
404 Absent ID

Response Parameters

Name Description Type Mandatory Remarks
srcIpAddr Source IP Address string no
terminalId Terminal ID string no
applicationId Application ID string no
packets Packets string no
srcPort Source Port Number string no
protocol Protocol string no
dscp dscp string no
port Interface string no
dstIpAddr Destination IP Address string no
bytes Bytes string no
dstPort Destination Port Number string no
time Time string no
customerId Customer ID string no
networkDelaySample Network Delay Sample string no
networkDelaySum Network Delay Total 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 Application list

Return the application list

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

Request Parameters

Name Description Type Mandatory Remarks
contractId Service Contract ID string yes 15 digit number

Example Request

GET /v1/sdnscontracts/99999999999999/applications

Response Code

Code Description
200 Success
400 Invalid type of parameter
404 Absent ID

Response Parameters

Name Description Type Mandatory Remarks
applicationId Application ID string no
applicationName Application Name string no
description 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"
  }
]

Get traffic ranking

Return the traffic ranking.

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

Request Parameters

Name Description Type Mandatory Remarks
contractId Service Contract ID string yes 15 digit number
gwId GW ID string yes T+10 digit number
terminalId Terminal ID string yes D+10 digit number
direction in/out string yes #1
property Property string yes #2
port Interface Number string no #3
from from string no #4
to to string no #4
tos tos string no #5
src_ip_addr Source IP Address string no
dst_ip_addr Destination IP Address string no
src_port Source Port Number string no
dst_port Destination Port Number string no
protocol Protocol string no #6
application_id Application ID string no #7
application_name Application Name string no #8
size Ranking number string no #9
  • #1 Designate responding information either one the other "in" or "out"
  • #2 Source IP Address(IPv4)"src_ip_addr"、Destination IP Address(IPv4)"dst_ip_addr"、 Application ID"application_id"、Application Name"application_name"、Source Port Number"src_port"、Destination Port Number"dst_port"、ToS"tos"
  • #3 Designate one out of the "tunnel1"、"tunnel2"、"wan2"、"ppp2"
  • #4 Ex:"YYYY-MM-DDT00:00:00+09:00"
  • #5 Designate one out of the 0-7, designate -1 in case of none tos.
  • #6 Designate one out of the "tcp""udp""icmp"
  • #7 Designate application ID if you want to get traffic.
  • #8 Designate application name if you want to get traffic.
  • #9 Designate one out of the 1-100 if you want to get ranking number.

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 Success
400 Invalid type of parameter
404 Absent ID

Response Parameters

Name Description Type Mandatory Remarks
srcIpAddr Source IP Address string no
rankings Rank string no
description 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 latency Specifics

Get the terminal latency details.

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

Request Parameters

Name Description Type Mandatory Remarks
contractId service contract ID string yes 15 digit number
gwId GW ID string yes T+10 digit number
terminalId terminal ID string yes D+10 digit number
from starting time string no #1
to Ending time string no #1
src_ip_addr Source IP address string no
dst_ip_addr destination IP address string no
src_ip_mask Source subnet mask string no
dst_ip_mask destination Subnet mask string no
src_port Source Port Number string no
dst_port destination Port number string no
application_id Application ID string no #2
  • #1 Ex:"YYYY-MM-DDT00:00:00+09:00"
  • #2 Designate application ID which is desired getting traffic.

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 Success
400 Invalid type of parameter
404 Absent ID

Response Parameters

Name Description Type Mandatory Remarks
avgApplicationDelay Average responding time for server application string no
avgServerNetworkDelay Router~server avarage connection time string no
avgClientNetworkDelay Client~Router avarage connection time string no

Example Result

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

Get connection quality

Return latency, Jitter, Packet loss Rate on terminal.

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

Request Parameters

Name Description Type Mandatory Remarks
contractId Service contract ID string yes 15 digit number
gwId GW ID string yes T+10 digit number
terminalId Terminal ID string yes D+10 deigit number
port Interface string no #1
from Starting time string no #2
to Ending time string no #2
interval_min Designate aggregation interval string no #3
  • #1 Designate either one or the othe"tunnel1","tunnel2"
  • #2 Ex:"YYYY-MM-DDT00:00:00+09:00"
  • #3 Designate aggreagation interval by the minutes

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 Success
400 Invalid type of parameter
404 Absent ID

Response Parameters

Name Description Type Mandatory Remarks
time time string no
networkDelayPerPacket latency string no
packetsLostRate packet loss rate string no
rtpJitterMean jitter string no

Example Result

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

Get multipass info

Return a multipath information.

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

Request Parameters

Name Description Type Mandatory Remarks
contractId Service contract ID string yes 15 digit number
from from string no #1
to to string no #1

※Ex:"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 Success
400 Invalid type of parameter
404 Absent ID

Response Parameters

Name Description Type Mandatory Remarks
time Incident occurence time string no
terminalId terminalID string no
reason Switching reason string no
originalIf Original pass string no
newIf new pass string no
flow Communication flow string no
applicationId application ID string no
applicatioName application Name 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 Interconnection

Order for the interconnection option.

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

Request Parameters

Name Description Type Mandatory Remarks
contractId Service contract Id string yes 15 digit number
gwId GW ID string yes T+10 digit number
Name Description Type Mandatory Remarks
connectionParameters Connection Parameters object yes
   vpnNo VPN Number string yes V+8 digit number
   representativeNNo Representative N Number string yes N+9 digit number
   name Name string yes
   remarks Remarks string yes
   bandwidth Bandwidth string yes #1
  • #1 Designate either one or the other "100","1000" and Specify the same band as when GW application is made.

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 Success
400 Invalid type of parameter
404 Absent ID

Response Parameters

Name Description Type Mandatory Remarks
interconnectionId Interconnection ID string yes U+10 digit number
orderId Order ID string yes 10 digit number

Example Result

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

Get Interconnection details

Returns Interconnection details.

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

Request Parameters

Name Description Type Mandatory Remarks
contractId Service contract Id string yes 15 digit number
gwId GW ID string yes T+10 digit number
interconnectionId Interconnection ID string yes U+10 digit number

Example Request

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

Response Code

Code Description
200 Success
400 Invalid type of parameter
404 Absent ID

Response Parameters

Name Description Type Mandatory Remarks
connectionParameters contracted interconnections list array yes
      name Name string yes
      vpnNo VPN number string yes V+8 digit number
      representativeNNo Representative N Number string yes N+9 digit number
      multiCloudConnectNNo Multi Cloud Connect N Number string yes N+9 digit number
      remarks Remarks string yes
      orderStatus Order Status string yes #1
   bandwidth bandwidth string yes
  • #1 Processing, Completion, Error, Canceled

Example Result

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

Get Interconnection list

Return the list and summary for API Interconnection Option.

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

Request Parameters

Name Description Type Mandatory Remarks
contractId service contruct ID string yes 15 digit number
gwId GW ID string yes T+10 digit number

Example Request

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

Response Code

Code Description
201 Success
400 Invalid type of parameter
404 Absent ID

Response Parameters

Name Description Type Mandatory Remarks
gwId GW ID string yes T+10 digit number
interconnections Interconections array yes
   connectionParameters Connection Parameters object yes
   interconnectionId Interconnection ID object yes U+10 digit number
      name Name string yes
      vpnNo VPN number string yes V+8 digit number
      representativeNNo Representative N Number string yes N+9 digit number
      multiCloudConnectNNo Multi Cloud Connect N Number string yes N+9 digit number
      remarks Remarks string yes
      orderStatus Order Status string yes #1
      bandwidth Bandwidth string yes
  • #1 Processing, Completion, Error, Cancellation

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 interconnection

Change settings for an interconnection option.

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

Request Parameters

Name Description Type Mandatory Remarks
contractId Service contract ID string yes 15 digit number
gwId GW ID string yes T+10 digit number
interconnectionId Interconnection ID string yes U+10 digit number
Name Description Type Mandatory Remarks
   connectionParameters Interconnection detail object yes
      vpnNo VPN number string yes V+8 digit number #1
      multiCloudConnectNNo Multi cloud connect N number string yes N+9 digit number
   representativeNNo Representative N Number string yes N+9 digit number
      name Name string yes
      remarks Remarks string yes
      orderStatus Interconnection order status string yes #1
   bandwidth Bandwidth string yes #1
  • #1 Cannot be changed.

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 Success
400 Invalid type of parameter
404 Absent ID

Response Parameters

Name Description Type Mandatory Remarks
orderId Order ID string yes 10 digit number

Example Result

{
    "orderId": "9999999999"
}

Delete interconnection

Terminate interconnection option.

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

Request Parameters

Name Description Type Mandatory Remarks
contractId Service contract ID string yes 15 digit number
gwId GW ID string yes T+10 digit number
interconnectionId Interconnection ID string yes U+10 digit number

Example Request

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

Response Code

Code Description
200 Success
400 Invalid type of parameter
404 Absent ID

Response Parameters

Name Description Type Mandatory Remarks
orderId Order ID string yes 10 digit number

Example Result

{
    "orderId": "9999999999"
}

Post managed opstion

Order for managed option.

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

Request Parameters

Name Description Type Mandatory Remarks
contractId Service Contract ID string yes 15 digit number
Name Description Type Mandatory Remarks
name Managed option name string yes #1
projectId Project ID string yes MG+8 digit number
serviceStartRequestedDate Secvice Start Requested Date string yes #2
  • #1 "Operation Management","Reaction Plan","Initial Settings","Delivery Management","Config by Agent".
  • #2 "YYYY-MM-DD" to designate.

Example Request

POST /v1/sdns/contracts/99999999999999/managed_options

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

Response Code

Code Description
201 Success
400 Invalid type of parameter
404 Absent ID

Response Parameters

Name Description Type Mandatory Remarks
managedOptionId Managed Option ID string yes M+10 digit number
orderId Order ID string yes 10 digit number

Example Result

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

Get managed option list

Return maneged option list.

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

#### Request Parameters
Name Description Type Mandatory Remarks
contractId service contract number string yes 15 digit number

Example Request

GET /v1/sdns/contracts/999999999999999/managed_options

Response Code

Code Description
200 Success
400 Invalid type of parameter
404 Absent ID

Response Parameters

Name Description Type Mandatory Remarks
managedOptions Managed options array yes
   serviceStartDate Service start date string no
   name Name string no
   projectId Project ID string no MG+8 digit number
   serviceStartRequestedDate Service start requested date string no
   status Order status of Managed option string no Response #1
  • #1 Processing, Completion, Error, Cancellation

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 managed option

Terminate managed option.

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

Request Parameters

Name Description Type Mandatory Remarks
contractId Service Contract ID string yes 15 digit number
managedOptionId Managed option ID string yes M+10 digit number

Example Request

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

Response Code

Code Description
200 Success
400 Invalid type of parameter
404 Absent ID

Response Parameters

Name Description Type Mandatory Remarks
orderId Order ID string yes 10 digit number

Example Result

{
    "orderId": "9999999999"
}
GET /v1/sdns/contracts/{contractId}/orders

Get order

Return the order detailes.

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

Request Parameters

Name Description Type Mandatory Remarks
contractId Service contract ID string yes 15 digit number
orderId Order ID string yes 10 digit number

Example Request

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

Response Code

Code Description
200 Success
400 Invalid type of parameter
404 Absent ID

Response Parameters

Name Description Type Mandatory Remarks
orderAcceptTime Order date and time string yes JST time in iso 8601 format #1
orderLastUpdateTime Completion date and time string yes JST time in iso 8601 format #1
orderServiceType Service type string yes #2
orderApplicationType Contents string yes #3
  • #1 Ex: 2017-04-01T00:00:00
  • #2 For Response Parameters other than the above, refer to Response Parameters of each API according to the value responded with orderServiceType.(Initial Subscription API: Terminal: terminal basic information acquisition API, Gateway: GW individual information acquisition API, Interconnection Option: Interconnection list information acquisition API, Managed Option: Managed option list acquisition API)
  • #3 New,Change,Termination

Example the result

The result of the acquisiton order information of the basic contract

{
  "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": "xxxxxxTokyo", 
        "buildingName": "xxxxxxBuilding" 
   },
    "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": "xxxxxxTokyo", 
        "buildingName": "xxxxxx"
    }, 
    "technicalContactPerson": {
        "equalContractor": true, 
        "corpName": "xxxxxx", 
        "corpNameKana": "xxxxxx", 
        "sectionName": "xxxxxx", 
        "staffName": "xxxxxx", 
        "contactTel": "9999-999-999",
        "email": "xxxxxx@xxx.xxx"
    }, 
}

Get Order list

Return the order detailes.

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

Request Parameters

Name Description Type Mandatory Remarks
contractId Service contract ID string yes 15 digit number
sorting Response order string no #1
count Response total order number no #2 integer
offset Response per one time number no #2 integer
terget Designate filtering ID string no #3
status Designate filtering order status string no #4
name Designate name string no
  • #1 Ascendig order:asc, Descending order:desc
  • #2 Designated start number of the order list.
    Ex:Responded if ordering 2 times seperately 50 each, total 100 order.Order separately 50 each out of 100 in 2 times
    First time: designate either one or the other count:50,offset:0 Result:Respond to order 1-50
    Second time: designate either one or the other count:50,offset:50 Result:Respond to order 51-100
  • #3 Designate narrowing down contract ID, GW, ID, Interconnect ID, terminal ID, Managed option ID
  • #4 Designate narrowing down a order status one out of the "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 Success
400 In the case of incorrect parameters or offset is larger than exist orders.
404 Absent ID

Response Parameters

Name Description Type Mandatory Remarks
contractId Service contract ID string yes 15 digit number
orders Orders array yes
   orderId Order ID string no 10 digit number
   acceptTime Order date and time string no JST time in iso 8601 format #1
   applicationType Contents string no #2
   remarks Remarks string no
   lastUpdateTime Completion date and time string no JST time in iso 8601 format #1
   serviceType Service Type string no #3
   status Order status string no #4
   errorCode Error code string no
   errorMessage Error message string no
   object Object string no
orderCount Number of order string yes
  • #1 Ex: 2017-04-01T00:00:00
  • #2 New, Change, Termination
  • #3 Initial Subscription, Terminal, Gateway, Interconnection Option, Managed Option
  • #4 Processing, Completion, Error, Cancellation

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. Dec. 2014 currently, DNS round robin operation is working. In the future, API request will automatically connect to geographically close API gateway.