FIC-Connection Arcstar Universal One - Flexible InterConnect API リファレンス (2.0.0)

Download OpenAPI specification:Download

Flexible InterConnect

概要

本APIでは、Flexible InterConnectが提供するリソースの参照・操作が可能です。

Router to Arcstar Universal Oneコネクションの購入・参照・変更・廃止等の操作に関するAPIドキュメントです。

Router-to-Arcstar Universal One-Connection

List Router to Arcstar Universal One Connections

Router to Arcstar Universal Oneコネクション情報の一覧を取得します。

query Parameters

id	string ^F[0-9]{12}$ Example: id=F030123456789 コネクションID
name	string Example: name=YourConnectionName コネクション名
tenantId	string <uuid> ^[0-9a-f]{32}$ Example: tenantId=06a90740d6764465896091b1f0676048 テナントID
area	string Enum: "JPEAST" "JPWEST" Example: area=JPEAST エリア名 ‘JPEAST’または’JPWEST’
resourceGroup	string Example: resourceGroup=CR01-jpeast01 故障やメンテナンスにて影響を受ける範囲毎に割り当てられたグループ

header Parameters

Content-Type required	string Value: "application/json"
X-Auth-Token required	string ^[0-9a-f]{32}$ Example: dc03494823a841338430052e9ee95e07 クライアントが Keystone を利用して取得した認証 Token

Responses

200

OK 成功しました

400

Bad Request リクエストが不正

401

Unauthorized 認証エラー

409

Conflict 競合エラー

get/v1/router-to-uno-connections

https://api.ntt.com/fic-eri/v1/router-to-uno-connections

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"connections": 
[
{"id": "F030123456789",
"name": "YourConnectionName",
"redundant": true,
"tenantId": "06a90740d6764465896091b1f0676048",
"area": "JPEAST",
"operationStatus": "Completed",
"source": 
{"tenantId": "f123f45c183d5cd5aca12fabc1cebc88",
"routerId": "F020123456789",
"groupName": "group_1",
"routeFilter": 
{"in": "fullRoute",
"prefixInType": "permit",
"customRoutePrefixIn": 
[
{"address": "100.250.140.0/24",
"filterType": "exact"
},
{"address": "10.0.0.0/8",
"filterType": "orlonger"
}
],
"out": "fullRouteWithDefaultRoute",
"prefixOutType": "permit",
"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": 
{"med": 
{"out": 10
},
"asPathPrepend": 
{"in": null
}
},
"secondary": 
{"med": 
{"out": 20
},
"asPathPrepend": 
{"in": 1
}
}
},
"destination": 
{"interconnect": "Interconnect-Tokyo-4",
"parentContractNumber": "N123456789",
"contractNumber": "N987654321",
"vpnNumber": "V12345678",
"qosType": "guarantee",
"routeFilter": 
{"out": "fullRoute"
}
},
"bandwidth": "10M",
"connectedNwAddress": "192.168.1.0/29",
"asOverride": false,
"resourceGroup": 
{"source": "CR01-jpeast01",
"destination": null
}
}
]
}

Create Router to Arcstar Universal One Connection

始点ルーターおよび終点Arcstar Universal Oneを指定し、Router to Arcstar Universal Oneコネクションを購入します。

サービス概要や、注意事項等の詳細情報に関しましてはこちらをご参照下さい。

事前にお客さまにご準備いただくものや、画面での操作に関しましてはこちらをご参照下さい。

header Parameters

Content-Type required	string Value: "application/json"
X-Auth-Token required	string ^[0-9a-f]{32}$ Example: dc03494823a841338430052e9ee95e07 クライアントが Keystone を利用して取得した認証 Token

Request Body schema: application/json

connection

required

object

Responses

202

Accepted 要求は受け付けられました

400

Bad Request リクエストが不正

401

Unauthorized 認証エラー

409

Conflict 競合エラー

503

Service Unavailable　サービスが一時的に利用不可

post/v1/router-to-uno-connections

