Entry Pack - Flexible InterConnect API リファレンス (2.0.0)

Download OpenAPI specification:Download

Flexible InterConnect

概要

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

Entry Packの購入・参照・変更・廃止等の操作に関するAPIドキュメントです。

Entry-Pack

List Entry Packs

Entry Pack情報の一覧を取得します。

query Parameters

id	string ^F[0-9]{12}$ Example: id=F062100000001 Entry Pack ID
routerId	string ^F[0-9]{12}$ Example: routerId=F022100000001 ルーターID
eclConnectionId	string ^F[0-9]{12}$ Example: eclConnectionId=F030123456789 SDPF Cloud/ServerコネクションID
unoConnectionId	string ^F[0-9]{12}$ Example: unoConnectionId=F030123456789 Arcstar Universal OneコネクションID
routerName	string Example: routerName=YourRouterName ルーター名
eclConnectionName	string Example: eclConnectionName=YourConnectionName SDPF Cloud/Serverコネクション名
unoConnectionName	string Example: unoConnectionName=YourConnectionName Arcstar Universal Oneコネクション名
area	string Enum: "JPEAST" "JPWEST" Example: area=JPEAST エリア名 ‘JPEAST’または’JPWEST’
tenantId	string ^[0-9a-f]{32}$ Example: tenantId=87e89b8f075a4ee1aa209f6ca6ce242c テナントID
resourceGroup	string Example: resourceGroup=CR01E-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/entry-packs

https://api.ntt.com/fic-eri/v1/entry-packs

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"entryPacks": 
[
{"id": "F062100000001",
"operationStatus": "Completed",
"router": 
{"id": "F022100000001",
"name": "router01",
"area": "JPEAST",
"redundant": true,
"userIpAddress": "192.168.0.0/27",
"isPublicServiceEndpoint": false,
"tenantId": "f123f45c183d5cd5aca12fabc1cebc72",
"routingGroups": 
[
{"name": "group_1"
}
]
},
"eclConnection": 
{"id": "F032100000002",
"name": "ecl01",
"redundant": true,
"tenantId": "f123f45c183d5cd5aca12fabc1cebc72",
"area": "JPEAST",
"bandwidth": "100M",
"source": 
{"tenantId": "f123f45c183d5cd5aca12fabc1cebc72",
"routerId": "F022100000001",
"groupName": "group_1",
"routeFilter": 
{"in": "fullRoute",
"out": "fullRoute"
}
},
"destination": 
{"interconnect": "ECL-TYO-1-a",
"qosType": "besteffort",
"eclTenantId": "20c33449388f4071bf629b15fd9237bd"
},
"primaryConnectedNwAddress": "192.168.1.0/30",
"secondaryConnectedNwAddress": "192.168.1.4/30"
},
"unoConnection": 
{"id": "F032100000003",
"name": "uno01",
"redundant": true,
"tenantId": "f123f45c183d5cd5aca12fabc1cebc72",
"area": "JPEAST",
"bandwidth": "100M",
"source": 
{"tenantId": "f123f45c183d5cd5aca12fabc1cebc72",
"routerId": "F022100000001",
"groupName": "group_1",
"routeFilter": 
{"in": "fullRoute",
"out": "fullRouteWithDefaultRoute"
},
"primary": 
{"med": 
{"out": 10
}
},
"secondary": 
{"med": 
{"out": 20
}
}
},
"destination": 
{"interconnect": "Interconnect-Tokyo-1",
"vpnNumber": "V12345678",
"parentContractNumber": "N111407577",
"contractNumber": "N987654321",
"qosType": "besteffort",
"routeFilter": 
{"out": "fullRoute"
}
},
"connectedNwAddress": "192.168.2.0/29"
},
"resourceGroup": 
{"source": "CR01E-jpeast01",
"destination": null
}
}
]
}

Create Entry Pack

Entry Packを購入します。

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

entryPack

required

object

Responses

202

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

400

Bad Request リクエストが不正

401

