docomo business SIGN FIC-Connection APIリファレンス (1.0.0)

Download OpenAPI specification:Download

docomo business SIGN FIC-Connection APIリファレンス

Router

購入されたルーターの参照に関するAPI

ルーター一覧取得用API

購入されたルーターを一覧表示するAPI

path Parameters

tenantId

required

string 32 characters 0-9a-f

Example: 550e8400e29b41d4a716446655440000

テナントID

header Parameters

X-Auth-Token

required

string 32 characters 0-9a-f

Example: 098e5cb2b91c4b63a64e47dfe17a5f76

ログイン時に取得するIDトークン

Responses

200

400

Bad Request

401

Unauthorized

409

Conflict

500

Internal Server Error

get/tenants/{tenantId}/fic/routers

https://api.ntt.com/sdpf-iot-pf/v1/tenants/{tenantId}/fic/routers

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"routers": 
[
{"id": "F020123456789",
"name": "YourRouterName",
"redundant": true,
"tenantId": "f123f45c183d5cd5aca12fabc1cebc72",
"area": "JPEAST",
"operationStatus": "Processing",
"userIpAddress": "192.168.0.0/27",
"isPublicServiceEndpoint": true,
"firewalls": 
[
{"id": "F040000000001",
"isActivated": false
}
],
"nats": 
[
{"id": "F050000000001",
"isActivated": false
}
],
"routingGroups": 
[
{"name": "group_1"
}
],
"config": 
{"permitNewConnection": false
},
"maxprefix": 4000,
"resourceGroup": 
{"component": "FW01-jpeast01"
}
}
]
}

FIC-Connection

テナント間の接続オーダー実行や、それらの状況の情報取得に関するAPI

FIC-Connectionの一覧取得用API

FIC-Connection情報の一覧を取得します。

path Parameters

tenantId

required

string 32 characters 0-9a-f

Example: 550e8400e29b41d4a716446655440000

テナントID

query Parameters

ficType

string

Value: "icms"

Example: ficType=icms

Queryパラメーターなしの場合、全種別のFIC-Connectionを取得

header Parameters

X-Auth-Token

required

string 32 characters 0-9a-f

Example: 098e5cb2b91c4b63a64e47dfe17a5f76

ログイン時に取得するIDトークン

Responses

200

400

Bad Request

401

Unauthorized

409

Conflict

500

Internal Server Error

get/tenants/{tenantId}/fic/connections

https://api.ntt.com/sdpf-iot-pf/v1/tenants/{tenantId}/fic/connections

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"connections": 
[
{"id": "F030123456789",
"ficType": "icms",
"name": "newIoT-XXX",
"redundant": true,
"tenantId": "06a90740d6764465896091b1f0676048",
"area": "JPEAST",
"operationStatus": "Completed",
"bandwidth": "100M",
"source": 
{"tenantId": "06a90740d6764465896091b1f0676048",
"routerId": "F020123456789",
"groupName": "group_1",
"routeFilter": 
{"in": "fullRoute",
"prefixInType": "permit",
"maxBgpPrefixListIn": 10,
"customRoutePrefixIn": 
[
{"address": "100.250.140.0/24",
"filterType": "exact"
},
{"address": "10.0.0.0/8",
"filterType": "orlonger"
}
],
"out": "fullRouteWithDefaultRoute",
"prefixOutType": "permit",
"maxBgpPrefixListOut": 10,
"customRoutePrefixOut": 
[
{"address": "110.0.3.0/24",
"filterType": "orlonger"
},
{"address": "172.16.0.0/16",
"filterType": "exact"
},
{"address": "0.0.0.0/0",
"filterType": "exact"
}
],
"primary": 
{"ipAddress": "10.0.0.1/30",
"asPathPrepend": 
{"in": null,
"out": null
},
"med": 
{"out": 10
}
},
"secondary": 
{"ipAddress": "10.30.0.1/30",
"asPathPrepend": 
{"in": null,
"out": null
},
"med": 
{"out": 20
}
}
}
},
"destination": 
{"publicServiceKey": "YourSellerServiceKey",
"publicServiceId": "X000000000001",
"publicServiceName": "YourSellerServiceName",
"primary": 
{"tenantId": "e23db5208b27490e8942ce0c0278d56f",
"portId": "F010123456789",
"vlan": 113,
"ipAddress": "10.0.0.2/30",
"asn": "65000"
},
"secondary": 
{"tenantId": "e23db5208b27490e8942ce0c0278d56f",
"portId": "F019876543210",
"vlan": 114,
"ipAddress": "10.0.0.6/30",
"asn": "65000"
}
},
"interTenant": true,
"toPublicService": true,
"resourceGroup": 
{"source": "UR01-jpeast01",
"destination": null
}
}
]
}

FIC-Connection購入用API

FIC-Connectionの承認依頼から購入までを行うAPI。

path Parameters

tenantId

required

string 32 characters 0-9a-f