https://api.ntt.com/fic-eri/v1/router-to-uno-connections

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"connection": 
{"name": "YourConnectionName",
"tenantId": "06a90740d6764465896091b1f0676048",
"source": 
{"routerId": "F020123456789",
"groupName": "group_1",
"routeFilter": 
{"in": "fullRoute",
"prefixInType": "permit",
"customRoutePrefixIn": 
[
{"address": "100.250.140.0/24",
"filterType": "exact"
},
{"address": "10.0.0.0/8",
"filterType": "orlonger"
}
],
"out": "fullRouteWithDefaultRoute",
"prefixOutType": "permit",
"customRoutePrefixOut": 
[
{"address": "110.0.3.0/24",
"filterType": "orlonger"
},
{"address": "172.16.0.0/16",
"filterType": "exact"
}
]
},
"primary": 
{"med": 
{"out": 10
},
"asPathPrepend": 
{"in": null
}
},
"secondary": 
{"med": 
{"out": 20
},
"asPathPrepend": 
{"in": 1
}
}
},
"destination": 
{"interconnect": "Interconnect-Tokyo-4",
"parentContractNumber": "N123456789",
"vpnNumber": "V12345678",
"cNumber": "C1234567890",
"qosType": "guarantee",
"routeFilter": 
{"out": "fullRoute"
}
},
"bandwidth": "10M",
"connectedNwAddress": "192.168.1.0/29",
"asOverride": false
}
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"connection": 
{"id": "F030123456789",
"name": "YourConnectionName",
"redundant": true,
"tenantId": "06a90740d6764465896091b1f0676048",
"area": "JPEAST",
"operationStatus": "Processing",
"operationId": "14d2ea73cf2c477a83ab7ac031f1aee3",
"source": 
{"tenantId": "f123f45c183d5cd5aca12fabc1cebc88",
"routerId": "F020123456789",
"groupName": "group_1",
"routeFilter": 
{"in": "fullRoute",
"prefixInType": "permit",
"customRoutePrefixIn": 
[
{"address": "100.250.140.0/24",
"filterType": "exact"
},
{"address": "10.0.0.0/8",
"filterType": "orlonger"
}
],
"out": "fullRouteWithDefaultRoute",
"prefixOutType": "permit",
"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": 
{"med": 
{"out": 10
},
"asPathPrepend": 
{"in": null
}
},
"secondary": 
{"med": 
{"out": 20
},
"asPathPrepend": 
{"in": 1
}
}
},
"destination": 
{"interconnect": "Interconnect-Tokyo-4",
"parentContractNumber": "N123456789",
"contractNumber": null,
"vpnNumber": "V12345678",
"cNumber": "C1234567890",
"qosType": "guarantee",
"routeFilter": 
{"out": "fullRoute"
}
},
"bandwidth": "10M",
"connectedNwAddress": "192.168.1.0/29",
"asOverride": false,
"resourceGroup": 
{"source": null,
"destination": null
}
}
}

Show Router to Arcstar Universal One Connection

指定したRouter to Arcstar Universal Oneコネクションの詳細情報を取得します。

path Parameters

required

string

対象コネクションID

header Parameters

Content-Type required	string Value: "application/json"
X-Auth-Token required	string ^[0-9a-f]{32}$ Example: dc03494823a841338430052e9ee95e07 クライアントが Keystone を利用して取得した認証 Token

Responses

200

OK 成功しました

400

Bad Request リクエストが不正

401

Unauthorized 認証エラー

404

Not Found 未検出エラー

409

Conflict 競合エラー

get/v1/router-to-uno-connections/{id}

https://api.ntt.com/fic-eri/v1/router-to-uno-connections/{id}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"connection": 
{"id": "F030123456789",
"name": "YourConnectionName",
"redundant": true,
"tenantId": "06a90740d6764465896091b1f0676048",
"area": "JPEAST",
"operationStatus": "Processing",
"source": 
{"tenantId": "f123f45c183d5cd5aca12fabc1cebc88",
"routerId": "F020123456789",
"groupName": "group_1",
"routeFilter": 
{"in": "fullRoute",
"prefixInType": "permit",
"customRoutePrefixIn": 
[
{"address": "100.250.140.0/24",
"filterType": "exact"
},
{"address": "10.0.0.0/8",
"filterType": "orlonger"
}
],
"out": "fullRouteWithDefaultRoute",
"prefixOutType": "permit",
"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": 
{"med": 
{"out": 10
},
"asPathPrepend": 
{"in": null
}
},
"secondary": 
{"med": 
{"out": 20
},
"asPathPrepend": 
{"in": 1
}
}
},
"destination": 
{"interconnect": "Interconnect-Tokyo-4",
"parentContractNumber": "N123456789",
"contractNumber": "N987654321",
"vpnNumber": "V12345678",
"qosType": "guarantee",
"routeFilter": 
{"out": "fullRoute"
}
},
"bandwidth": "10M",
"connectedNwAddress": "192.168.1.0/29",
"asOverride": false,
"resourceGroup": 
{"source": "CR01-jpeast01",
"destination": null
}
}
}

Update Router to Arcstar Universal One Connection

指定したRouter to Arcstar Universal Oneコネクションを変更します。destination側の経路変更と帯域変更は同時実行できません。

path Parameters

required

string

対象コネクションID

header Parameters

Content-Type required	string Value: "application/json"
X-Auth-Token required	string ^[0-9a-f]{32}$ Example: dc03494823a841338430052e9ee95e07 クライアントが Keystone を利用して取得した認証 Token

Request Body schema: application/json

connection

required

object

Responses

202

Accepted 要求は受け付けられました

400

Bad Request リクエストが不正

401

Unauthorized 認証エラー

404

Not Found 未検出エラー

409

Conflict 競合エラー

503

Service Unavailable　サービスが一時的に利用不可

patch/v1/router-to-uno-connections/{id}

https://api.ntt.com/fic-eri/v1/router-to-uno-connections/{id}

Request samples

Payload

Content type

application/json

Example

Copy

Expand all Collapse all