Unauthorized 認証エラー

409

Conflict 競合エラー

503

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

post/v1/entry-packs

https://api.ntt.com/fic-eri/v1/entry-packs

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"entryPack": 
{"key": "f123f45c183d5cd5aca12fabc1ceabcd",
"router": 
{"name": "router01",
"area": "JPEAST",
"userIpAddress": "192.168.0.0/27"
},
"eclConnection": 
{"name": "ecl01",
"source": 
{"routeFilter": 
{"in": "fullRoute",
"out": "fullRoute"
}
},
"destination": 
{"interconnect": "ECL-TYO-1-a",
"qosType": "besteffort",
"eclTenantId": "xxxx",
"eclApiKey": "yyyy",
"eclApiSecretKey": "zzzz"
},
"bandwidth": "100M",
"primaryConnectedNwAddress": "192.168.1.0/30",
"secondaryConnectedNwAddress": "192.168.1.4/30"
},
"unoConnection": 
{"name": "uno01",
"source": 
{"routeFilter": 
{"in": "fullRoute",
"out": "fullRouteWithDefaultRoute"
},
"primary": 
{"med": 
{"out": 10
}
}
},
"destination": 
{"interconnect": "Interconnect-Tokyo-1",
"parentContractNumber": "N111407577",
"vpnNumber": "V12345678",
"cNumber": "C1234567890",
"qosType": "besteffort",
"routeFilter": 
{"out": "fullRoute"
}
},
"bandwidth": "100M",
"connectedNwAddress": "192.168.2.0/29"
}
}
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"entryPack": 
{"id": "F062100000001",
"operationStatus": "Processing",
"operationId": "bb16e2c4153b11e9ab14d663bd873d93",
"router": 
{"id": "F022100000001",
"name": "router01",
"area": "JPEAST",
"redundant": true,
"userIpAddress": "192.168.0.0/27",
"isPublicServiceEndpoint": false,
"tenantId": "f123f45c183d5cd5aca12fabc1cebc72",
"routingGroups": 
[
{"name": "group_1"
}
]
},
"eclConnection": 
{"id": "F032100000002",
"name": "ecl01",
"redundant": true,
"tenantId": "f123f45c183d5cd5aca12fabc1cebc72",
"area": "JPEAST",
"bandwidth": "100M",
"source": 
{"tenantId": "f123f45c183d5cd5aca12fabc1cebc72",
"routerId": "F022100000001",
"groupName": "group_1",
"routeFilter": 
{"in": "fullRoute",
"out": "fullRoute"
}
},
"destination": 
{"interconnect": "ECL-TYO-1-a",
"qosType": "besteffort",
"eclTenantId": "xxxx"
},
"primaryConnectedNwAddress": "192.168.1.0/30",
"secondaryConnectedNwAddress": "192.168.1.4/30"
},
"unoConnection": 
{"id": "F032100000003",
"name": "uno01",
"redundant": true,
"tenantId": "f123f45c183d5cd5aca12fabc1cebc72",
"area": "JPEAST",
"bandwidth": "100M",
"source": 
{"tenantId": "f123f45c183d5cd5aca12fabc1cebc72",
"routerId": "F022100000001",
"groupName": "group_1",
"routeFilter": 
{"in": "fullRoute",
"out": "fullRouteWithDefaultRoute"
},
"primary": 
{"med": 
{"out": 10
}
},
"secondary": 
{"med": 
{"out": 20
}
}
},
"destination": 
{"interconnect": "Interconnect-Tokyo-1",
"vpnNumber": "V12345678",
"parentContractNumber": "N111407577",
"contractNumber": null,
"cNumber": "C1234567890",
"qosType": "besteffort",
"routeFilter": 
{"out": "fullRoute"
}
},
"connectedNwAddress": "192.168.2.0/29"
},
"resourceGroup": 
{"source": null,
"destination": null
}
}
}

Show Entry Pack

指定したEntry Packの詳細情報を取得します。

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/entry-packs/{id}

