Overview
Network Administrators can use variety of APIs on the Software-Defined Network Service（SD-NS）.
SD-NS provides the following features;
- Enabling easy access for customer's cloud environment, Arcstar Universal One site, or series of web services.
- Provide more efficientry network that enable to use these as Active-Active with dedicated terminal on your each of site to connect VPN/Internet.
- Our web portal and APIs provide centrized administrative control function that enable to set up and manage the virtual network.
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
Below is the list of APIs that administrator can use on SD-NS.
| API |
Description |
Method |
| Contract informatin |
|
|
| 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 |
Retrieve numbers of basic contracts GW,interconnections, managed options and terminals. |
GET |
| Get contract summary |
Returns a list and summary for a contracted items.(items include contracts of GW, interconnections, and terminals) |
GET |
| GW |
|
|
| Post GW |
Order for a GW. |
POST |
| Get GW details |
Returns the configuration for a specific GW. |
GET |
| Put GW |
Modify 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 |
Modify a terminal order. |
PUT |
| Put terminal order cancel |
Cancel of a terminal order. |
PUT |
| Get terminal detail |
Retrieve the detail information of 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 configration |
Modify the configuration for a specific terminal. |
PUT |
| Put terminal configuration (Route reflection of Office365) |
Reflect the Office 365 route for the internet breakout. |
PUT |
| Put terminal configration (Update an application definition file) |
Update a terminal Application definition file terminal application definition file. |
PUT |
| Get terminal list |
Returns the list and summary for a terminal. |
GET |
| Terminate terminal |
Application for terminating a terminal subscription. |
PUT |
| Put terminal collection 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 |
Modify 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 |
Switch the terminal monitoring status(monitored/unmonitored). |
PUT |
| Get terminal status |
Return the terminal status(Under operation/out of order). |
GET |
| Get terminal status list |
Return the terminal status list(Under operation/out of order). |
GET |
| Get terminal status detail |
Return the terminal status detail. |
GET |
| Statistics |
|
|
| Get traffic information (at 5 minutes intervals) |
Return the terminal traffic information (avarage at 5 minutes intervals)
|
GET |
| Get traffic information (at 1-day intervals) |
Return the terminal traffic information (minimum/maximum/average at 1 day intervals)
|
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)
|
GET |
| Get application information (at 5 minutes intervals) |
Return the terminal application information (at 5 minutes intervals)
|
GET |
| Get traffic details |
Return the traffic information of terminal with specified detail conditions. |
GET |
| Get application list |
Return an available application list. |
GET |
| Get application group list |
Return an available application group list |
GET |
| Get traffic ranking |
Return the traffic ranking with specified confitions. |
GET |
| Get terminal resource |
Return the terminal resource information such as CPU utilization. |
GET |
| Get latency Specifics |
Return the value of latency details |
GET |
| Get connection quality |
Return latency, Jitter, Packet loss rate on terminal |
GET |
| Get multipath switching infomation |
Return a multipath switching information |
GET |
| Interconnection |
|
|
| Post interconnection |
Order for an interconnection option. |
POST |
| Get interconnection details |
Return the interconnection details informations. |
GET |
| Get interconnection list |
Return the interconnection informaion as a list. |
GET |
| Put interconnection setting |
Modify the settings for an interconnection option. |
PUT |
| Delete interconnection |
Application of 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 |
Application of terminating managed option |
DELETE |
| Order history |
|
|
| Get order details |
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 depend on the customer's stuation that which site 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 required to specified one out of jp|us|uk.
- e.g. https://us.api.ntt.com/v1/sdns
- Specifiable regions will be expanded in the future
| Key |
Value |
| Request Format |
JSON |
| Response Format |
JSON |
| Authentication (OAuth) |
Yes |
Get basic contract
This API return a basic contract information.
GET /v1/sdns/contracts/{contractId}
Request Parameters
| Name |
Description |
Type |
Mandatory |
Remarks |
| contractId |
Service Contract ID |
string |
yes |
15 digits number |
Example Request
GET /v1/sdns/contracts/999999999999999
Response Code
| Code |
Description |
| 200 |
Success |
| 400 |
Invalid type of parameter |
| 404 |
Absent IDs that specified or combined |
Response Parameters
| Name |
Description |
Type |
Mandatory |
Remarks |
| customerId |
Customer Id |
string |
yes |
C＋10 digits 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 |
|
| emailCc |
E-mail CC |
string |
yes |
|
| zipCode |
ZIP Code |
string |
yes |
|
| address |
Address |
string |
yes |
|
| buildingName |
Adress (such as Adress (such as Building Name ,etc..) ,etc..) |
string |
yes |
|
| name |
Name |
string |
yes |
|
| salesChannelCode |
Sales Channel Code |
string |
yes |
|
| remarks |
Remarks |
string |
yes |
|
| billingAddress |
Billing Address |
object |
yes |
|
| equalContractor |
Equal to Contructor |
boolean |
yes |
|
| corpName |
Company Name |
string |
yes |
|
| corpNameKana |
Company Name (Fullwidth forms of 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 |
Adress (such as Building Name ,etc..) |
string |
yes |
|
| technicalContactPerson |
Technical Contact Person |
object |
yes |
|
| equalContractor |
Same as contract person |
boolean |
yes |
|
| corpName |
Company Name |
string |
yes |
|
| corpNameKana |
Company Name(Fullwidth forms of 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 |
|
| emailCc |
E-mail CC |
string |
yes |
|
Example Result
{
"customerId": "C9999999999",
"contractor": {
"sectionName": "xxxxxxdepartment",
"staffName": "xxxxxx",
"contactTel": "9999-999-9999",
"email": "xxxxxx@xxx.xxx",
"emailCc": "xxxxxx@xxx.xxx;xxxxxx@xxx.xxx"
"zipCode": "9999999",
"address": "xxxxxxTokyo",
"buildingName": "xxxxxxbuilding"
},
"name": "SD-NSxxxxxx",
"salesChannelCode": "999999",
"remarks": "memoxxxxxx",
"corpName": "xxxxxx",
"billingAddress": {
"equalContractor": true,
"corpName": "xxxxxxCo.Ltd.,",
"corpNameKana": "xxxxxx",
"sectionName": "xxxxxxdepartment",
"staffName": "xxxxxx",
"contactTel": "9999-999-999",
"email": "xxxxxx@xxx.xxx",
"emailCc": "xxxxxx@xxx.xxx;xxxxxx@xxx.xxx"?
"zipCode": "9999999",
"address": "xxxxxxTokyo",
"buildingName": "xxxxxxbuilding"
},
"technicalContactPerson": {
"equalContractor": true,
"corpName": "xxxxxxCo.Ltd.,",
"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 digits number |
| Name |
Description |
Type |
Mandatory |
Remarks |
| contractor |
Contractor |
object |
yes |
|
| zipCode |
ZIP Code |
string |
yes |
|
| address |
Address |
string |
yes |
|
| buildingName |
Adress (such as Building Name ,etc..) |
string |
yes |
|
| sectionName |
Department Name |
string |
yes |
|
| staffName |
Contact Person |
string |
yes |
|
| contactTel |
Phone Number |
string |
yes |
|
| emailCc |
E-mail CC |
string |
yes |
#1 |
| 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 person |
boolean |
yes |
#2 #3 |
| zipCode |
ZIP Code |
string |
yes |
|
| address |
Address |
string |
yes |
|
| buildingName |
Adress (such as Building Name ,etc..) |
string |
yes |
|
| corpName |
Company Name |
string |
yes |
|
| corpNameKana |
Company Name (Fullwidth forms of 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 person |
boolean |
yes |
#2 #3 |
| corpName |
Company Name |
string |
yes |
|
| corpNameKana |
Company Name (Fullwidth forms of Kana) |
string |
yes |
|
| sectionName |
Department Name |
string |
yes |
|
| staffName |
Contact Person |
string |
yes |
|
| contactTel |
Phone Number |
string |
yes |
|
| email |
E-mail |
string |
yes |
|
| emailCc |
E-mail CC |
string |
yes |
#1 |
| corpName |
E-mail |
string |
no |
#2 |
- #1 E-mail Adress sould be seperate with ";" and may regyst up to 10.
- #2 Cannot be modified.
- #3 Due to the value of the "true/false" is responsed to equalContractor's value, even if when customer execute application with selecting "false" on manual and input same information as the Contractor, the responding is as "fales".
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",
"emailCc": "xxxxxx@xxx.xxx;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",
"emailCc": "xxxxxx@xxx.xxx;xxxxxx@xxx.xxx"
}
}
Response Code
| Code |
Description |
| 202 |
Success |
| 400 |
Invalid type of parameter |
| 404 |
Absent IDs that specified or combined |
Response Parameters
| Name |
Description |
Type |
Mandatory |
Remarks |
| orderId |
Order ID |
string |
yes |
10 digits number |
Example Result
{
"orderId": "9999999999"
}
Delete basic contract
Application of terminating basic contract of SD-NS.
DELETE /v1/sdns/contracts/{contractId}
Request Parameters
| Name |
Description |
Type |
Mandatory |
Remarks |
| contractId |
Contract ID |
string |
yes |
15 digits number |
Example Request
DELETE /v1/sdns/contracts/999999999999999
Response Code
| Code |
Description |
| 200 |
Success |
| 400 |
Invalid type of parameter |
| 404 |
Absent IDs that specified or combined |
Response Parameters
| Name |
Description |
Type |
Mandatory |
Remarks |
| orderId |
Order ID |
string |
no |
10 digits number |
Example Result
{
"orderId": "9999999999"
}
Get contract items
This APIs returns a number of contracts for GW,interconnection, Managed options and terminals.
GET /v1/sdns/contracts/{contractId}/counts
Request Parameters
| Name |
Description |
Type |
Mandatory |
Remarks |
| contractId |
Contract ID |
string |
yes |
15 digits number |
Example Request
GET /v1/sdns/contracts/999999999999999/counts
Response Code
| Code |
Description |
| 200 |
Success |
| 400 |
Invalid type of parameter |
| 404 |
Absent IDs that specified or combined |
Response Parameters
| Name |
Description |
Type |
Mandatory |
Remarks |
| terminalCount |
Terminal Count |
number |
yes |
|
| contractId |
Contract ID |
string |
yes |
15 digits number |
| gwCount |
GW Count |
number |
yes |
|
| interconnectionCount |
Interconnection contruct 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 of contracted infomations.
GET /v1/sdns/contracts/{contractId}/summary
Request Parameters
| Name |
Description |
Type |
Mandatory |
Remarks |
| contractId |
Service contract ID |
string |
yes |
15 digits number |
Example Request
GET /v1/sdns/contracts/999999999999999/summary
Response Code
| Code |
Description |
| 200 |
Success |
| 400 |
Invalid type of parameter |
| 404 |
Absent IDs that specified or combined |
Response Parameters
Interconnection options
| Name |
Description |
Type |
Mandatory |
Remarks |
| interconnections |
The list of interconnection options |
array |
yes |
|
| gwId |
GW ID |
string |
no |
T+10 digits number |
| name |
Name |
string |
no |
|
| vpnNo |
VPN number |
string |
no |
V+8 digits number |
| representativeNNo |
Representative N number |
string |
no |
N+9 digits number |
| multiCloudConnectNNo |
Multi-Cloud connect N number |
string |
no |
N+9 digits number |
| orderStatus |
Order status of interconnections |
string |
no |
Response #1 |
- #1 Processing, Completed, Error, Cancellaion.
GW
| Name |
Description |
Type |
Mandatory |
Remarks |
| gateways |
The list of contract gateways |
array |
yes |
|
| gwId |
GW ID |
string |
no |
T+10 digits 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 digits number |
| terminalId |
Terminal ID |
string |
no |
D+10 digits number #3 |
| status |
Status |
string |
no |
Response #4 |
| orderStatus |
Terminal order status |
string |
no |
Response #5 |
| installRequestedDate |
Delivery installation requested date |
string |
no |
yyyy-mm-dd |
| secondaryTerminalId |
Terminal ID(Secondary) |
string |
no |
D+10 digits number #6 |
| name |
Name |
string |
no |
|
| terminalType |
Terminal Type |
string |
no |
|
| terminalGroupId |
Terminal group ID |
string |
no |
|
| address |
Address |
string |
no |
|
| buildingName |
Adress (such as Building Name ,etc..) |
string |
no |
|
- #3 Respond to PrimaryTerminalID when teiminal use redundancy circuit.
- #4 Processing: Changing, Kitting, Delivery, Activation.
- #5 Processing, Completion, Error, Cancellation.
- #6 Responding when terminal use redundancy circuit only.
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": "xxxxxxTOKYO-to,
"buildingName": "xxxxxxbuilding"
}
]
}
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 digits 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 digits number |
| representativeNNo |
Representative N Number |
string |
yes |
N+9 digits number |
| name |
Name |
string |
yes |
|
| remarks |
Remarks |
string |
no |
|
- #1 Designate to "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 IDs that specified or combined |
Response Parameters
| Name |
Description |
Type |
Mandatory |
Remarks |
| gwId |
GW ID |
string |
yes |
T+10 digits number |
| orderId |
Order ID |
string |
yes |
10 digits 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 digits number |
| gwId |
GW ID |
string |
yes |
T+10 digits number |
Example Request
GET /v1/sdns/contracts/999999999999999/gateways/T9999999999
Response Code
| Code |
Description |
| 200 |
Success |
| 400 |
Invalid type of parameter |
| 404 |
Absent IDs that specified or combined |
Response Parameters
| Name |
Description |
Type |
Mandatory |
Remarks |
| gwId |
GW ID |
string |
yes |
T+10 digits 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 digits number |
| representativeNNo |
Representative N number |
string |
yes |
N+9 digits number |
| name |
Identification 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 |
Identification Name |
string |
yes |
|
| tos |
ToS |
string |
yes |
#2 |
| primaryPath |
Primary Path |
string |
yes |
|
| secondaryPath |
Secondary Path |
string |
yes |
|
| policy |
Policy |
string |
yes |
|
| loss |
Packet loss value |
string |
yes |
|
| latency |
Latency |
string |
no |
|
| jitter |
Jitter |
string |
no |
|
| tosSettings |
ToS Settings |
array |
yes |
|
| tos |
ToS value |
string |
yes |
#2 |
| settings |
Settings |
array |
yes |
|
| direction |
IN/OUT |
string |
no |
|
| seqNo |
Sequence No. |
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 |
|
| sitePrefixSetting |
site orefix setting |
object |
yes |
|
| type |
setting type |
string |
yes |
|
| sitePrefixLists |
site prefix lists |
array |
yes |
|
| prefixIpAddress |
IP address |
string |
yes |
|
| prefixSubnetMask |
subnet mask |
string |
yes |
|
- #1 Processing, Completion, Error, Cancellation
- #2 ToS value is as default,from 0 to 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": "WAN1",
"secondaryPath": "WAN2",
"policy": "custom",
"loss": "1.25",
"latency": "65535",
"jitter": "100"
},
],
"tosSettings": [
{
"tos":"7",
"settings": [
{
"direction": "in",
"seqNo": "51",
"protocol": "tcp",
"sourceIpAddress": "99.99.99.99",
"sourceSubnetMask": "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":"0",
"settings": [
]
}
],
"sitePrefixSetting": {
"type": manual,
"sitePrefixLists": [
{
"prefixIpAddress": "1.0.0.0",
"prefixSubnetMask": "8"
}
]
}
}
Put GW
Modify 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 digits number |
| gwId |
GW ID |
string |
yes |
T+10 digits number |
| Name |
Description |
Type |
Mandatory |
Remarks |
| gwId |
GW ID |
string |
yes |
T+10 digits 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 digits number #1 |
| representativeNNo |
Representative N Number |
string |
yes |
N+9 digits number #1 |
| name |
Name |
string |
yes |
|
| remarks |
Remarks |
string |
yes |
|
| orderStatus |
GW Order Status |
string |
yes |
#1 #2 |
| multipathControl |
Multipath Control |
array |
yes |
#14 |
| seqNo |
Priority |
string |
yes |
#3 |
| applicationName |
Application Name |
string |
yes |
#15 |
| name |
Identification Name |
string |
yes |
|
| tos |
ToS |
string |
yes |
#1 |
| primaryPath |
Primary Path |
string |
yes |
#4 |
| secondaryPath |
Secondary Path |
string |
yes |
#4 |
| policy |
Policy |
string |
yes |
#5 |
| loss |
Packet loss value |
string |
yes |
#6 |
| latency |
Latency |
string |
yes |
#7 |
| jitter |
Jitter |
string |
yes |
#8 |
| tosSettings |
ToS Settings |
array |
yes |
#1 #14 |
| 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 |
|
| sitePrefixSetting |
site prefix setting |
object |
yes |
|
| type |
setting type |
string |
yes |
#16 |
| sitePrefixLists |
site prefix lists |
array |
yes |
#18 |
| prefixIpAddress |
IP address |
string |
yes |
#17 |
| prefixSubnetMask |
subnet mask |
string |
yes |
#17 |
- #1 Cannot be Modified.
- #2 Processing, Completio, Error, Cancellation
- #3 Input the value of apprication priority is following; In case of get prefered over ToS: Input 1 to 2000. In case of the prefer ToS: Input 3001 to 5000. In case of Input ToS value: Tos6:2010, Tos5:2020, ToS4: 2030, ToS3:2040,ToS2:2050,ToS1:2060,ToS0:2070. The total input value is up to 60.
- #4 Designate either one or the other "WAN1","WAN2"
- #5 Designate one out of the default/Real-time-video/Voice/Best-effort/custom.
- #6 Depend on the value of choice on policy.Default:100,Real-time-video/Voice:1,Best-effort:10,custom:1.00-100.00 (Designated to until two decimal places)
- #7 Depend on the value of choice on policy. Designate as following; Default:None,Real-time-video/Voice:150,Best-effort:500,custom:1-65535
- #8 Depend on the value of choice on policy. Designate as following; Default:None,Real-time-video/Voice:20,Best-effort:None,custom:1-200
- #9 The value of ToS is default, Designate from 1 to 7(Except 6).
- #10 Settings may contain the items up to 120 on each of ToS and the total 7 of ToSs may contain 840 setting items. If administrator input the setting items moreover, return the error.
- #11 Seqence No. may input from 1 to 9999. If the value already entry is equal to new input, return error.
- #12 Designate one out of the tcp/udp/ip.
- #13 Input "any" if you do not designate.
- #14 Doesn't update the Multhpath Setting and ToS Setting at the same time.
- #15 Designate "null" for application name in case of configure the malti-path setting with specify ToS value.
- #16 Specify "manual" if you edit the siteprefix. In case of take advantage of exsisting setting, specify "preset".
- #17 Specify Siteprefix(IP address, subnet mask) if you select "manual" on type.
- #18 siteprefixlist settig allows the the value from 0 to 32 items.
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": [
]
}
],
"sitePrefixSetting": {
"type": manual,
"sitePrefixLists": [
{
"prefixIpAddress": "1.0.0.0",
"prefixSubnetMask": "8"
}
}
]
}
Response Code
| Code |
Description |
| 202 |
Success |
| 400 |
Invalid type of parameter |
| 404 |
Absent IDs that specified or combined |
Response Parameters
| Name |
Description |
Type |
Mandatory |
Remarks |
| orderId |
Order ID |
string |
yes |
10 digits 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 digits number |
Example Request
GET /v1/sdns/contracts/999999999999999/gateways
Response Code
| Code |
Description |
| 200 |
Success |
| 400 |
Invalid type of parameter |
| 404 |
Absent IDs that specified or combined |
Response Parameters
| Name |
Description |
Type |
Mandatory |
Remarks |
| gateways |
Gateways |
array |
yes |
|
| gwId |
GW ID |
string |
yes |
T+10 digits number |
| name |
Identification Name |
string |
yes |
|
| region |
GW setting Region |
string |
yes |
|
| bandwidth |
Bandwidth |
string |
yes |
|
| terminalConnectionNw1 |
Terminal Connection NW(VPN) |
string |
yes |
|
| vpnNo |
VPN Number |
string |
yes |
V+8 digits number |
| representativeNNo |
Representative N Number |
string |
yes |
N+9 digits number |
| terminalConnectionNw2 |
Terminal Connection NW(Internet) |
string |
yes |
|
| remarks |
Remarks |
string |
yes |
|
| orderStatus |
GW 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
Order the Terminatation of the GW.
DELETE /v1/sdns/contracts/{contractId}/gateways/{gwId}
Request Parameters
| Name |
Description |
Type |
Mandatory |
Remarks |
| contractId |
Service Contract ID |
string |
yes |
15 digits number |
| gwId |
GW ID |
string |
yes |
T+10 digits number |
Example Request
DELETE /v1/sdns/contracts/999999999999999/gateways/T9999999999
Response Code
| Code |
Description |
| 200 |
Success |
| 400 |
Invalid type of parameter |
| 404 |
Absent IDs that specified or combined |
Response Parameters
| Name |
Description |
Type |
Mandatory |
Remarks |
| orderId |
Order ID |
string |
yes |
10 digits 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 digits number |
| gwId |
GW ID |
string |
yes |
T+10 digits number |
| 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 |
Rack mount kit(true/false) |
boolean |
yes |
|
- #2 Designate one out of the "A100", "A300","A500"
- #3 Designate 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.
| Name |
Description |
Type |
Mandatory |
Remarks |
| installationSite |
Installation Site Information |
object |
yes |
|
| foreignFlag |
Needs of shipping for out of sea(false) |
boolean |
yes |
#8 |
| country |
Country |
string |
yes |
#9 |
| zipCode |
ZIP Code |
string |
yes |
|
| address |
Address |
string |
yes |
|
| buildingName |
Adress (such as Building Name ,etc..) |
string |
yes |
|
| corpName |
Company Name |
string |
yes |
|
| corpNameKana |
Company Name (Fullwidth forms of 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.
| Name |
Description |
Type |
Mandatory |
Remarks |
| shippingInformation |
Terminal shipping Information |
object |
yes |
|
| foreignFlag |
false |
boolean |
yes |
#8 |
| country |
Japan |
string |
yes |
#9 |
| zipCode |
ZIP Code |
string |
yes |
|
| address |
Address |
string |
yes |
|
| buildingName |
Adress (such as Building Name ,etc..) |
string |
yes |
|
| corpName |
Company Name |
string |
yes |
|
| corpNameKana |
Company Name (Fullwidth forms of Kana) |
string |
yes |
|
| sectionName |
Department Name |
string |
yes |
|
| staffName |
Contact Parson |
string |
yes |
|
| contactTel |
Phone Number |
string |
yes |
|
| email |
E-mail |
string |
yes |
|
| Name |
Description |
Type |
Mandatory |
Remarks |
| wanConfigs |
Settings of WAN interface on terminal |
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 |
WAN IP adress |
string |
yes |
#15 |
| subnetMask |
WAN IP adress subnet |
string |
yes |
#15 |
| routingSetting |
Routing setting |
string |
yes |
#16 |
| defaultGw |
Default GW |
string |
yes |
#17 |
| perBgpAsNo |
AS Number(PER) |
string |
yes |
#18 |
| cerBgpAsNo |
AS Number(CER) |
string |
yes |
#18 |
| perWanPortIpAddress |
WAN IP adress(PER) |
string |
yes |
#18 |
| pppoeId |
PPPoE ID |
string |
yes |
#20 |
| pppoePassword |
PPPoE Password |
string |
yes |
#20 |
| pppoeAuthenticationMethod |
PPPoE Authentication method |
string |
yes |
#21 |
| mssSetting |
MSS setting |
boolean |
yes |
#25 |
| WAN2Circuit Information |
|
|
|
|
| circuitTypeWan2 |
Circuit type |
string |
yes |
#22 |
| 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 |
#23 |
| interfaceDuplex |
WAN IF (Duplex) |
string |
yes |
#14 |
| ipAddress |
WAN IP adress |
string |
yes |
#15 |
| subnetMask |
WAN IP adress subnet mask |
string |
yes |
#15 |
| defaultGw |
Default GW |
string |
yes |
#17 |
| perBgpAsNo |
AS number (PER) |
string |
yes |
#18 |
| cerBgpAsNo |
AS number (CER) |
string |
yes |
#18 #24 |
| perWanPortIpAddress |
WAN IP adress(PER) |
string |
yes |
#18 |
| ipMethod |
WAN IP Method |
string |
yes |
#19 |
| pppoeId |
PPPoE ID |
string |
yes |
#20 |
| pppoePassword |
PPPoE Password |
string |
yes |
#20 |
| pppoeAuthenticationMethod |
PPPoE authentification method |
string |
yes |
#21 |
| mssSetting |
MSS Setting |
boolean |
yes |
#26 |
- #10 Designate "Null" for circuitTypeWan1 with selecting terminalType"A100". Designate "Internet" with selecting terminalType "A100" or "A300" when using double constitution to internet of WAN, other than that "VPN".
- #11 Designate either one or the other "ntt_japan","other_japan".
- #12 Designate from 1 to 1000.
- #13 Designate from "10","100","1000","auto".
- #14 Designate "auto" when selecting interfaceSpeed is "auto", other than that "full".
- #15 Designate subnetmask when selecting CircuitTyoeWAN is "VPN. In case of select "StaticIP" for "INTERNET", other than "null".
- #16 In case of circuitServiceType is "other_japan", select one from "BGP","Static".
- #17 Designate Default GW in case of selecting circuitTypeWan is "VPN" with choosing "static" for routingSetting, and selecting "INTERNET" with choosing "VPN" for circuitTyoeWan, other than designate "null" for default GW.
- #18 Designate from "1 to 65535" in case of selecting "VPN" for circuitTypeWAN with choosing "static" for routingsetting, other than "null".
- #19 Select each of one from "StaticIP" or "PPPoE" when choose "INTERNET" for circuitTypeWan, other than "null".
- #20 PPPoE Password is required to designate if you select "INTERNET" for circuitTypeWan with choosing "PPPoE" for routingMethod, other than "null".
- #21 Designate "CHAP" for PPPoE authenticication method in case of selecting "INTERNET" for circuitTypeWan with choosing "PPPoE" for routingMethod, other than "null".
- #22 Designate "VPN" for circuitTypeWan2 when you select "A500" for terminalType with using double VPN cuicuit of WAN, other than "INTERNET".
- #23 Select one from "10","100","1000","auto".
- #24 Input same BGP number when both of 2 curcuits of WAN are VPN.
- #25 Designate "MSS Setting" in case of selecting circuitTypeWan1 is "Internet" with choosing "static" for routingSetting, other than designate "false" for MSS Setting.
- #26 Designate MSS Setting" in case of selecting circuitTypeWan2 is "Internet" with choosing "staticIP" for ipMethod, other than designate "false" for MSS Setting.
Others
| Name |
Description |
Type |
Mandatory |
Remarks |
| redundancyOption |
Needs of redundancy Option(true/false) |
string |
yes |
#26 |
| name |
Identification Name |
string |
yes |
#27 |
| terminalGroupId |
Terminal Group ID |
string |
yes |
10 digits number |
| gwId |
GW ID |
string |
yes |
|
| remarks |
Remarks |
string |
no |
|
| interLinkIpAddress |
IP address for Terminal Redundancy |
string |
no |
#28 |
| interLinkSubnetMask |
IP subnetmask for Terminal Redundancy |
string |
no |
#29 |
| secondaryName |
Terminal Secondary Terminal Name for case of Terminal Reduandancy |
string |
no |
#30 |
- #27 Designate "primaryName" in case of redundancyOption: "true".
- #28 Designate this parameter only for redundancyOption" is true".
Example Request
POST /v1/sdns/contracts/999999999999999/gateways/T9999999999/terminals
{
"name": "SD-NS_Terminal_xxxxxx",
"redundancyOption":false
"basicInformation": {
"terminalType": "A300",
"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,
"mssSetting": false
},
{
"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,
"mssSetting": true
}
]
}
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 digits number #31 |
| orderId |
Order ID |
string |
yes |
10 digits number |
- #31 In the case of the rezundancyOption is "true", terminalid would be response either one or the other "primaryTerminalId" or "secondaryTerminalId".
Example Result
{
"terminalId":"D9999999999",
"orderId":"9999999999"
}
Put terminal order change
Modify 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 digits number |
| gwId |
GW ID |
string |
yes |
T+10 digits number |
| terminalId |
Terminal ID |
string |
yes |
D+10 digits number |
| 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 |
|
| Name |
Description |
Type |
Mandatory |
Remarks |
| installationSite |
Installation Site Information |
object |
yes |
|
| foreignFlag |
Needs for overseas shipping(false) |
boolean |
yes |
#1 |
| country |
Country |
string |
yes |
#1 |
| zipCode |
ZIP Code |
string |
yes |
|
| address |
Address |
string |
yes |
|
| buildingName |
Adress (such as Building Name ,etc..) |
string |
yes |
|
| corpName |
Company Name |
string |
yes |
|
| corpNameKana |
Company Name (Fullwidth forms of Kana) |
string |
yes |
|
| sectionName |
Department Name |
string |
yes |
|
| staffName |
Contract Parson |
string |
yes |
|
| contactTel |
Phone Number |
string |
yes |
|
| email |
E-mail |
string |
yes |
|
| Name |
Description |
Type |
Mandatory |
Remarks |
| shippingInformation |
Shipping Information |
object |
yes |
|
| foreignFlag |
Needs of overseas shipping (false) |
boolean |
yes |
#1 |
| country |
Country |
string |
yes |
#1 |
| zipCode |
ZIP Code |
string |
yes |
|
| address |
Address |
string |
yes |
|
| buildingName |
Adress (such as Building Name ,etc..) |
string |
yes |
|
| corpName |
Company Name |
string |
yes |
|
| corpNameKana |
Company Name (Fullwidth forms of Kana) |
string |
yes |
|
| sectionName |
Department Name |
string |
yes |
|
| staffName |
Contact Parson |
string |
yes |
|
| contactTel |
Phone Number |
string |
yes |
|
| email |
E-mail |
string |
yes |
|
| Name |
Description |
Type |
Mandatory |
Remarks |
| wanConfigs |
Setting of WAN interface on terminal |
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 |
|
| 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 |
#3 |
| 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 |
|
| mssSetting |
MSS Setting |
boolean |
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 |
#4 |
| 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 |
|
| mssSetting |
MSS Setting |
boolean |
yes |
|
- #3 enable to set BGP only when cirunitTypeWan1 is MPLS and mplsBrakigout is true.
- #4 enable to set BGP only when cirunitTypeWan2 is MPLS and mplsBrakigout is true.
Settings of WAN interface (Secondary)
| Name |
Description |
Type |
Mandatory |
Remarks |
| secondaryWanConfigs |
Settings of WAN interface (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 |
Identification Name |
string |
yes |
#2 |
| terminalGroupId |
Terminal Group ID |
string |
yes |
10 digits number |
| gwId |
GW ID |
string |
yes |
T＋10 digits 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 Designate "primaryName"in the case of "redundancyOption is "true".
Example Request
PUT /v1/sdns/contracts/999999999999999/gateways/T9999999999/terminals/D9999999999/revise
{
"name": "SD-NS_Terminal_xxxxxx",
"redundancyOption":false,
"basicInformation": {
"terminalType": "A300",
"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,
"mssSetting": false
},
{
"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,
"mssSetting": false
}
],
"secondaryName": "-"
}
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 digits number |
Example Result
{
"orderId": "9999999999"
}
Put terminal order cancel
You may cancel of terminal order with this API before SD-NS terminal is delivered.
PUT /v1/sdns/contracts/{contractId}/gateways/{gwId}/terminals/{terminalId}/cancel
Request Parameters
| Name |
Description |
Type |
Mandatory |
Remarks |
| contractId |
Service Contract ID |
string |
yes |
15 digits number |
| gwId |
GW ID |
string |
yes |
T+10 digits number |
| terminalId |
Terminal ID |
string |
yes |
D+10 digits 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 |
Absent ID that soecified or combined. |
Response Parameters
| Name |
Description |
Type |
Mandatory |
Remarks |
| orderId |
Order ID |
string |
yes |
10 digits 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 digits number |
| gwId |
GW ID |
string |
yes |
T+10 digits number |
| terminalId |
Terminal ID |
string |
yes |
D+10 digits number |
Example Request
GET /v1/sdns/contracts/999999999999999/gateways/T9999999999/terminals/D9999999999
Response Code
| Code |
Description |
| 200 |
Success |
| 400 |
Invalid type of parameter |
| 404 |
Absent ID that specified or combined |
Response Parameters
| Name |
Description |
Type |
Mandatory |
Remarks |
| wanConfigs |
Settings of WAN interface on terminal |
array |
yes |
|
| Circuit Information (WAN1) |
|
|
|
|
| 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 |
WAN IP adress |
string |
yes |
|
| subnetMask |
WAN IP adress subnet |
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 |
WAN IP adress(PER) |
string |
yes |
|
| pppoeId |
PPPoE ID |
string |
yes |
|
| pppoePassword |
PPPoE Password |
string |
yes |
|
| pppoeAuthenticationMethod |
PPPoE Authentication method |
string |
yes |
|
| mssSetting |
MSS Setting |
boolean |
yes |
|
| Circuit Information (WAN2) |
|
|
|
|
| circuitTypeWan2 |
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 |
WAN IP adress |
string |
yes |
#15 |
| subnetMask |
WAN IP adress subnet mask |
string |
yes |
|
| defaultGw |
Default GW |
string |
yes |
|
| perBgpAsNo |
AS number (PER) |
string |
yes |
|
| cerBgpAsNo |
AS number (CER) |
string |
yes |
|
| perWanPortIpAddress |
WAN IP adress(PER) |
string |
yes |
|
| ipMethod |
WAN IP Method |
string |
yes |
|
| pppoeId |
PPPoE ID |
string |
yes |
|
| pppoePassword |
PPPoE Password |
string |
yes |
|
| pppoeAuthenticationMethod |
PPPoE authentification method |
string |
yes |
|
| mssSetting |
MSS Setting |
boolean |
yes |
|
LAN Port Setting
| Name |
Description |
Type |
Mandatory |
Remarks |
| lanPortSettings |
LAN port setting |
array |
yes |
|
| available |
true/false |
boolean |
yes |
|
| name |
Identification Name |
string |
yes |
|
| portVlanNo |
Untag VLAN No |
string |
yes |
|
| tagVlanNo |
Tag VLAN No |
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 |
Identification Name |
string |
no |
|
| ipAddress |
Destination IP address |
string |
no |
|
| subnetMask |
Destination IP address(Subnet Mask) |
string |
no |
|
| gwIpAddress |
Default 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 |
Identification Name |
string |
no |
|
| ipAddress |
IP Address |
string |
no |
|
| subnetMask |
Subnet Mask |
string |
no |
|
- #2 Display if "gauthenticationType" is selected as "text".
- #3 Display if "gauthenticationType" is select as "MD5".
LAN default route setting
| Name |
Description |
Type |
Mandatory |
Remarks |
| lanDefaultRouteSetting |
Lan default route setting |
object |
yes |
|
| available |
true/fales |
boolean |
yes |
|
| nexthopIpAddress |
Next hop IP address |
object |
yes |
|
DHCP
| Name |
Description |
Type |
Mandatory |
Remarks |
| dhcpServer |
DHCP setting |
object |
yes |
|
| method |
Server/Relay/None |
string |
yes |
|
| server |
Server |
object |
yes |
|
| exclusionRange |
Exclusion Range |
string |
yes |
#4 |
| defaultRouter |
Default Router adress |
string |
yes |
#4 |
| primaryDns |
Primary DNS adress |
string |
yes |
#4 |
| secondaryDns |
Secondary DNS adress |
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 adress |
string |
yes |
#4 |
| secondaryWins |
Secondary WINS adress |
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 settings |
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) that configured IP filtering.
Stateful inspection
| Name |
Description |
Type |
Mandatory |
Remarks |
| statefulInspection |
Setting of stateful inspection |
object |
yes |
|
| enable |
true/false |
boolean |
yes |
|
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 the value of ToS is Default, response from 1 to 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.
- #9 If you use each of Internet 1 circuit or Internet 2 curcuit only, it can not be allowed the setting for it as 4 class/6 class.
local breakout setting
| Name |
Description |
Type |
Mandatory |
Remarks |
| localBreakout |
local breakout setting |
object |
yes |
|
| internetBreakout |
Internet breakout |
boolean |
yes |
|
| greTunnelConnectionSetting |
GRE tunnel connection setting |
array |
yes |
|
| enable |
true/fals |
boolean |
yes |
|
| destinationIpAddressAct |
Destination IP adress(Active) |
string |
yes |
|
| destinationIpAddressSby |
Destination IP adress(Standby) |
string |
yes |
|
| localIpAddressAct |
Local IP adress(Active) |
string |
yes |
|
| localSubnetMaskAct |
Local IP subnet mask(Active) |
string |
yes |
|
| remoteIpAddressAct |
Remote IP adress(Active) |
string |
yes |
|
| remoteSubnetMaskAct |
Remote Subnet Mask(Active) |
string |
yes |
|
| localIpAddressSby |
Local IP adress(Standby) |
string |
yes |
|
| localSubnetMaskSby |
Local IP adress subnet mask(Standby) |
string |
yes |
|
| remoteIpAddressSby |
Remote IP adress(Standby) |
string |
yes |
|
| remoteSubnetMaskSby |
Remote IP subnet mask(Standby) |
string |
yes |
|
| greRoutingSettings |
GRE Tunnel routing setting |
object |
yes |
|
| ipAddress |
IP adress |
string |
yes |
|
| SubnetMask |
subnetmask |
string |
yes |
|
| services |
Specify the service to breakout |
array |
yes |
|
| name |
Service name |
string |
yes |
|
| breakout |
true/false |
boolean |
yes |
|
| applications |
Specify the application to breakout |
array |
yes |
|
| name |
Identification name |
string |
no |
|
| applicationName |
Application name |
string |
no |
|
| specificIpAddress |
Specify the IP adress to breakout |
array |
yes |
|
| listId |
List ID |
string |
no |
terminal IDplus 6 degits S of numbers |
| name |
Identificaion name |
string |
no |
|
| ipAddress |
Distination IP adress |
string |
no |
|
| netmask |
Distination subnet mask |
string |
no |
|
| excludeIpAddress |
IP Adress that out of terget for breakout |
array |
yes |
|
| listId |
List ID |
string |
no |
Termianl ID plus 6 degits of numbers |
| name |
Identification Name |
string |
no |
|
| ipAddress |
Destination IP Adress |
string |
no |
|
| netmask |
Destination subnet mask |
string |
no |
|
| applicationGroups |
Specify the application group to breakout |
array |
yes |
|
| name |
Identification name |
string |
no |
|
| applicationGroupName |
Application group natme |
string |
no |
|
| mplsBreakout |
MPLSbreakout |
boolean |
yes |
|
| multipathControl |
multipath control |
boolean |
yes |
|
| Name |
Description |
Type |
Mandatory |
Remarks |
| installationInformation |
Installation information |
object |
yes |
|
| customerPresenceContactInformation |
Customer presence contact information on installation day |
string |
yes |
|
| customerPresenceCorpName |
Customer presence:Corporation name |
string |
yes |
|
| howToEnter |
How to enter on installation day |
string |
yes |
|
| customerPresenceCorpNameKana |
Customer presence:Corporation name (Fullwidth forms of Kana) on installation day |
string |
yes |
|
| installationCorpName |
Installation corporation 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 on installation day |
string |
yes |
|
| time |
Confirmed installation time |
string |
yes |
|
| customerPresenceName |
Customer presence Name on installation day |
string |
yes |
|
| customerPresenceNameKana |
Customer presence Name (Kana) on installation day |
string |
yes |
|
| Name |
Description |
Type |
Mandatory |
Remarks |
| shippingInformation |
Shipping information |
object |
yes |
|
| address |
Address |
string |
yes |
|
| buildingName |
Adress (such as Building Name ,etc..) |
string |
yes |
|
| email |
E-mail |
string |
yes |
|
| contactTel |
Phone number |
string |
yes |
|
| corpName |
Corporation name |
string |
yes |
|
| corpNameKana |
Corporation name (Fullwidth forms of 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 |
Adress (such as Building Name ,etc..) |
string |
yes |
|
| email |
E-mail |
string |
yes |
|
| contactTel |
Phone number |
string |
yes |
|
| corpName |
Corporation name |
string |
yes |
|
| corpNameKana |
Corporation name (Fullwidth forms of 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 |
|
| 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 Breakdown support option |
boolean |
yes |
|
| installOnsiteLanSetting |
Install Onsite LAN setting |
boolean |
yes |
|
| rackMount |
Rack mount kit(true/false) |
boolean |
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.
| Name |
Description |
Type |
Mandatory |
Remarks |
| collectionConstructionType |
Collection construction type |
string |
no |
|
| 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 |
Foreign Flag(true/false) |
boolean |
no |
|
| zipCode |
Collection site Zip Code |
string |
no |
|
| address |
Collection site Address |
string |
no |
|
| buildingName |
Adress (such as Building Name ,etc..) |
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 digits number #12 |
| secondaryTerminalId |
Terminal ID(Secondary) |
string |
no |
D+10 digits number #11 |
| gwId |
GW ID |
string |
yes |
T+10 digits number |
| terminalGroupId |
Terminal group ID |
string |
yes |
10 digits number |
| remarks |
Remarks |
string |
yes |
|
| name |
Identification Name |
string |
yes |
|
| secondaryName |
Secondary terminal identification name |
string |
yes |
|
| gwId |
GW ID |
string |
yes |
T+10 digits 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 Response only for in use of terminal reduancy.
- #12 Response tag name as "primaryTerminalId" at the time of terminal reduancy using.
- #13 Processing, Completed, Error, Canceled.
- #14 Processing:Updating, Kitting:During,kitting, Deliverd: During Shipping, Activated: Already 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
{
"redundancyOption": false,
"wanConfigs": [
{
"interface": "ge0/0/0",
"circuitTypeWan1": "VPN",
"circuitServiceType": "ntt_japan",
"circuitServiceName": "Arcstar Universal One",
"circuitContractId": "N999999999",
"bandwidth": "100",
"interfaceSpeed": "auto",
"interfaceDuplex": "auto",
"perWanPortIpAddress": null,
"routingSetting": "Static",
"perBgpAsNo": "****",
"cerBgpAsNo": "*****",
"defaultGw": "99.99.99.99",
"ipAddress": "99.99.99.99",
"subnetMask": "**",
"pppoeId": null,
"pppoePassword": null,
"pppoeAuthenticationMethod": null,
"mssSetting": false
},
{
"interface": "ge0/0/1",
"circuitType": "INTERNET",
"circuitServiceType": "ntt_japan",
"circuitServiceName": "OCN",
"circuitContractId": "N99999999",
"bandwidth": "100",
"interfaceSpeed": "auto",
"interfaceDuplex": "auto",
"ipMethod": "StaticIP",
"ipAddress": "99.99.99.99",
"subnetMask": "**",
"defaultGw": "99.99.99.99",
"pppoeId": null,
"pppoePassword": null,
"mssSetting": false
}
],
"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"
}
],
"lanDefaultRouteSetting": {
"available": false,
"nexthopIpAddress": null
},
"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"
}
]
}
],
"statefulInspection" : {?
"enable" : false?
?},
"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",
"localBreakout": {
"internetBreakout": false,
"greTunnelConnectionSetting": {
"enable": false,
"destinationIpAddressAct": "172.50.10.1",
"destinationIpAddressSby": "172.50.10.2",
"localIpAddressAct": "172.50.10.0",
"localSubnetMaskAct": "24",
"remoteIpAddressAct": "10.50.10.0",
"remoteSubnetMaskAct": "24",
"localIpAddressSby": "172.50.20.0",
"localSubnetMaskSby": "24",
"remoteIpAddressSby": "10.50.20.0",
"remoteSubnetMaskSby": "24",
"greRoutingSettings": [
{
"ipAddress": "192.168.12.0",
"subnetMask": "24"
}
]
},
"services": [
{
"serviceName":"office365",
"breakout":true
}
],
"specificIpAddress":
{
"listId" : "D0017000007_000001"?
"name":"hoge",
"ipAddress":"?",
"subnetma":32,
}
],
"excludeIpAddress": [?
{?
"listId": "D0017000007_000000009999",?
"name": "ignore",?
"ipAddress": "2.2.2.2",?
"subnetMask": 32?
}?
?],
"applications": [
{
"name": "nick_name",
"applicationName": "app_name"
}
],
"applicationGroups": [
{
"name": "SecurityApps",
"applicationGroupName": "TrendMicro"
}
]
"mplsBreakout" : false
"multipathControl" : false??
},
"installationInformation": {
"customerPresenceContactInformation": "999-999-9999",
"customerPresenceCorpName": "xxxxxxCo.ltd",
"howToEnter": "memoxxxxxx",
"customerPresenceCorpNameKana": "xxxxxxCo,ltd",
"installationCorpName": "xxxxxx",
"workerContactInformation": "999-999-9999",
"carInformation": "xxxxxx",
"date": "2017-04-01",
"workerInformation": "xxxxxx",
"customerPresenceSectionName": "xxxxxxDivision",
"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": "Tokyo-to xxxxxx",
"buildingName": "xxxxxxBuilding",
"email": "xxxxxx@xxx.xxx",
"contactTel": "999-999-9999",
"corpName": "xxxxxxCo.Ltd.,",
"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": "xxxxxxCo.Ltd.,",
"corpNameKana": "xxxxxx",
"country": "Japan",
"sectionName": "xxxxxxdepartment",
"staffName": "xxxxxx",
"zipCode": "9999999",
"foreignFlag": false
},
"basicInformation": {
"terminalContractType": "Purchase",
"terminalType": "A300",
"terminalConstructionType": "DIY",
"installRequestedDate": "2017-04-01",
"installRequestedTimeSlot": "9:99",
"installRequestedTimeZone": "+09:00",
"onSiteRepairOption": false,
"luggageTrackingNo": "xxxxxx-999999999",
"rackMount": "false",
"serialNo": "xxxxxx"
}
"collectionConstructionType": "DIY",
"collectionRequestedDate": "2018-07-31",
"collectionContactInformation": {
"country": "Japan",
"foreignFlag": false,
"zipCode": "1234567",
"address": "xxxxxxxxxxx",
"buildingName": "xxxxxxx??",
"corpName": "xxxxxxxxxxxx",
"corpNameKana": "xxxxxxxxxxxxxxxx",
"sectionName": "xxxx",
"staffName": "xxxxx",
"contactTel": "1111111",
"email": "xxxxx@xxxx.xxx"
}
}
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 digits number |
| gwId |
GW ID |
string |
yes |
T+10 digits number |
| terminalId |
Terminal ID |
string |
yes |
D+10 digits number |
| 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 Enabling:select "true", Disabling:"false".
- #14 Total account of Vlan are until 30, and designate from 2 to 4094(except 1002-1005 and 2350-2449).
- #15 In case of Untag, designate single Vlan ID.
- #16 Tag VLAN Number allows to designate up to 10 with seperrating by comma ";" for Vlan ID in case of tagVlan.
- #17 Designate either one or the other "Tagged","Untagged".
- #18 For A300, designate to 1-8. When using terminal redundancy, designate to 1-7. For A500, designate to 3-6 and 3-5 are for using teminal redundancy. For A100, designate 1-4 and 1-3 are for using terminal 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 |
Identification 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, designate to "ipAddressVip"
- #20 Enabling Vlan:true, Disabling Vlan:false
- #21 Only designate under using terminal redundancy.
- #22 Designate 2-5 when using A500, Designate 3-5 in case of A500 terminal redundancy. "null" in the case of A300,A100.
- #23 Designate to "Tagged","Untagged" when using "A500", When using "A300","A100" will be "null".
LAN Routig Setting (Static)
| Name |
Description |
Type |
Mandatory |
Remarks |
| lanRoutingSettings |
LAN routing setting(Static) |
array |
yes |
|
| name |
Identification Name |
string |
no |
|
| ipAddress |
Destination NW address |
string |
no |
|
| subnetMask |
Destination NW 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 |
|
| ospf |
OSPF |
object |
no |
|
| ospfRouterId |
OSPF Router ID |
string |
no |
|
| primaryOspfRouterId |
Primary OSPF Router ID |
string |
no |
|
| secondaryOspfRouterId |
Secondary 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 |
Identification Name |
string |
no |
|
| ipAddress |
IP Address |
string |
no |
|
| subnetmask |
Subnet Mask |
string |
no |
|
- #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.
Setting of LAN default route
| Name |
Description |
Type |
Mandatory |
Remarks |
| lanDefaultRouteSetting |
LAN default route setting |
object |
yes |
|
| available |
true/fales |
boolean |
yes |
|
| nexthopIpAddress |
Next hop IP address |
object |
yes |
|
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 adress |
string |
yes |
#32 |
| primaryDns |
Primary DNS adress |
string |
yes |
#32 |
| secondaryDns |
Secondary DNS adress |
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 adress |
string |
yes |
#32 |
| secondaryWins |
Secondary WINS adress |
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 In case of designated as "Relay" or "None","Null" is required to input on the secoundary WINS address.
- #33 In case of designated as "Server" or "None","Null" is required to input on the secoundary WINS address.
IP Filtering
| Name |
Description |
Type |
Mandatory |
Remarks |
| ipFilterings |
Ip Filtering configurations |
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 A500. Degignate to 3-5 when using terminal redundancy on A500. "null" for when using either one or the other A300,A100.
#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.Each of settings may be configured up to 60.
Stateful Inspection
| Name |
Description |
Type |
Mandatory |
Remarks? |
| statefulInspection |
setting for Stateful Inspection |
boolean |
yes |
|
| portName |
target interface |
string |
no |
#34 |
ToS settings
| Name |
Description |
Type |
Mandatory |
Remark |
| 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 Response ToS value as "default",or 1-7(Except 6)
- #40 Designate from 1-9999, Each of settings may be configured up to 120.
QoS
| Name |
Description |
Type |
Mandatory |
Remarks |
| qos |
QoS |
string |
yes |
#41 #42 |
- #41 QoS would be response to one out of (none) or (4class?or ?6class) that already set value.
- #42 If you use each of Internet 1 circuit or Internet 2 curcuit only, it can not be allowed the setting for it as 4 class/6 class.
Local breakout
| Name |
Description |
Type |
Mandatory |
Remarks |
| localBreakout |
setting of local breakout |
object |
yes |
|
| internetBreakout |
Internet breakout |
boolean |
yes |
|
| greTunnelConnectionSetting |
GRE tunnel |
array |
yes |
|
| enable |
true/false |
boolean |
yes |
|
| destinationIpAddressAct |
Distination IP adress(Active) |
string |
yes |
|
| destinationIpAddressSby |
Distination IP adress(Standby) |
string |
yes |
|
| localIpAddressAct |
Local IP adress(Active) |
string |
yes |
|
| localSubnetMaskAct |
Local IP subnet mask(Active) |
string |
yes |
|
| remoteIpAddressAct |
Remote IP adress(Active) |
string |
yes |
|
| remoteSubnetMaskAct |
Remote IP Subnet Mask(Active) |
string |
yes |
|
| localIpAddressSby |
Local IP adress(Standby) |
string |
yes |
|
| localSubnetMaskSby |
Local Ip subnet mask(Standby) |
string |
yes |
|
| remoteIpAddressSby |
Remote IP adress(Standby) |
string |
yes |
|
| remoteSubnetMaskSby |
Remote IP subnet mask(Standby) |
string |
yes |
|
| greRoutingSettings |
GREtunnel routing setting |
object |
yes |
|
| ipAddress |
IP adress |
string |
yes |
|
| subnetMask |
Subnet Mask |
string |
yes |
|
| services |
Breakout with its specified service |
array |
yes |
|
| serviceName |
Service name |
string |
yes |
#43 |
| breakout |
true/false |
boolean |
yes |
|
| applications |
Breakout with its specifird ip adress |
array |
yes |
|
| name |
Identification name |
string |
no |
|
| applicationName |
Application name |
string |
no |
#44 |
| specificIpAddress |
Breakout with its specified IP address |
array |
yes |
|
| listId |
List ID |
string |
no |
terminal ID + 6 digits numbers |
| name |
Identification Name |
string |
no |
|
| ipAddress |
Destination IP adress |
string |
no |
|
| netmask |
Destination subnet mask |
string |
no |
|
| excludeIpAddress |
IP Adress that out of terget for breakout |
array |
yes |
|
| listId |
List ID |
string |
yes |
terminal ID + 6 digits numbers |
| name |
Identification name |
string |
no |
|
| ipAddress |
Destination IP adress |
string |
no |
|
| netmask |
Destination subnet mask |
string |
no |
|
| applicationGroups |
Breakout with its specified application group |
array |
yes |
#44 |
| name |
Identification name |
string |
no |
|
| applicationGroupName |
application group name |
string |
no |
|
| mplsBreakout |
MPLS Break out |
boolean |
yes |
?#45 |
| multipathControl |
Maltipath Control |
boolean |
yes |
?#46 |
- #43 be fixed as "office365"
- #44 Designate from default application list. applicationName will be retrieved with "Get application list for API".
- #45 it can be allow to set when the value of circuitTypeWan1/circuitTypeWan2 is MPLS, and routingSetting/ipMethod is set as "BGP".
- #46 set the value for "false" when mplsBreakout is false.
Example Request
PUT /v1/sdns/contracts/999999999999999/gateways/T9999999999/terminals/D9999999999/pre_settings
{
"redundancyOption":false,
"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" : "**"
}
]
}
},
"lanDefaultRouteSetting": {
"available": false,
"nexthopIpAddress": null
},
"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"
}
]
}
],
"statefulInspection" :
"enable" : false
},
"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",
"localBreakout": {
"internetBreakout": false,
"greTunnelConnectionSetting": {
"enable": false,
"destinationIpAddressAct": "172.50.10.1",
"destinationIpAddressSby": "172.50.10.2",
"localIpAddressAct": "172.50.10.0",
"localSubnetMaskAct": "24",
"remoteIpAddressAct": "10.50.10.0",
"remoteSubnetMaskAct": "24",
"localIpAddressSby": "172.50.20.0",
"localSubnetMaskSby": "24",
"remoteIpAddressSby": "10.50.20.0",
"remoteSubnetMaskSby": "24",
"greRoutingSettings": [
{
"ipAddress": "192.168.12.0",
"subnetMask": "24"
}
]
},
"services": [
{
"serviceName":"office365",
"breakout":true
}
],
"specificIpAddress": [
{
"name":"hoge",
"ipAddress":"?",
"subnetMask":"32"
}
],
"excludeIpAddress": [
{
"listId": "D0017000007_000000009999",
"name":"ignore",
"ipAddress":"2.2.2.2",
"subnetMask":"32",
}
],
"applications": [
{
"name": "nick_name",
"applicationName": "app_name"
}
]
"applicationGroups": [
{
"name": "SecurityApps",
"applicationGroupName": "TrendMicro"
}
],
"mplsBreakout" : false
"multipathControl" : false
},
"basicInformation": {
"terminalType": "A300"
}
}
Response Code
| Code |
Description |
| 201 |
Success |
| 400 |
Invalid type of parameter |
| 404 |
Absent ID that specified or combined |
Response Parameters
| Name |
Description |
Type |
Mandatory |
Remarks |
| orderId |
Order ID |
string |
yes |
10 digits number |
Example Result
{
"orderId": "9999999999"
}
Put terminal activation
This API can modify the configuration for specific 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 digits number |
| gwId |
GW ID |
string |
yes |
T+10 digits number |
| terminalId |
Terminal ID |
string |
yes |
D+10 digits 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 digits 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 digits number |
| gwId |
GW ID |
string |
yes |
T+10 digits number |
| terminalId |
terminalID |
string |
yes |
D+10 digits number |
Below item of settiings cannot be modified at the same time. Please modify the setting by each item.
| Name |
Description |
Type |
Mandatory |
Remarks |
| wanConfigs |
Interface settiong of WAN side on terminal |
array |
yes |
|
| WAN1 Curcuit Information |
|
|
|
|
| circuitTypeWan1 |
Curcuit Type |
string |
yes |
#1 |
| circuitServiceType |
Curcuit sercvice type |
string |
yes |
#1 |
| circuitServiceName |
Curcuit 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 |
WAN IP Address |
string |
yes |
|
| subnetMask |
WAN IP Address Subnet |
string |
yes |
|
| routingSetting |
Routing setting |
string |
yes |
#2 |
| defaultGw |
Default GW |
string |
yes |
#2 |
| perBgpAsNo |
AS No.(PER) |
string |
yes |
#1 |
| cerBgpAsNo |
AS NO.(CER) |
string |
yes |
#1 |
| perWanPortIpAddress |
WAN IP Address(PER) |
string |
yes |
#1 |
| pppoeId |
PPPoE ID |
string |
yes |
#2 |
| pppoePassword |
PPPoE Password |
string |
yes |
#2 |
| pppoeAuthenticationMethod |
PPPoE Authentication Method |
string |
yes |
#1 |
| mssSetting |
MSS Setting |
boolean |
yes |
|
| WAN2 Curcuit Information |
|
|
|
|
| circuitTypeWan2 |
Curcuit 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 |
WAN IP Address |
string |
yes |
|
| subnetMask |
WAN IP Address Subnet |
string |
yes |
|
| defaultGw |
Default GW |
string |
yes |
#2 |
| perBgpAsNo |
AS No.(PER) |
string |
yes |
#1 |
| cerBgpAsNo |
AS No.(CER) |
string |
yes |
#1 |
| perWanPortIpAddress |
WAN IP Address(PER) |
string |
yes |
#1 |
| ipMethod |
WAN IP Methord |
string |
yes |
#2 |
| pppoeId |
PPPoE ID |
string |
yes |
#2 |
| pppoePassword |
PPPoE Password |
string |
yes |
#2 |
| pppoeAuthenticationMethod |
PPPoE Authentification Method |
string |
yes |
#1 |
| mssSetting |
MSS Setting |
boolean |
yes |
#3 |
- #1 Cannot be modified.
- #2 If "circuitTypeWan1" is "VPN", it cannot be modified.
- #3 If "circuitTypeWan1" is "null" or "circuitTypeWan2" is "INTERNET", it cannot be modified.
LAN Port Setting
| Name |
Description |
Type |
Mandatory |
Remarks |
| lanPortSettings |
terminal LAN interface setting |
array |
yes |
|
| available |
true/false |
boolean |
yes |
#13 |
| name |
Identification 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 Enabling Port :true, Disabling :false.
- #14 The total count of Vlan is up to 30. Specify from 2 to 4094(except for from 1002 to 1005 and from 2359 to 2449).
- #15 Input single Vlan ID from 2 to 4094 for Untag.
- #16 Tag Vlan number allows to input Vlan ID up to 10 with seperating comma in case of tagVlan.
- #17 Designate either one or the other "Tagged""Untagged".
- #18 Require to specfy from 1 to 8 for A300 and using with terminal recundancy, specify from 1 to 7. For A500, specify 3 to 6 and using with terminal redundancy, specify from 3 to 5. For A100, specify 1 to 4 and using with terminal redundancy, specify 1 to 3.
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 |
Identification 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 Designate to "ipAddressVip".
- #20 Enabling :true, Disabling:false
- #21 Specify these items only for using terminal redundancy.
- #22 PortNo reqire to specify from 2 to 5 for A500, and specify from 3 to 5 for using terminal redundancy. For A300 and A100, specify "null".
- #23 Designate to "Tagged","Untagged" for A500, and designate "null" for A300 and A100.
LAN routing setting (Static)
| Name |
Description |
Type |
Mandatory |
Remarks |
| lanRoutingSettings |
LAN Routig Setting (Static) |
array |
yes |
|
| name |
Identification 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 |
|
| ospf |
OSPF |
object |
no |
|
| ospfRouterId |
OSPF Router ID |
string |
no |
|
| primaryOspfRouterId |
Primary OSPF Router ID |
string |
no |
|
| secondaryOspfRouterId |
Secondary 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 |
Identification Name |
string |
no |
|
| ipAddress |
IP Address |
string |
no |
|
| subnetmask |
Subnet Mask |
string |
no |
|
- #25 Require to specify 0 to 65535.
- #26 Designate one out of the "none","TEXT","MD5"
- #27 In case of authenticationType is selected as "TEXT", required to specify. "null" is for selected as "none", "MD5".
- #28 In case of authenticationType is selected as "MD5", required to specify. "null" for selected as "none", "TEXT".
- #29 specify from 3 to 6 only using A500. For A500 using with terminal redundancy, specify 3 to 5, and for A300 and A100, require to specify "null".
LAN default route setting
| Name |
Description |
Type |
Mandatory |
Remarks |
| lanDefaultRouteSetting |
LAN default route setting |
object |
yes |
|
| available |
true/false |
boolean |
yes |
|
| nexthopIpAddress |
Next hop IP Address |
object |
yes |
|
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 adress |
string |
yes |
#32 |
| secondaryWins |
Secondary WINS adress |
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 Portname would be designate to 2-5 using with A500. And if using terminal reduancy on A500, designate to 3-5. In case of using either A300 or A100, designate to "null".
- #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 Each of settings may be configured up to 60.
Stateful Inspection
| Name |
Description |
Type |
Mandatory |
Remarks |
| statefulInspection |
Settinf for stateful Inspection |
object |
yes |
|
| enable |
true/false |
boolean |
yes |
|
ToS setting
| 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 Response ToS value as "default", or 1-7(Except 6).
- #40 Designate from 1-9999. Each of settings may be configured up to 120.
QoS
| Name |
Description |
Type |
Mandatory |
Remarks |
| qos |
QoS |
string |
yes |
#41?#42 |
- #41 QoS would be response to one out of “none” or “4class” or “6class” that already set value.
- #42 If you use each of Internet 1 circuit or Internet 2 curcuit only, it can not be allowed the setting for it as 4 class/6 class.
Local breakout
| Name |
Description |
Type |
Mandatory |
Remarks |
| localBreakout |
setting of local breakout |
object |
yes |
|
| internetBreakout |
Internet breakout |
boolean |
yes |
|
| greTunnelConnectionSetting |
GRE tunnel |
array |
yes |
|
| enable |
true/false |
boolean |
yes |
|
| destinationIpAddressAct |
Distination IP adress(Active) |
string |
yes |
|
| destinationIpAddressSby |
Distination IP adress(Standby) |
string |
yes |
|
| localIpAddressAct |
Local IP adress(Active) |
string |
yes |
|
| localSubnetMaskAct |
Local IP subnet mask(Active) |
string |
yes |
|
| remoteIpAddressAct |
Remote IP adress(Active) |
string |
yes |
|
| remoteSubnetMaskAct |
Remote IP Subnet Mask(Active) |
string |
yes |
|
| localIpAddressSby |
Local IP adress(Standby) |
string |
yes |
|
| localSubnetMaskSby |
Local Ip subnet mask(Standby) |
string |
yes |
|
| remoteIpAddressSby |
Remote IP adress(Standby) |
string |
yes |
|
| remoteSubnetMaskSby |
Remote IP subnet mask(Standby) |
string |
yes |
|
| greRoutingSettings |
GREtunnel routing setting |
object |
yes |
|
| ipAddress |
IP adress |
string |
yes |
|
| subnetMask |
Subnet Mask |
string |
yes |
|
| services |
Breakout with its specified service |
array |
yes |
|
| serviceName |
Service name |
string |
yes |
#43 |
| breakout |
true/false |
boolean |
yes |
|
| applications |
Breakout with its specifird application |
array |
yes |
|
| name |
Identification name |
string |
no |
|
| applicationName |
Application name |
string |
no |
#44 |
| specificIpAddress |
Breakout with its specific Ip adress |
array |
yes |
|
| listId |
List ID |
string |
no |
terminal ID + 6 digits number |
| name |
Identification Name |
string |
no |
|
| ipAddress |
Destination IP adress |
string |
no |
|
| netmask |
Destination subnet mask |
string |
no |
|
| excludeIpAddress |
IP Adress that out of terget for breakout |
array |
yes |
|
| listId |
List ID |
string |
no |
Termianl ID plus 6 degits of numbers |
| name |
Identification Name |
string |
no |
|
| ipAddress |
Destination IP Adress |
string |
no |
|
| netmask |
Destination subnet mask |
string |
no |
|
| applicationGroups |
Specify the application group to breakout |
array |
yes |
|
| name |
Identification name |
string |
no |
|
| applicationGroupName |
Application group natme |
string |
no |
|
| mplsBreakout |
MPLSbreakout |
boolean |
yes |
|
| multipathControl |
multipath control |
boolean |
yes |
|
- #43 it can be allow to set when the value of circuitTypeWan1/circuitTypeWan2 is MPLS, and routingSetting/ipMethod is set as "BGP".
- #44 set the value for "false" when mplsBreakout is false.
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 |
| Name |
Description |
Type |
Mandatory |
Remarks |
| installationInformation |
Installation information |
object |
yes |
|
| customerPresenceContactInformation |
Customer presence information on installation day |
string |
yes |
#1 |
| customerPresenceCorpName |
Customer presence:Corporation name on installation day |
string |
yes |
#1 |
| howToEnter |
How to enter on installation day |
string |
yes |
#1 |
| customerPresenceCorpNameKana |
Customer presence:Corporation name (Kana) on installation day |
string |
yes |
#1 |
| installationCorpName |
Installation corporation 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) on installation day |
string |
yes |
#1 |
| Name |
Description |
Type |
Mandatory |
Remarks |
| shippingInformation |
Terminal Shipping information |
object |
yes |
|
| address |
Address |
string |
yes |
#1 |
| buildingName |
Adress (such as Building Name ,etc..) |
string |
yes |
#1 |
| email |
E-mail |
string |
yes |
|
| contactTel |
Phone number |
string |
yes |
|
| corpName |
Corporation name |
string |
yes |
|
| corpNameKana |
Corporation name (Fullwidth forms of 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 |
Adress (such as Building Name ,etc..) |
string |
yes |
|
| email |
E-mail |
string |
yes |
|
| contactTel |
Phone number |
string |
yes |
|
| corpName |
Corporation name |
string |
yes |
|
| corpNameKana |
Corporation name (Fullwidth forms of Kana) |
string |
yes |
|
| country |
Country |
string |
yes |
|
| sectionName |
Section name |
string |
yes |
|
| staffName |
Section name |
string |
yes |
|
| zipCode |
ZIP code |
string |
yes |
|
| 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 breakdown support 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 digits number #45 #1 |
| gwId |
GW ID |
string |
yes |
T+10 digits number #1 |
| terminalId |
Terminal ID |
string |
yes |
D+10 digits number #35 #1 |
| terminalGroupId |
Terminal Group ID |
string |
yes |
10 digits number |
| remarks |
Remarks |
string |
yes |
|
| name |
Identification name |
string |
yes |
|
| secondaryName |
Terminal Name (Secondary) |
string |
yes |
#45 |
| gwId |
GW ID |
string |
yes |
#1 |
| orderStatus |
Terminal 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 Response only for in use of terminal reduancy.
- #46 Response tag name as "primaryTerminalId" at the time of terminal reduancy using.
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": "**",
"mssSetting": false
},
{
"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,
"mssSetting": false
}
],
"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" : "**"
}
]
}
},
"lanDefaultRouteSetting": {
"available": false,
"nexthopIpAddress": null
},
"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"
}
]
}
],
"statefulInspection" : {
"enable" : false
},
"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",
"localBreakout": {
"internetBreakout": true,
"greTunnelConnectionSetting": {
"enable": false,
"destinationIpAddressAct": "172.50.10.1",
"destinationIpAddressSby": "172.50.10.2",
"localIpAddressAct": "172.50.10.0",
"localSubnetMaskAct": "24",
"remoteIpAddressAct": "10.50.10.0",
"remoteSubnetMaskAct": "24",
"localIpAddressSby": "172.50.20.0",
"localSubnetMaskSby": "24",
"remoteIpAddressSby": "10.50.20.0",
"remoteSubnetMaskSby": "24",
"greRoutingSettings": [
{
"ipAddress": "192.168.12.0",
"subnetMask": "24"
}
]
},
"services": [
{
"name": "office365",
"breakout": true
}
],
"specificIpAddress": [
{
"listId": "D0017000007_000001",
"name": "hoge",
"ipAddress": "1.1.1.1",
"subnetMask": 32
}
],
"excludeIpAddress": [
{
"listId": "D0017000007_000000009999",
"name": "ignore",
"ipAddress": "2.2.2.2",
"subnetMask": 32
}
],?
"applications": [
{
"name": "nick_name",
"applicationName": "app_name"
}
],
"applicationGroups": [
{
"name": "SecurityApps",
"applicationGroupName": "TrendMicro"
}
],
"mplsBreakout" : false,
"multipathControl" : false
},
"secondaryWanConfigs": [
{
"perBgpAsNo": "****",
"cerIpAddress": "99.99.99.99",
"cerSubnetMask": "**",
"perIpAddress": "99.99.99.99",
"loopbackIpAddress": "99.99.99.99"
}
],
"installationInformation": {
"customerPresenceContactInformation": "999-999-9999",
"customerPresenceCorpName": "xxxxxxCo.ltd",
"howToEnter": "memoxxxxxx",
"customerPresenceCorpNameKana": "xxxxxx",
"installationCorpName": "xxxxxx",
"workerContactInformation": "999-999-9999",
"carInformation": "xxxxxx",
"date": "2017-04-01",
"workerInformation": "xxxxxx",
"customerPresenceSectionName": "xxxxxxDivision",
"time": "99:99",
"customerPresenceName": "xxxxxx",
"customerPresenceNameKana": "xxxxxx"
},
"secondaryTerminalId": "D9999999999",
"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": "TOKYO-TOsxxxxxx",
"buildingName": "xxxxxxbuilding,
"email": "xxxxxx@xxx.xxx",
"contactTel": "999-999-9999",
"corpName": "xxxxxxCo.ltd",
"corpNameKana": "xxxxxxCo.LTD",
"country": "Japan",
"equalInstallAddress": true,
"sectionName": "xxxxxxDivision",
"staffName": "xxxxxx",
"zipCode": "9999999",
"foreignFlag": false,
},
"installationSite": {
"address": "TOKYO-TOxxxxxx",
"buildingName": "xxxxxxBuilding",
"email": "xxxxxx@xxx.xxx",
"contactTel": "9999-999-9999",
"corpName": "xxxxxxCo,ltd,
"corpNameKana": "xxxxxxCo,ltd",
"country": "Japan",
"sectionName": "xxxxxxDivision",
"staffName": "xxxxxx",
"zipCode": "9999999"
},
"basicInformation": {
"terminalContractType": "Purchase",
"terminalType": "A300",
"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 digits number |
Example Result
{
"orderId": "9999999999"
}
Update the terminal configuration (Update Application definition file within Office 365 route)
Manually update a terminal Application definition file for internet breakout within office 365 route.
*The route of office365 is automatically updated once on every 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 digits number |
| gwId |
GW ID |
string |
yes |
T+10 digits number |
| terminalId |
Terminal ID |
string |
yes |
D+10 digits 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 that specified of combined |
Response Parameters
| Name |
Description |
Type |
Mandatory |
Remarks |
| orderId |
Order ID |
string |
yes |
10 digits number |
Example Result
{
"orderId": "9999999999"
}
Modify the terminal configuration (Update Application definition file)
Update the application definition file on terminal.
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 digits number |
| gwId |
GW ID |
string |
yes |
T+10 digits number |
| terminalId |
Terminal ID |
string |
yes |
D+10 digits number |
Example Request
PUT /v1/sdns/contracts/999999999999999/gateways/T999999999/terminals/D999999999/internet_breakout/application_files
{
}
Response Code
| Code |
Description |
| 202 |
Success |
| 400 |
Invalid type of parameter |
| 404 |
Absent IDs that specified or combined |
Response Parameters
| Name |
Description |
Type |
Mandatory |
Remarks |
| orderId |
Order ID |
string |
yes |
10 digits number |
Example Result
{
"orderId": "9999999999"
}
Retrieve the list of terminals
This API retrieve the list of terminal information.
GET /v1/sdns/contracts/{contractId}/gateways/{gwId}/terminals
Request Parameters
| Name |
Description |
Type |
Mandatory |
Remarks |
| contractId |
Service contract ID |
string |
yes |
15 digits number |
| gwId |
ID of GW that associated to terminal |
string |
yes |
T+10 digits number |
Example Request
GET /v1/sdns/contracts/999999999999999/gateways/T9999999999/terminals
Response Code
| Code |
Description |
| 200 |
Success |
| 400 |
Invalid type of parameter |
| 404 |
AbsentID that specified or combined |
Response Parameters
| Name |
Description |
Type |
Mandatory |
Remarks |
| gwId |
GW ID |
string |
yes |
T+10 digits number |
| teminals |
Terminal information |
array |
yes |
|
| name |
Identification name |
string |
yes |
|
| terminalId |
Terminal ID |
string |
yes |
D+10 digits 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 digits number |
| status |
Order status of terminal |
string |
yes |
Response #3 |
| installationSite |
Installation site information |
object |
yes |
|
| address |
Address |
string |
yes |
|
| buildingName |
Adress (such as Building Name ,etc..) |
string |
yes |
|
| secondaryTerminalId |
Terminal ID(Secondary) |
string |
no |
D+10 digits number #4 |
- #1 TerminalID will response to tag name as "primaryTerminalID" 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": "TOKYO-TOxxxxxx",
"buildingName": "xxxxxbuilding"
}
"secondaryTerminalId" : "D9999999999"
},
{
"name": "SD-NS-T2xxxxxx",
"primaryTeminalId": "D9999999999",
"orderStatus": "Completed",
"basicInformation": {
"installRequestedDate": "2017-04-01",
"terminalGroupId": "99999999999"
},
"status": "Activated",
"installationSite": {
"address": "TOKYO-TOxxxxxx",
"buildingName": "xxxxxxbuilding"
}
"secondaryTerminalId" : "D9999999999"
},
{
"name": "SD-NS-T3xxxxxx",
"teminalId": "D9999999999",
"orderStatus": "Completed",
"basicInformation": {
"installRequestedDate": "2017-04-01",
"terminalGroupId": "9999999999"
},
"status": "Activated",
"installationSite": {
"address": "TOKYO-TOxxxxxx",
"buildingName": "xxxxxxBuilding"
}
}
]
}
Terminate a terminal
Apply to termination for terminal.
PUT /v1/sdns/contracts/{contractId}/gateways/{gwId}/terminals/{terminalId}/terminate}
Request Parameters
| Name |
Description |
Type |
Mandatory |
Remarks |
| contractId |
Service contract ID |
string |
yes |
15 digits number |
| gwId |
GW ID |
string |
yes |
T+10 digits number |
| terminalId |
Terminal ID |
string |
yes |
D+10 digits number |
| Name |
Description |
Type |
Mandatory |
Remarks |
| collectionConstructionType |
construction type for collection |
string |
yes |
#1 |
| collectionRequestedDate |
Requested day for clollection |
string |
yes |
#2 |
| collectionRequestedTimeSlot |
Requested date for collection |
string |
yes |
#3 |
| collectionContactInformation |
Requested time for collection |
string |
yes |
|
| foreignFlag |
whether shipping for forign country(false) |
boolean |
yes |
|
| country |
Country |
string |
yes |
|
| zipCode |
Post code |
string |
yes |
|
| address |
adress |
string |
yes |
|
| buildingName |
Adress(Name of buildings ) |
string |
yes |
|
| corpName |
Corporation Name |
string |
yes |
|
| corpNameKana |
Corporation Name (Fullwidth forms of Kana) |
string |
yes |
|
| sectionName |
Devision Name |
string |
yes |
|
| staffName |
Staff Name |
string |
yes |
|
| contactTel |
Contact tel No. |
string |
yes |
|
| email |
Mail adress |
string |
yes |
|
- #1 Designate "DIY" when select "DIY" at the setting of terminal, Designate "DIY" or "Onsite" when setting of the terminal is installed onsite.
- #2 Designate "yyyy-mm-dd" format.
- #3 If designate "Onsite" for collection type, select one of each from "9:00","13:00","15:00","17:00", And if designate "DIY" for collection type or not designate the time of request time, select "null".
Example Request
DELETE /v1/sdns/contracts/999999999999999/gateways/T9999999999/terminals/D9999999999/retire
{
"collectionConstructionType" : "DIY",
"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"
}
}
Response Code
| Code |
Description |
| 202 |
Success |
| 400 |
Invalid type of parameter |
| 404 |
Absent IDs that specified or combined |
Response Parameters
| Name |
Description |
Type |
Mandatory |
Remarks |
| orderId |
Order ID |
string |
yes |
10 digits number |
Example Result
{
"orderId": "9999999999"
}
Register the collection date and place informations after the terminal termination.
PUT /v1/sdns/contracts/{contractId}/gateways/{gwId}/terminals/{terminalId}/adjustments
Requst Parameters
| Name |
Description |
Type |
Mandatory |
Remarks |
| contractId |
service contract ID |
string |
yes |
15 digits number |
| gwId |
GW ID |
string |
yes |
T+10 digits number |
| terminalId |
Terminal ID |
string |
yes |
D+10 digits number |
| NName |
Description |
Type |
Mandatory |
Remarks |
| collectionConstructionType |
Collection construction Type |
string |
yes |
#1 |
| collectionRequestedDate |
Collection requested date |
string |
yes |
#2 |
| collectionRequestedTimeSlot |
Collection requested time |
string |
yes |
#3 |
| collectionContactInformation |
Collection contact Information |
string |
yes |
|
| foreignFlag |
whethe one is shipping for oversea (false) |
boolean |
yes |
|
| country |
Country |
string |
yes |
|
| zipCode |
Aipcode |
string |
yes |
|
| address |
Address |
string |
yes |
|
| buildingName |
ddress(building Name) |
string |
yes |
|
| corpName |
Corporation name |
string |
yes |
|
| corpNameKana |
Corporatio name (full-with kana) |
string |
yes |
|
| sectionName |
Section name |
string |
yes |
|
| staffName |
Staff name |
string |
yes |
|
| contactTel |
Contact Telephone Number |
string |
yes |
|
| email |
Mail address |
string |
yes |
|
- 1 Designate "DIY" for CcolectionConstructionType in case of select DIY on terminal installation. Designate "DIY" or "Onsite" when you install terminal at onsite.
- 2 Designate format as "yyyy-mm-dd".
- 3 If the collectionConstructionType is "onsite", designate one from "9:00","13:00","15:00","17:00". If you don't specify the request timeslot or CollectionConstructionType is "DIY", designate "null".
Example Request
PUT /v1/sdns/contracts/999999999999999/gateways/T9999999999/terminals/D9999999999/adjustments
{
"collectionConstructionType" : "Onsite",
"collectionRequestedDate" : "2018-07-31",
"collectionRequestedTimeSlot" : "9:00",
"collectionContactInformation" : {
"country" : "Japan",
"foreignFlag" : "false",
"zipCode" : "9999999",
"address" : "TOKYO-TOsxxxxxx",
"buildingName" : "xxxxxxBuillding",
"corpName" : "xxxxxxCo.ltd",
"corpNameKana" : "xxxxxxCo.LTD",
"sectionName" : "xxxxxxDivision",
"staffName" : "xxxxxx",
"contactTel" : "999-9999-9999",
"email" : "xxxxxx@xxx.xxx"
}
}
Response Code
| Code |
Description |
| 202 |
Success |
| 400 |
Invalid type of parameter |
| 404 |
Absent IDs that specified or combined |
Response Parameters
| Name |
Description |
Type |
Mandatory |
Remarks |
| orderId |
Order ID |
string |
yes |
10 digits 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 digits 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 IDs that specified or combined |
Response Parameters
| Name |
Description |
Type |
Mandatory |
Remarks |
| orderId |
Order ID |
string |
yes |
10 digits number |
| orderId |
Order ID |
string |
yes |
10 digits 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 digits number |
Example Request
GET /v1/sdns/contracts/999999999999999/terminal_groups
Response Code
| Code |
Description |
| 200 |
Success |
| 400 |
Invalid type of parameter |
| 404 |
Absent IDs that specified or combined |
Response Parameters
| Name |
Description |
Type |
Mandatory |
Remarks |
| terminalGroups |
Terminal group information |
array |
yes |
|
| terminalGroupId |
Terminal group ID |
string |
yes |
10 digits number |
| name |
Identification Name |
string |
yes |
|
| contractId |
Service contract ID |
string |
yes |
15 digits number |
Example Result
{
"terminalGroups": [
{
"terminalGroupId": "9999999999",
"name": "default group"
},
{
"terminalGroupId": "9999999999",
"name": "xxxxxx"
}
],
"contractId": "999999999999999"
}
Modify the terminal group configration
Modify the terminal group configration
PUT /v1/sdns/contracts/{contractId}/terminal_groups/{terminalGroupId}
Request Parameters
| Name |
Description |
Type |
Mandatory |
Remarks |
| contractId |
Service contract ID |
string |
yes |
15 digits number |
| terminalGroupId |
Terminal group ID |
string |
yes |
10 digits number |
| Name |
Description |
Type |
Mandatory |
Remarks |
| name |
Identification 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 IDs that specified or combined |
Response Parameters
| Name |
Description |
Type |
Mandatory |
Remarks |
| orderId |
Order ID |
string |
yes |
10digits number |
Example Result
{
"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 digits number |
| terminalGroupId |
Terminal group ID |
string |
yes |
10 digits number |
Example Request
DELETE /v1/sdns/contracts/99999999999999/terminal_groups/9999999999
Response Code
| Code |
Description |
| 202 |
Success |
| 400 |
Invalid type of parameter |
| 404 |
Absent IDs that specified or combined |
Response Parameters
| Name |
Description |
Type |
Mandatory |
Remarks |
| orderId |
Order ID |
string |
yes |
10digits number |
Example Result
{
"orderId": "9999999999"
}
Retreave terminal monitoring status
This API returns 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 digits number |
| gwId |
GW ID That associated with terminall is located |
string |
yes |
T+10 digits number |
| terminalId |
Terminal ID |
string |
yes |
D+10 digits 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 IDs that specified or combined |
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
}
Retrieve the terinal monitoring status list
This API retrieve 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 digits number |
Example Request
GET /v1/sdns/contracts/999999999999999/monitoring
Response Code
| Code |
Description |
| 200 |
Success |
| 400 |
Invalid type of parameter |
| 404 |
Absent IDs that specified or combined |
Response Parameters
| Name |
Description |
Type |
Mandatory |
Remarks |
| time |
Aqquired time |
string |
yes |
|
| status |
terminal monitoring status |
string |
yes |
#1 |
| terminalId |
terminal ID |
string |
yes |
D+10 digits 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"
},
{
:
}
]
Switch terminal monitoring status
This API switch 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 digits number |
| gwId |
GW ID in which the terminal is located |
string |
yes |
T+10 digits number |
| terminalId |
Terminal ID |
string |
yes |
D+10 digits 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 |
| 202 |
Success |
| 400 |
Invalid type of parameter |
| 404 |
Absent IDs that specified or combined |
Retrieve terminal status
Tthis API retrieve the terminal status whether out of order/in operation.
GET /v1/sdns/contracts/{contractId}/gateways/{gwId}/terminals/{terminalId}/alarms
Request Parameters
| Name |
Description |
Type |
Mandatory |
Remarks |
| contractId |
service contract ID |
string |
yes |
15 digits number |
| gwId |
GW ID that associated with terminal |
string |
yes |
T+10 digits number |
| terminalId |
Terminal ID |
string |
yes |
D+10 digits number |
| from |
Retrieve the date and time that after specified |
string |
yes |
JST time in iso 8601 format #1 #2 #3 |
| to |
Retrieve the date and time that before specified |
string |
yes |
JST time in iso 8601 format #1 #2 #3 |
- #1 Ex:2017-04-01T00:00:00
- #2 Information that older than 93days from the current time can not be retrieved.
- #3 The difference between "from" and "to" must be within 24 hours.
Example Request
GET /v1/sdwan/contracts/999999999999999/gateways/T9999999999/terminals/D9999999999/alarmsfrom=2017-04-01T00:00:00&to=2017-04-01T23:59:59
Response Code
| Code |
Description |
| 200 |
Success |
| 400 |
Invalid type of parameter |
| 404 |
AbsentID that specified or combined |
Response Parameters
| Name |
Description |
Type |
Mandatory |
Remarks |
| time |
Aqquired time |
string |
no |
JST time in iso 8601 format #1 #4 |
| status |
Terminal status |
number |
no |
Response #5 #6 |
- #4 The terminal status is aqquired/reserved 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},
]
retrieve terminal status list
Retreive the terminal status list that associated with specific contract.
GET /v1/sdns/contracts/{contractId}/alarms
Request Parameters
| Name |
Description |
Type |
Mandatory |
Remarks |
| contractId |
Service contract ID |
string |
yes |
15 digits number |
| from |
Retrieve infomation that after a specified time |
string |
no |
JST time in iso 8601 format #1 |
| to |
Retrieve infomation that before a specified time |
string |
no |
JST time in iso 8601 format #1 |
| to |
Retrieve infomation that before a specified 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/alarmsonly_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 |
Absent ID that specified or combined |
Response Parameters
| Name |
Description |
Type |
Mandatory |
Remarks |
| time |
Last info aqquired 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 Terminal status shows only logs that occurred 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" }
}
Retrieve terminal status detail
This API 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 digits number |
| gwId |
GW ID in which the terminal is localed |
string |
yes |
T+10 digits number |
| terminalId |
Terminal ID |
string |
yes |
D+10 digits 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 IDs that specified or combined |
Response Parameters
| Name |
Description |
Type |
Mandatory |
Remarks |
| detail |
Responding the detail of the terminal status |
object |
yes |
|
| contractId |
Service contract ID |
string |
yes |
|
| gwId |
GW ID |
string |
yes |
|
| terminalId |
terminal ID |
string |
yes |
|
| time |
Information aqquired time |
string |
yes |
|
| connectivity |
result of conformation for connectivity |
string |
yes |
|
| errerReason |
error reason |
string |
yes |
|
| wanInterface |
Status of 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 updated time |
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"
}
],
"gre": [
{
"type": "Overlay",
"port": "Tunnel1",
"config": "up",
"status": "up"
},
{
"type": "Overlay",
"port": "Tunnel2",
"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"
}
}
}
This API retrieve 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 digits number |
| gwId |
GW ID that associated with terminal |
string |
yes |
T+10 digits number |
| terminalId |
Terminal ID |
string |
yes |
D+10 digits number |
| port |
WAN port |
string |
yes |
#1 |
| from |
Retrieve information after specified time |
string |
yes |
JST time in iso 8601 format #2 #3 #4 |
| to |
Retrieve information before specified time |
string |
yes |
JST time in iso 8601 format #2 #3 #4 |
- #1 wan,1wan2,ppp1,ppp2,wan_gre1,wan_gre2,wan1_lbo,wan2_lbo,tunnel1,tunnel2
- #2 Ex:2017-04-01T00:00:00
- #3 Information older than 93 days from the current time can not be retrieved.
- #4 The difference between "from" and "to" must be within 24 hours.
Example Request
GET /v1/sdns/contracts/999999999999999/gateways/T9999999999/terminals/D9999999999/trafficsport=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 IDs that specified or combined |
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 floating point value is until 2 digits |
| avgOutTraffic |
Average amount of traffic on the sender side for port"bps" |
number |
no |
Effective floating point value is until 2 digits |
- #5 The traffic information is retrieved and reserved 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
}
]
This API retrieve terminal traffic information (minimum/maximum/average on the day-to day basis)
* 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 digits number |
| gwId |
GW ID that associated with terminal |
string |
yes |
T+10 digits number |
| terminalId |
Terminal ID |
string |
yes |
D+10 digits number |
| port |
Retrieve port information that specified |
string |
yes |
#1 |
| from |
Retrieve information after specified 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 wan1,wan2,ppp1,ppp2,wan_gre1,wan_gre2,wan1_lbo,wan2_lbo,tunnel1,tunnel2.
- #2 Ex: 2017-04-01T00:00:00
- #3 Information older than 365 days from the current time can not be retrieved.
- #4 The difference between 'from' and 'to' should be within 31 days.
Example Request
GET /v1/sdns/contracts/999999999999999/gateways/T9999999999/terminals/D9999999999/traffic_statsport=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 IDs that specified or combined |
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 floating point value is 2 digits
|
| avgOutTraffic |
Average amount of traffic per day on the sender side
for port（bps） |
string |
no |
Effective floating point value is 2 digits
|
| maxInTraffic |
Maximum amount of traffic per day on the receiving
side for port（bps） |
string |
no |
Effective floating point value is 2 digits
|
| maxOutTraffic |
Maximum amount of traffic per day on the sender side
for port（bps） |
string |
no |
Effective floating point value is 2 digits
|
| minInTraffic |
Minimum amount of traffic per day on the receiving
side for port（bps） |
string |
no |
Effective floating point value is 2 digits
|
| minOutTraffic |
Minimum amount of traffic per day on the sender side
for port（bps） |
string |
no |
Effective floating point value is 2 digits
|
- #5 The Traffic information is retrieved and reserved 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
}
]
This API retrieve the terminal Error information (by 5 minutes).
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 digits number |
| gwId |
GW ID that associated with terminal |
string |
yes |
T+10 digits number |
| terminalId |
Terminal ID |
string |
yes |
D+10 digits number |
| port |
Retrieve specified port information |
string |
yes |
#1 |
| from |
Retrieve information before specified time |
string |
yes |
JST time in iso 8601 format #2 #3 #4 |
| to |
Retrieve information after specified 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 93 days from the current time can not be retreived.
- #4 The difference between "from" and "to" must be within 31 days.
Example Request
GET /v1/sdns/contracts/999999999999999/gateways/T9999999999/terminals/D9999999999/error_packetsport=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 IDs that specified or combined |
Response Parameters
| Name |
Description |
Type |
Mandatory |
Remarks |
| time |
aqquired time |
string |
no |
JST time in iso 8601 format #2 #5 |
| avgInDiscard |
Average value of the count of discard packets on the receiving side for port "bps" |
number |
no |
Effective floating point value is 2 digits
|
| avgOutDiscard |
Average value of the count of discard packets on the sender side for port "bps" |
number |
no |
Effective floating point value is 2 digits
|
| avgInError |
Average value of error packets on the
sender side for the port "pps" |
number |
no |
Effective floating point value is 2 digits
|
| avgOutError |
Average value of the count of error packets on the
sender side for the port "pps" |
number |
no |
Effective floating point value is 2 digits
|
- #5 The traffic information is retrieved and reserved 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"
}
]
Return the terminal error information (minimum/maximum/average at on a day-to-day basis)
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 digits number |
| gwId |
GW ID that associated with terminal |
string |
yes |
T+10 digits number |
| terminalId |
Terminal ID |
string |
yes |
D+10 digits number |
| port |
Retrieve specified port information |
string |
yes |
#1 |
| from |
Retrieve information after specified time |
string |
yes |
JST time in iso 8601 format #2 #3 #4 |
| to |
Retrieve information before specified 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 retrieved.
- #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_statsport=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 IDs that specified or combined |
Response Parameters
| Name |
Description |
Type |
Mandatory |
Remarks |
| time |
Aqquired time |
string |
no |
JST time in iso 8601 format #2 #5 |
| avgInDiscard |
Average value of the count of discard packets on the
receiving side for the port "pps" |
number |
no |
Effective floating point value is 2 digits.
|
| avgOutDiscard |
Average value of the number of discard packets on the
sender side for the port "pps" |
number |
no |
Effective floating point value is 2 digits.
|
| avgInError |
Average value of the number of error packets on the
receiving side for the port "pps" |
number |
no |
Effective floating point value is 2 digits.
|
| avgOutError |
Average value of the number of error packets on the
sender side for the port" pps" |
number |
no |
Effective floating point value is 2 digits.
|
| maxInDiscard |
Maximum value of the number of discard packets on
the receiving side for the port "pps" |
number |
no |
Effective floating point value is 2 digits.
|
| maxOutDiscard |
Maximum value of the number of discard packets on
the sender side for the port "pps" |
number |
no |
Effective floating point value is 2 digits.
|
| maxInError |
Maximum value of the number of error packets on
the receiving side for the port "pps" |
number |
no |
Effective floating point value is 2 digits
|
| maxOutError |
Maximum value of the number of error packets on
the sender side for the port "pps" |
number |
no |
Effective floating point value is 2 digits.
|
| minInDiscard |
Minimum value of the number of discard packets on
the receiving side for the port "pps" |
number |
no |
Effective floating point value is 2 digits.
|
| minOutDiscard |
Minimum value of the number of discard packets on
the sender side for the port "pps" |
number |
no |
Effective floating point value is 2 digits.
|
| minInError |
Minimum value of the number of error packets on the
receiving side for the port "pps" |
number |
no |
Effective floating point value is 2 digits.
|
| minOutError |
Minimum value of the number of error packets on the
sender side for the port "pps" |
number |
no |
Effective floating point value is 2 digits.
|
- #5 The Traffic information is retrieved and reserved 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
}
]
This API retrieve the terminal application information (avalage value on 5 minutes basis) * 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 digits number |
| gwId |
GW ID |
string |
yes |
T+10 digits number |
| terminalId |
Terminal ID |
string |
yes |
D+10 digits number |
| unit |
Specify the aggregation unit of flow |
string |
yes |
#7 |
| direction |
IN/OUT |
string |
yes |
|
| port |
Retrieve specified port information |
string |
yes |
#1 |
| from |
Retrieve information after specified time |
string |
yes |
JST time in iso 8601 format #2 #3 #4 |
| to |
Retrieve information before specified time |
string |
yes |
JST time in iso 8601 format #2 #3 #4 |
| tos |
Retrieve Specified ToS information |
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 |
Specify the application ID |
string |
no |
|
| application_name |
Specify application name |
string |
no |
|
| application_group |
Specify application group name |
string |
no |
|
- #1 wan1,wan2,ppp1,ppp2,wan_gre1,wan_gre2,wan1_lbo,wan2_lbo,tunnel1,tunnel2.
- #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 The value may specify multiple ToS. You may specify ToS value as following; -1(ToS:None), 0-7(Except 6).
- #6 The value may specify multiple. You may specify following protocols; tcp, udp, icmp.
- #7 bit,packet,count
Example Request
GET /v1/sdns/contracts/999999999999999/gateways/T9999999999/terminals/D9999999999/accumulated_flowsunit=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 IDs that specified or combined |
Response Parameters
| Name |
Description |
Type |
Mandatory |
Remarks |
| time |
Aqquired Time |
string |
no |
JST time in iso 8601 format #1 #2 |
| avgBit |
Average number of flow for bit（bps） |
number |
no |
Effective floating point value is 2 digits
|
| avgPacket |
Average number of flow for packet（bps） |
number |
no |
Effective floating point value is 2 digits
|
| count |
number of flow count |
number |
no |
|
- #1 Ex: 2017-04-01T00:00:00
- #2 The traffic information isRetrieved and reserved 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
}
]
Retrieve traffic details
Retrieve traffic inforation of terminal with specified detail conditions.
GET /v1/sdns/contracts/{contractId}/gateways/{gwId}/terminals/{terminalId}/flows
Request Parameters
| Name |
Description |
Type |
Mandatory |
Remarks |
| contractId |
Service Contract ID |
string |
yes |
15 digits number |
| gwId |
GW ID |
string |
yes |
10 digits number |
| terminalId |
Terminal ID |
string |
yes |
10 digits number |
| direction |
in/out |
string |
yes |
|
| port |
Specify interface ID |
string |
no |
#1 |
| from |
Start time |
string |
no |
JST time in iso 8601 format #2 |
| to |
Termination time |
string |
no |
#2 |
| dscp |
Dscp value |
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 |
Destination 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 |
|
| application_group |
Application group name |
string |
no |
|
| limit |
Aqquired count |
number |
no |
#5 integr |
| continue |
Specify the token |
string |
no |
|
- #1 wan1,wan2,ppp1,ppp2,wan_gre1,wan_gre2,wan1_lbo,wan2_lbo,tunnel1,tunnel2.
- #2 Specfy JST time in iso 8691 format "YYYY-MM-DDT00:00:00+09:00"
- #3 Ex: 8,16
- #4 Specify one out of the "tcp""udp""ip".
- #5 Upper limit is 5000.
Example Request
GET /v1/sdns/contracts/999999999999999/gateways/T9999999999/terminals/D9999999999/flowsdirection=in
Response Code
| Code |
Description |
| 200 |
Success |
| 400 |
Invalid type of parameter |
| 404 |
Absent IDs that specified or combined |
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 |
Number of Network Delay Samples |
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 digits number |
Example Request
GET /v1/sdnscontracts/99999999999999/applications
Response Code
| Code |
Description |
| 200 |
Success |
| 400 |
Invalid type of parameter |
| 404 |
Absent IDs that specified or combined |
Response Parameters
| Name |
Description |
Type |
Mandatory |
Remarks |
| applicationId |
Application ID |
string |
no |
|
| applicationName |
Application Name |
string |
no |
|
| description |
Description |
string |
no |
|
| applicationGroup |
Application Group Name |
string |
no |
|
| applicationGroupDescription |
Explanation for application group |
string |
no |
|
Example Result
[
{
"applicationId": "1:34",
"applicationName": "gmail",
"description": "Third Party Connect Protocol",
"applicationGroup": "other",
"applicationGroupDescription": "Other related applications"
},
{
"applicationId": "1:107",
"applicationName": "an",
"description": "Active Networks",
"applicationGroup": "other",
"applicationGroupDescription": "Other related applications"
},
{
"applicationId": "1:61",
"applicationName": "any-host-internal",
"description": "any host internal protocol",
"applicationGroup": "other",
"applicationGroupDescription": "Other related applications"
},
{
:
},
{
"applicationId": "13:751",
"applicationName": "zulily",
"description": "Zulily - Online shopping aimed for Moms apparel and hom",
"applicationGroup": "other",
"applicationGroupDescription": "Other related applications"
}
]
Get application group list
Retrive the application group list.
GET /v1/sdns/contracts/{contractId}/application_groups
Request Parameters
| Name |
Description |
Type |
Mandatory |
Remarks |
| contractId |
Service contract ID |
string |
yes |
15 digit number |
Example Request
GET /v1/sdnscontracts/99999999999999/application_groups
Response Code
| Code |
Description |
| 200 |
Success |
| 400 |
Invalid type of parameter |
| 404 |
Absent IDs that specified or combined |
Response Parameters
| Name |
Description |
Type |
Mandatory |
Remarks |
| applicationId |
Application ID |
string |
no |
|
| applicationName |
Application Name |
string |
no |
|
| description |
Description |
string |
no |
|
| applicationGroup |
Application group Name |
string |
no |
|
| applicationGroupDescription |
Description of Application Group |
string |
no |
|
Example Result
[
{
"applicationGroup": "other",
"applicationGroupDescription": "Other related applications",
"applications": [
{
"applicationId": "1:34",
"applicationName": "3pc",
"description": "Third Party Connect Protocol"
},
{
"applicationId": "1:107",
"applicationName": "an",
"description": "Active Networks",
},
...
]
},
...
]
Get traffic ranking
This API retrieve amount of the traffic ranking with specified conditions.
GET /v1/sdns/contracts/{contractId}/gateways/{gwId}/terminals/{terminalId}/rankings
Request Parameters
| Name |
Description |
Type |
Mandatory |
Remarks |
| contractId |
Service Contract ID |
string |
yes |
15 digits number |
| gwId |
GW ID |
string |
yes |
T+10 digits number |
| terminalId |
Terminal ID |
string |
yes |
D+10 digits number |
| direction |
in/out |
string |
yes |
#1 |
| property |
Specify the Property |
string |
yes |
#2 |
| port |
Specify the interface |
string |
no |
#3 |
| from |
Start time |
string |
no |
#4 |
| to |
Termination time |
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 |
| application_group |
Application group name |
string |
no |
#8 |
| size |
Ranking number |
string |
no |
#9 |
- #1 Designate responding information either one the other "in" or "out"
- #2 Specify Source IP Address(IPv4) is "src_ip_addr",Destination IP Address(IPv4) is "dst_ip_addr", Application ID is "application_id",Application Name is "application_name",Source Port Number" is src_port",Destination Port Number is "dst_port",ToS is "tos".
- #3 * #1 wan1,wan2,ppp1,ppp2,wan_gre1,wan_gre2,wan1_lbo,wan2_lbo,tunnel1,tunnel2.
- #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 Specify application/application name that required to retrive the 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/rankingsdirection=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 IDs that specified or combined |
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 digits number |
| gwId |
GW ID |
string |
yes |
T+10 digits number |
| terminalId |
Terminal ID |
string |
yes |
D+10 digits number |
| from |
Start time |
string |
no |
#1 |
| to |
Termination 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 |
| application_group |
Application group name |
string |
no |
|
- #1 Specify as JST time in ISO 8601 format. Ex:"YYYY-MM-DDT00:00:00+09:00"
- #2 Specify application ID whici is require to retrieve traffic.
Example Request
GET /v1/sdns/contracts/999999999999999/gateways/T9999999999/terminals/D9999999999/rttfrom=2017-04-01T00:00:00&to=2017-04-01T23:59:59
Response Code
| Code |
Description |
| 200 |
Success |
| 400 |
Invalid type of parameter |
| 404 |
Absent IDs that specified or combined |
Response Parameters
| Name |
Description |
Type |
Mandatory |
Remarks |
| avgApplicationDelay |
Average responding time from server application |
string |
no |
|
| avgServerNetworkDelay |
Avarage connection time from Server to Router |
string |
no |
|
| avgClientNetworkDelay |
Aavarage connection time fro Client to Router |
string |
no |
|
Example Result
{
"avgApplicationDelay": 5,
"avgServerNetworkDelay": 5,
"avgClientNetworkDelay": 5
}
Retrieve connection quality
This API retrieve the 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 digits number |
| gwId |
GW ID |
string |
yes |
T＋10 digits number |
| terminalId |
Terminal ID |
string |
yes |
D+10 deigit number |
| port |
Specify the Interface |
string |
no |
#1 |
| from |
Start time |
string |
no |
#2 |
| to |
Termination time |
string |
no |
#2 |
| interval_min |
Designate aggregation interval |
string |
no |
#3 |
- #1 Specify 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/qualitiesport=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 IDs that specified or combined |
Response Parameters
| Name |
Description |
Type |
Mandatory |
Remarks |
| time |
Aqquired 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 digits number |
| from |
Start time |
string |
no |
#1 |
| to |
Termination time |
string |
no |
#1 |
※Ex:"YYYY-MM-DDT00:00:00+09:00"
Example Request
GET /v1/sdns/contracts/999999999999999/routing_eventfrom=2017-04-01T00:00:00&to=2017-04-01T23:59:59
Response Code
| Code |
Description |
| 200 |
Success |
| 400 |
Invalid type of parameter |
| 404 |
Absent IDs that specified or combined |
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 after switch |
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 digits number |
| gwId |
GW ID |
string |
yes |
T＋10 digits number |
| Name |
Description |
Type |
Mandatory |
Remarks |
| connectionParameters |
Connection Parameters |
object |
yes |
|
| vpnNo |
VPN Number |
string |
yes |
V+8 digits number |
| representativeNNo |
Representative N Number |
string |
yes |
N+9 digits number |
| name |
Identification 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 IDs that specified or combined |
Response Parameters
| Name |
Description |
Type |
Mandatory |
Remarks |
| interconnectionId |
Interconnection ID |
string |
yes |
U＋10 digits number |
| orderId |
Order ID |
string |
yes |
10 digits number |
Example Result
{
"interconectionId":"U9999999999"
"orderId":"9999999999"
}
Retrieve Interconnection details
THis API retrieve 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 digits number |
| gwId |
GW ID |
string |
yes |
T+10 digits number |
| interconnectionId |
Interconnection ID |
string |
yes |
U＋10 digits 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 IDs that specified or combined |
Response Parameters
| Name |
Description |
Type |
Mandatory |
Remarks |
| connectionParameters |
Contracted interconnections list |
array |
yes |
|
| name |
Name |
string |
yes |
|
| vpnNo |
VPN number |
string |
yes |
V+8 digits number |
| representativeNNo |
Representative N Number |
string |
yes |
N+9 digits number |
| multiCloudConnectNNo |
Multi Cloud Connect N Number |
string |
yes |
N+9 digits 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",
}
}
Retrieve Interconnection List
THIs API retrieve 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 digits number |
| gwId |
GW ID |
string |
yes |
T+10 digits number |
Example Request
GET /v1/sdns/contracts/999999999999999/gateways/T9999999999/interconnections
Response Code
| Code |
Description |
| 201 |
Success |
| 400 |
Invalid type of parameter |
| 404 |
Absent IDs that specified or combined |
Response Parameters
| Name |
Description |
Type |
Mandatory |
Remarks |
| gwId |
GW ID |
string |
yes |
T+10 digits number |
| interconnections |
list of interconections under contract |
array |
yes |
|
| connectionParameters |
Connection contract details |
object |
yes |
|
| interconnectionId |
Interconnection ID |
object |
yes |
U＋10 digits number |
| name |
Identification Name |
string |
yes |
|
| vpnNo |
VPN number |
string |
yes |
V+8 digits number |
| representativeNNo |
Representative N Number |
string |
yes |
N+9 digits number |
| multiCloudConnectNNo |
Multi Cloud Connect N Number |
string |
yes |
N+9 digits 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",
}
}
]
}
Modify setting of interconnection
Modify the 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 digits number |
| gwId |
GW ID |
string |
yes |
T+10 digits number |
| interconnectionId |
Interconnection ID |
string |
yes |
U＋10 digits number |
| Name |
Description |
Type |
Mandatory |
Remarks |
| connectionParameters |
Interconnection contract detail |
object |
yes |
|
| vpnNo |
VPN number |
string |
yes |
V+8 digits number #1 |
| multiCloudConnectNNo |
Multi cloud connect N number |
string |
yes |
N+9 digits number |
| representativeNNo |
Representative N Number |
string |
yes |
N+9 digits number |
| name |
Identification Name |
string |
yes |
|
| remarks |
Remarks |
string |
yes |
|
| orderStatus |
Interconnection order status |
string |
yes |
#1 |
| bandwidth |
Bandwidth |
string |
yes |
#1 |
Example Request
PUT /v1/sdns/contracts/999999999999999/gateways/T9999999999/interconnections/U9999999999
{
"connectionParameters": {
"vpnNo": "V99999999",
"multiCloudConnectNNo":"N999999999"
"representativeNNo": "N999999999",
"name": "SD-NS_NW_xxxxxx",
"remarks": "-"
"orderStatus": "Processing"
"bandwidth": "100"
}
}
Response Code
| Code |
Description |
| 202 |
Success |
| 400 |
Invalid type of parameter |
| 404 |
Absent IDs that specified or combined |
Response Parameters
| Name |
Description |
Type |
Mandatory |
Remarks |
| orderId |
Order ID |
string |
yes |
10 digits number |
Example Result
{
"orderId": "9999999999"
}
Application for terminate 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 digits number |
| gwId |
GW ID |
string |
yes |
T+10 digits number |
| interconnectionId |
Interconnection ID |
string |
yes |
U＋10 digits 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 IDs that specified or combined |
Response Parameters
| Name |
Description |
Type |
Mandatory |
Remarks |
| orderId |
Order ID |
string |
yes |
10 digits number |
Example Result
{
"orderId": "9999999999"
}
Order 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 digits number |
| Name |
Description |
Type |
Mandatory |
Remarks |
| name |
Managed option name |
string |
yes |
#1 |
| projectId |
Project ID |
string |
yes |
MG＋8 digits number |
| serviceStartRequestedDate |
Secvice Start Requested Date |
string |
yes |
#2 |
- #1 "Operation Management", "Reaction Plan", "Initial Settings", "Delivery Management", "Config by Agent".
- #2 Specify as "YYYY-MM-DD".
Example Request
POST /v1/sdns/contracts/99999999999999/managed_options
{
"name": "Delivery Management",
"projectId": "MGxxxxxx",
"serviceStartRequestedDate": "YYYY-MM-DD",
}
Response Code
| Code |
Description |
| 201 |
Success |
| 400 |
Invalid type of parameter |
| 404 |
Absent IDs that specified or combined |
Response Parameters
| Name |
Description |
Type |
Mandatory |
Remarks |
| managedOptionId |
Managed Option ID |
string |
yes |
M+10 digits number |
| orderId |
Order ID |
string |
yes |
10 digits number |
Example Result
{
"managedOptionId":"M9999999999"
"orderId": "9999999999"
}
Retrieve managed option list
This API retrieve maneged option list.
GET /v1/sdns/contracts/{contractId}/managed_options
Request Parameters
| Name |
Description |
Type |
Mandatory |
Remarks |
| contractId |
service contract number |
string |
yes |
15 digits number |
Example Request
GET /v1/sdns/contracts/999999999999999/managed_options
Response Code
| Code |
Description |
| 200 |
Success |
| 400 |
Invalid type of parameter |
| 404 |
Absent IDs that specified or combined |
Response Parameters
| Name |
Description |
Type |
Mandatory |
Remarks |
| managedOptions |
Managed options list |
array |
yes |
|
| serviceStartDate |
Service start date |
string |
no |
|
| name |
Identification Name |
string |
no |
|
| projectId |
Project ID |
string |
no |
MG＋8 digits number |
| serviceStartRequestedDate |
Requested service start 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",
}
]
}
Terminate managed option
Application for terminating managed option.
DELETE /v1/sdns/contracts/{contractId}/managed_options/{managedOptionId}
Request Parameters
| Name |
Description |
Type |
Mandatory |
Remarks |
| contractId |
Service Contract ID |
string |
yes |
15 digits number |
| managedOptionId |
Managed option ID |
string |
yes |
M+10 digits number |
Example Request
DELETE /v1/sdns/contracts/999999999999999/managed_options/M9999999999
Response Code
| Code |
Description |
| 200 |
Success |
| 400 |
Invalid type of parameter |
| 404 |
Absent IDs that specified or combined |
Response Parameters
| Name |
Description |
Type |
Mandatory |
Remarks |
| orderId |
Order ID |
string |
yes |
10 digits number |
Example Result
{
"orderId": "9999999999"
}
Retrieve the order details.
This API retrieve the order details.
GET /v1/sdns/contracts/{contractId}/orders/{orderId}
Request Parameters
| Name |
Description |
Type |
Mandatory |
Remarks |
| contractId |
Service contract ID |
string |
yes |
15 digits number |
| orderId |
Order ID |
string |
yes |
10 digits number |
Example Request
GET /v1/sdns/contracts/999999999999999/orders/999999999
Response Code
| Code |
Description |
| 200 |
Success |
| 400 |
Invalid type of parameter |
| 404 |
Absent IDs that specified or combined |
Response Parameters
| Name |
Description |
Type |
Mandatory |
Remarks |
| orderAcceptTime |
Order accepted 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 Regarfding on the 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: new application, Change: Modify, Termination: 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": "xxxxxxCo.Ltd.,",
"corpNameKana": "xxxxxx",
"sectionName": "xxxxxx",
"staffName": "xxxxxx",
"contactTel": "9999-999-999",
"email": "xxxxxx@xxx.xxx",
"zipCode": "9999999",
"address": "xxxxxxTokyo",
"buildingName": "xxxxxx"
},
"technicalContactPerson": {
"equalContractor": true,
"corpName": "xxxxxxCo.Ltd.,",
"corpNameKana": "xxxxxx",
"sectionName": "xxxxxx",
"staffName": "xxxxxx",
"contactTel": "9999-999-999",
"email": "xxxxxx@xxx.xxx"
}
}
Retrieve the order list
This API retrieve the list of order details.
GET /v1/sdns/contracts/{contractId}/orders
Request Parameters
| Name |
Description |
Type |
Mandatory |
Remarks |
| contractId |
Service contract ID |
string |
yes |
15 digits number |
| sorting |
Response order count |
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 Specify start number of the response.
- Ex) In case of response 100 orders as 2 times sepalately for each of 50 orders, the result is as following.
1st time: Count:”50”, specify offset is as “0”. Result: Respound from 1 to 50 orders.
2nd time: Count:”50”, specify offset is as “50”. Result: Respound from 51 to 100 orders.
- #3 Specify contract ID, GW, ID, Interconnect ID, terminal ID, Managed option ID those require to refine.
- #4 specift the order status one out of the "Completed", "Processing", "Cancelled", "Canceling", "Error","Preset_Error" those require to refine.
Example Request
GET /v1/sdns/contracts/999999999999999/orderssorting=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 specify the offset is larger than exist order value. |
| 404 |
Absent IDs that specified or combined |
Response Parameters
| Name |
Description |
Type |
Mandatory |
Remarks |
| contractId |
Service contract ID |
string |
yes |
15 digits number |
| orders |
List of orders |
array |
yes |
|
| orderId |
Order ID |
string |
no |
10 digits number |
| acceptTime |
Order accepted 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 reason message |
string |
no |
|
| object |
Object |
string |
no |
|
| name |
Identification name |
string |
no |
|
| orderCount |
Number of order |
string |
yes |
|
| For terminal |
|
|
|
|
| activationHistory |
Activation history |
array |
no |
|
| activationTime |
activation time |
string |
no |
|
| activationResult |
activation result |
string |
no |
|
| activationErrorReason |
activation error reason |
string |
no |
|
- #1 Ex: 2017-04-01T00:00:00
- #2 New:New application, Change:Modify, Termination: 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",
"applicationType": "New",
"remarks": "memoxxxxxx",
"lastUpdateTime": "2017-04-02T00:00:00+09:00",
"serviceType": "Terminal",
"status": "Completed",
"object": "D9999999999",
"name": "SD-NS-Terminalxxxxxxx"
"activationHistory" : [
{
"activationTime" : "2017-02-13 11:25:00",
"activationResult" : "OK",
"activationErrorReason" : null
}
]
},
],
"orderCount": "99"
}