{"connection": 
{"source": 
{"routeFilter": 
{"in": "fullRoute",
"prefixInType": "permit",
"customRoutePrefixIn": 
[
{"address": "100.250.140.0/24",
"filterType": "exact"
},
{"address": "10.0.0.0/8",
"filterType": "orlonger"
}
],
"out": "fullRoute",
"prefixOutType": "permit",
"customRoutePrefixOut": 
[
{"address": "110.0.3.0/24",
"filterType": "orlonger"
},
{"address": "172.16.0.0/16",
"filterType": "exact"
}
]
},
"primary": 
{"med": 
{"out": 30
},
"asPathPrepend": 
{"in": 2
}
},
"secondary": 
{"med": 
{"out": 40
},
"asPathPrepend": 
{"in": 3
}
}
},
"destination": 
{"routeFilter": 
{"out": "defaultRoute"
}
},
"asOverride": true
}
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"connection": 
{"id": "F030123456789",
"name": "YourConnectionNameUpdate",
"redundant": true,
"tenantId": "06a90740d6764465896091b1f0676048",
"area": "JPEAST",
"operationStatus": "Processing",
"operationId": "a95666b85c8d4abcb0419a5ab27b7af0",
"source": 
{"tenantId": "f123f45c183d5cd5aca12fabc1cebc88",
"routerId": "F020123456789",
"groupName": "group_1",
"routeFilter": 
{"in": "fullRoute",
"prefixInType": "permit",
"customRoutePrefixIn": 
[
{"address": "100.250.140.0/24",
"filterType": "exact"
},
{"address": "10.0.0.0/8",
"filterType": "orlonger"
}
],
"out": "fullRoute",
"prefixOutType": "permit",
"customRoutePrefixOut": 
[
{"address": "110.0.3.0/24",
"filterType": "orlonger"
},
{"address": "172.16.0.0/16",
"filterType": "exact"
}
]
},
"primary": 
{"med": 
{"out": 30
},
"asPathPrepend": 
{"in": 2
}
},
"secondary": 
{"med": 
{"out": 40
},
"asPathPrepend": 
{"in": 3
}
}
},
"destination": 
{"interconnect": "Interconnect-Tokyo-4",
"parentContractNumber": "N123456789",
"contractNumber": "N987654321",
"vpnNumber": "V12345678",
"qosType": "guarantee",
"routeFilter": 
{"out": "defaultRoute"
}
},
"bandwidth": "50M",
"connectedNwAddress": "192.168.1.0/29",
"asOverride": true,
"resourceGroup": 
{"source": "CR01-jpeast01",
"destination": null
}
}
}

Delete Router to Arcstar Universal One Connection

指定したRouter to Arcstar Universal Oneコネクションを廃止します。

path Parameters

required

string

対象コネクションID

header Parameters

Content-Type required	string Value: "application/json"
X-Auth-Token required	string ^[0-9a-f]{32}$ Example: dc03494823a841338430052e9ee95e07 クライアントが Keystone を利用して取得した認証 Token

Responses

202

Accepted 要求は受け付けられました

400

Bad Request リクエストが不正

401

Unauthorized 認証エラー

404

Not Found 未検出エラー

409

Conflict 競合エラー

503

Service Unavailable　サービスが一時的に利用不可

delete/v1/router-to-uno-connections/{id}

https://api.ntt.com/fic-eri/v1/router-to-uno-connections/{id}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"connection": 
{"id": "F030123456789",
"name": "YourConnectionName",
"redundant": true,
"tenantId": "06a90740d6764465896091b1f0676048",
"area": "JPEAST",
"operationStatus": "Processing",
"operationId": "a95666b85c8d4abcb0419a5ab27b7af0",
"source": 
{"tenantId": "f123f45c183d5cd5aca12fabc1cebc88",
"routerId": "F020123456789",
"groupName": "group_1",
"routeFilter": 
{"in": "fullRoute",
"prefixInType": "permit",
"customRoutePrefixIn": 
[
{"address": "100.250.140.0/24",
"filterType": "exact"
},
{"address": "10.0.0.0/8",
"filterType": "orlonger"
}
],
"out": "fullRoute",
"prefixOutType": "permit",
"customRoutePrefixOut": 
[
{"address": "110.0.3.0/24",
"filterType": "orlonger"
},
{"address": "172.16.0.0/16",
"filterType": "exact"
}
]
},
"primary": 
{"med": 
{"out": 30
},
"asPathPrepend": 
{"in": 2
}
},
"secondary": 
{"med": 
{"out": 40
},
"asPathPrepend": 
{"in": 3
}
}
},
"destination": 
{"interconnect": "Interconnect-Tokyo-4",
"parentContractNumber": "N123456789",
"contractNumber": "N987654321",
"vpnNumber": "V12345678",
"qosType": "guarantee",
"routeFilter": 
{"out": "fullRoute"
}
},
"bandwidth": "10M",
"connectedNwAddress": "192.168.1.0/29",
"asOverride": true,
"resourceGroup": 
{"source": "CR01-jpeast01",
"destination": null
}
}
}