Example: 550e8400e29b41d4a716446655440000

テナントID

header Parameters

X-Auth-Token

required

string 32 characters 0-9a-f

Example: 098e5cb2b91c4b63a64e47dfe17a5f76

ログイン時に取得するIDトークン

Request Body schema: application/json

name required	string コネクション名 `newIoT-`で始まる半角英数及び一部記号&()-_ 64文字
ficType required	string Value: "icms" FIC-Connection接続先
routerId required	string ^F[0-9]{12}$ ルーターID
bandwidth required	string Enum: "10M" "20M" "30M" "40M" "50M" "100M" "200M" "300M" "400M" "500M" "1G" "2G" "3G" "4G" "5G" "10G" 接続帯域 '10M/20M/30M/40M/50M/100M/200M/300M/400M/500M/1G/2G/3G/4G/5G/10G'のいずれか

Responses

201

Created

400

Bad Request

401

Unauthorized

409

Conflict

500

Internal Server Error

post/tenants/{tenantId}/fic/connections

https://api.ntt.com/sdpf-iot-pf/v1/tenants/{tenantId}/fic/connections

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"name": "newIoT-XXX",
"ficType": "icms",
"routerId": "F020123456789",
"bandwidth": "100M"
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"approvalRequest": 
{"requestId": "req0000000001",
"approverType": "tenant_owner",
"approverId": "24661ade0df34648ae6ca58d83b3173a",
"requestUserId": "ecid1234567890",
"service": "Flexible InterConnect",
"actions": 
{"type": "Router-to-Port-Connection",
"method": "POST",
"resourceId": "F030123456789",
"body": 
{"connection": 
{"name": "newIoT-XXX",
"bandwidth": "100M",
"source": 
{"routerId": "F020123456789",
"groupName": "group_1",
"routeFilter": 
{"in": "fullRoute",
"prefixInType": "permit",
"maxBgpPrefixListIn": 10,
"customRoutePrefixIn": 
[
{"address": "100.250.140.0/24",
"filterType": "exact"
},
{"address": "10.0.0.0/8",
"filterType": "orlonger"
}
],
"out": "fullRouteWithDefaultRoute",
"prefixOutType": "permit",
"maxBgpPrefixListOut": 10,
"customRoutePrefixOut": 
[
{"address": "110.0.3.0/24",
"filterType": "orlonger"
},
{"address": "172.16.0.0/16",
"filterType": "exact"
}
]
},
"primary": 
{"ipAddress": "10.0.0.1/30",
"asPathPrepend": 
{"in": null,
"out": null
},
"med": 
{"out": 10
}
},
"secondary": 
{"ipAddress": "10.0.0.5/30",
"asPathPrepend": 
{"in": null,
"out": null
},
"med": 
{"out": 20
}
}
},
"destination": 
{"publicServiceKey": "YourSellerServiceKey",
"primary": 
{"portId": "F010123456789",
"vlan": 113,
"ipAddress": "10.0.0.2/30",
"asn": "65000"
},
"secondary": 
{"portId": "F019876543210",
"vlan": 114,
"ipAddress": "10.0.0.6/30",
"asn": "65000"
}
}
}
}
},
"descriptions": 
{"lang": "en",
"text": "Request for 'Router-to-Router-Connection' from tenant c8296ad5c4434c8093f818d252b25483' to tenant '24661ade0df34648ae6ca58d83b3173a'"
},
"requestUser": true,
"approver": false,
"approvalDeadline": "2020-07-24 05:43:44",
"registeredTime": "2020-07-24 05:43:46",
"status": "registered",
"externalRequestId": null,
"executed": false,
"toPublicService": true,
"orderType": "updateBandwidth"
}
}

FIC-Connectionの詳細取得用API

FIC-Connectionの詳細情報を取得します。

path Parameters

tenantId required	string 32 characters 0-9a-f Example: 550e8400e29b41d4a716446655440000 テナントID
ficType required	string Value: "icms" Example: icms 取得対象のFIC-Connectionを指定
id required	string 対象コネクションID

header Parameters

X-Auth-Token

required

string 32 characters 0-9a-f

Example: 098e5cb2b91c4b63a64e47dfe17a5f76

ログイン時に取得するIDトークン

Responses

200

400

Bad Request

401

Unauthorized

404

Not Found

409

Conflict

500

Internal Server Error

get/tenants/{tenantId}/fic/connections/{ficType}/{id}