https://api.ntt.com/fic-eri/v1/entry-packs/{id}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"entryPack": 
{"id": "F062100000001",
"operationStatus": "Completed",
"router": 
{"id": "F022100000001",
"name": "router01",
"area": "JPEAST",
"redundant": true,
"userIpAddress": "192.168.0.0/27",
"isPublicServiceEndpoint": false,
"tenantId": "f123f45c183d5cd5aca12fabc1cebc72",
"routingGroups": 
[
{"name": "group_1"
}
]
},
"eclConnection": 
{"id": "F032100000002",
"name": "ecl01",
"redundant": true,
"tenantId": "f123f45c183d5cd5aca12fabc1cebc72",
"area": "JPEAST",
"bandwidth": "100M",
"source": 
{"tenantId": "f123f45c183d5cd5aca12fabc1cebc72",
"routerId": "F022100000001",
"groupName": "group_1",
"routeFilter": 
{"in": "fullRoute",
"out": "fullRoute"
}
},
"destination": 
{"interconnect": "ECL-TYO-1-a",
"qosType": "besteffort",
"eclTenantId": "xxxx"
},
"primaryConnectedNwAddress": "192.168.1.0/30",
"secondaryConnectedNwAddress": "192.168.1.4/30"
},
"unoConnection": 
{"id": "F032100000003",
"name": "uno01",
"redundant": true,
"tenantId": "f123f45c183d5cd5aca12fabc1cebc72",
"area": "JPEAST",
"bandwidth": "100M",
"source": 
{"tenantId": "f123f45c183d5cd5aca12fabc1cebc72",
"routerId": "F022100000001",
"groupName": "group_1",
"routeFilter": 
{"in": "fullRoute",
"out": "fullRouteWithDefaultRoute"
},
"primary": 
{"med": 
{"out": 10
}
},
"secondary": 
{"med": 
{"out": 20
}
}
},
"destination": 
{"interconnect": "Interconnect-Tokyo-1",
"vpnNumber": "V12345678",
"parentContractNumber": "N111407577",
"contractNumber": "N987654321",
"qosType": "besteffort",
"routeFilter": 
{"out": "fullRoute"
}
},
"connectedNwAddress": "192.168.2.0/29"
},
"resourceGroup": 
{"source": "CR01E-jpeast01",
"destination": null
}
}
}

Update Entry Pack

指定したEntry Packを変更します。(経路変更のみ可能です。)

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

entryPack

required

object

Responses

202

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

400

Bad Request リクエストが不正

401

Unauthorized 認証エラー

404

Not Found 未検出エラー

409

Conflict 競合エラー

503

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

patch/v1/entry-packs/{id}