https://api.ntt.com/sdpf-iot-pf/v1/tenants/{tenantId}/fic/connections/{ficType}/{id}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"id": "F030123456789",
"ficType": "icms",
"name": "newIoT-XXX",
"redundant": true,
"tenantId": "06a90740d6764465896091b1f0676048",
"area": "JPEAST",
"operationStatus": "Completed",
"bandwidth": "100M",
"source": 
{"tenantId": "06a90740d6764465896091b1f0676048",
"routerId": "F020123456789",
"groupName": "group_1",
"routeFilter": 
{"in": "fullRoute",
"prefixInType": "permit",
"maxBgpPrefixListIn": 10,
"customRoutePrefixIn": 
[
{"address": "100.250.140.0/24",
"filterType": "exact"
},
{"address": "10.0.0.0/8",
"filterType": "orlonger"
}
],
"out": "fullRouteWithDefaultRoute",
"prefixOutType": "permit",
"maxBgpPrefixListOut": 10,
"customRoutePrefixOut": 
[
{"address": "110.0.3.0/24",
"filterType": "orlonger"
},
{"address": "172.16.0.0/16",
"filterType": "exact"
},
{"address": "0.0.0.0/0",
"filterType": "exact"
}
],
"primary": 
{"ipAddress": "10.0.0.1/30",
"asPathPrepend": 
{"in": null,
"out": null
},
"med": 
{"out": 10
}
},
"secondary": 
{"ipAddress": "10.30.0.1/30",
"asPathPrepend": 
{"in": null,
"out": null
},
"med": 
{"out": 20
}
}
}
},
"destination": 
{"publicServiceKey": "YourSellerServiceKey",
"publicServiceId": "X000000000001",
"publicServiceName": "YourSellerServiceName",
"primary": 
{"tenantId": "e23db5208b27490e8942ce0c0278d56f",
"portId": "F010123456789",
"vlan": 113,
"ipAddress": "10.0.0.2/30",
"asn": "65000"
},
"secondary": 
{"tenantId": "e23db5208b27490e8942ce0c0278d56f",
"portId": "F019876543210",
"vlan": 114,
"ipAddress": "10.0.0.6/30",
"asn": "65000"
}
},
"interTenant": true,
"toPublicService": true,
"resourceGroup": 
{"source": "UR01-jpeast01",
"destination": null
}
}

FIC-Connectionの廃止用API

指定したFIC-Connectionを廃止します。

path Parameters

tenantId required	string 32 characters 0-9a-f Example: 550e8400e29b41d4a716446655440000 テナントID
ficType required	string Value: "icms" Example: icms 取得対象のFIC-Connectionを指定
id required	string 対象コネクションID

header Parameters

X-Auth-Token

required

string 32 characters 0-9a-f

Example: 098e5cb2b91c4b63a64e47dfe17a5f76

ログイン時に取得するIDトークン

Responses

202

400

Bad Request

401

Unauthorized

409

Conflict

500

Internal Server Error

delete/tenants/{tenantId}/fic/connections/{ficType}/{id}

https://api.ntt.com/sdpf-iot-pf/v1/tenants/{tenantId}/fic/connections/{ficType}/{id}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"id": "F030123456789",
"ficType": "icms",
"name": "newIoT-XXX",
"redundant": true,
"tenantId": "06a90740d6764465896091b1f0676048",
"area": "JPEAST",
"operationStatus": "Completed",
"bandwidth": "100M",
"source": 
{"tenantId": "06a90740d6764465896091b1f0676048",
"routerId": "F020123456789",
"groupName": "group_1",
"routeFilter": 
{"in": "fullRoute",
"prefixInType": "permit",
"maxBgpPrefixListIn": 10,
"customRoutePrefixIn": 
[
{"address": "100.250.140.0/24",
"filterType": "exact"
},
{"address": "10.0.0.0/8",
"filterType": "orlonger"
}
],
"out": "fullRouteWithDefaultRoute",
"prefixOutType": "permit",
"maxBgpPrefixListOut": 10,
"customRoutePrefixOut": 
[
{"address": "110.0.3.0/24",
"filterType": "orlonger"
},
{"address": "172.16.0.0/16",
"filterType": "exact"
},
{"address": "0.0.0.0/0",
"filterType": "exact"
}
],
"primary": 
{"ipAddress": "10.0.0.1/30",
"asPathPrepend": 
{"in": null,
"out": null
},
"med": 
{"out": 10
}
},
"secondary": 
{"ipAddress": "10.30.0.1/30",
"asPathPrepend": 
{"in": null,
"out": null
},
"med": 
{"out": 20
}
}
}
},
"destination": 
{"publicServiceKey": "YourSellerServiceKey",
"publicServiceId": "X000000000001",
"publicServiceName": "YourSellerServiceName",
"primary": 
{"tenantId": "e23db5208b27490e8942ce0c0278d56f",
"portId": "F010123456789",
"vlan": 113,
"ipAddress": "10.0.0.2/30",
"asn": "65000"
},
"secondary": 
{"tenantId": "e23db5208b27490e8942ce0c0278d56f",
"portId": "F019876543210",
"vlan": 114,
"ipAddress": "10.0.0.6/30",
"asn": "65000"
}
},
"interTenant": true,
"toPublicService": true,
"resourceGroup": 
{"source": "UR01-jpeast01",
"destination": null
},
"operationId": "8d49e2ab41a54598aec02c0f198ab0e3"
}