https://api.ntt.com/fic-eri/v1/entry-packs/{id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"entryPack": 
{"eclConnection": 
{"source": 
{"routeFilter": 
{"in": "noRoute",
"out": "noRoute"
}
}
},
"unoConnection": 
{"source": 
{"routeFilter": 
{"in": "noRoute",
"out": "noRoute"
},
"primary": 
{"med": 
{"out": 30
}
}
},
"destination": 
{"routeFilter": 
{"out": "noRoute"
}
}
}
}
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"entryPack": 
{"id": "F062100000001",
"operationStatus": "Processing",
"operationId": "bb16e2c4153b11e9ab14d663bd873d93",
"router": 
{"id": "F022100000001",
"name": "router02",
"area": "JPEAST",
"redundant": true,
"userIpAddress": "192.168.0.0/27",
"isPublicServiceEndpoint": false,
"tenantId": "f123f45c183d5cd5aca12fabc1cebc72",
"routingGroups": 
[
{"name": "group_1"
}
]
},
"eclConnection": 
{"id": "F032100000002",
"name": "ecl02",
"redundant": true,
"tenantId": "f123f45c183d5cd5aca12fabc1cebc72",
"area": "JPEAST",
"bandwidth": "100M",
"source": 
{"tenantId": "f123f45c183d5cd5aca12fabc1cebc72",
"routerId": "F022100000001",
"groupName": "group_1",
"routeFilter": 
{"in": "noRoute",
"out": "noRoute"
}
},
"destination": 
{"interconnect": "ECL-TYO-1-a",
"qosType": "besteffort",
"eclTenantId": "xxxx"
},
"primaryConnectedNwAddress": "192.168.1.0/30",
"secondaryConnectedNwAddress": "192.168.1.4/30"
},
"unoConnection": 
{"id": "F032100000003",
"name": "uno02",
"redundant": true,
"tenantId": "f123f45c183d5cd5aca12fabc1cebc72",
"area": "JPEAST",
"bandwidth": "100M",
"source": 
{"tenantId": "f123f45c183d5cd5aca12fabc1cebc72",
"routerId": "F022100000001",
"groupName": "group_1",
"routeFilter": 
{"in": "noRoute",
"out": "noRoute"
},
"primary": 
{"med": 
{"out": 30
}
},
"secondary": 
{"med": 
{"out": 40
}
}
},
"destination": 
{"interconnect": "Interconnect-Tokyo-1",
"vpnNumber": "V12345678",
"parentContractNumber": "N111407577",
"contractNumber": "N987654321",
"qosType": "besteffort",
"routeFilter": 
{"out": "noRoute"
}
},
"connectedNwAddress": "192.168.2.0/29"
},
"resourceGroup": 
{"source": "CR01E-jpeast01",
"destination": null
}
}
}

Delete Entry Pack

指定したEntry Packを廃止します。

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/entry-packs/{id}

https://api.ntt.com/fic-eri/v1/entry-packs/{id}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"entryPack": 
{"id": "F062100000001",
"operationStatus": "Processing",
"operationId": "bb16e2c4153b11e9ab14d663bd873d93",
"router": 
{"id": "F022100000001",
"name": "router02",
"area": "JPEAST",
"redundant": true,
"userIpAddress": "192.168.0.0/27",
"isPublicServiceEndpoint": false,
"tenantId": "f123f45c183d5cd5aca12fabc1cebc72",
"routingGroups": 
[
{"name": "group_1"
}
]
},
"eclConnection": 
{"id": "F032100000002",
"name": "ecl02",
"redundant": true,
"tenantId": "f123f45c183d5cd5aca12fabc1cebc72",
"area": "JPEAST",
"bandwidth": "100M",
"source": 
{"tenantId": "f123f45c183d5cd5aca12fabc1cebc72",
"routerId": "F022100000001",
"groupName": "group_1",
"routeFilter": 
{"in": "noRoute",
"out": "noRoute"
}
},
"destination": 
{"interconnect": "ECL-TYO-1-a",
"qosType": "besteffort",
"eclTenantId": "xxxx"
},
"primaryConnectedNwAddress": "192.168.1.0/30",
"secondaryConnectedNwAddress": "192.168.1.4/30"
},
"unoConnection": 
{"id": "F032100000003",
"name": "uno02",
"redundant": true,
"tenantId": "f123f45c183d5cd5aca12fabc1cebc72",
"area": "JPEAST",
"bandwidth": "100M",
"source": 
{"tenantId": "f123f45c183d5cd5aca12fabc1cebc72",
"routerId": "F022100000001",
"groupName": "group_1",
"routeFilter": 
{"in": "noRoute",
"out": "noRoute"
},
"primary": 
{"med": 
{"out": 30
}
},
"secondary": 
{"med": 
{"out": 40
}
}
},
"destination": 
{"interconnect": "Interconnect-Tokyo-1",
"vpnNumber": "V12345678",
"parentContractNumber": "N111407577",
"contractNumber": "N987654321",
"qosType": "besteffort",
"routeFilter": 
{"out": "noRoute"
}
},
"connectedNwAddress": "192.168.2.0/29"
},
"resourceGroup": 
{"source": "CR01E-jpeast01",
"destination": null
}
}
}