FIC-Premium Connection(XaaS接続) - Flexible InterConnect API リファレンス (19.0)
Download OpenAPI specification:Download
本APIでは、Flexible InterConnectが提供するリソースの参照・操作が可能です。
Premium Router to Port Premium コネクション(XaaS接続)/Premium Router to Virtual Port(XaaS)【Pattern S】AWS(Public VIF) Premium コネクション/Premium Router to Virtual Port(XaaS)【Pattern X】 Premium コネクションの購入・参照・変更・廃止等の操作に関するAPIドキュメントです。
List Premium Router to Port Premium Connections(XaaS接続)
Premium Router to Port Premium コネクション(XaaS接続)情報の一覧を取得します。
query Parameters
| id | string ^F[0-9]{12}$ Example: id=F930123456789 コネクションID |
| name | string [ 1 .. 64 ] characters Example: name=YourConnectionName コネクション名 半角英数及び一部記号&()-_ 64文字 |
| tenantId | string <uuid> ^[0-9a-f]{32}$ Example: tenantId=db8b0e40743f460685040c46167cf19e テナントID 半角英数32文字 |
| area | string Enum: "JPEAST" "JPWEST" Example: area=JPEAST エリア名 'JPEAST'または'JPWEST' |
| interTenant | boolean Example: interTenant=true テナント間接続フラグ 'true'(テナント間接続)固定 |
| resourceGroup | string Example: resourceGroup=PCR01-jpeast02 故障やメンテナンスにて影響を受ける範囲毎に割り当てられたグループ |
header Parameters
| Content-Type required | string Value: "application/json" |
| X-Auth-Token required | string ^[0-9a-f]{32}$ Example: dc03494823a841338430052e9ee95e07 クライアントが Keystone を利用して取得した認証 Token |
Responses
OK 成功しました
Bad Request リクエストが不正
Unauthorized 認証エラー
Conflict 競合エラー
Response samples
- 200
{- "connections": [
- {
- "id": "F930123456789",
- "name": "YourConnectionName",
- "redundant": true,
- "tenantId": "db8b0e40743f460685040c46167cf19e",
- "area": "JPEAST",
- "operationStatus": "Completed",
- "bandwidth": "100M",
- "source": {
- "tenantId": "db8b0e40743f460685040c46167cf19e",
- "routerId": "F920123456789",
- "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": {
- "out": null
}, - "med": {
- "out": 10
}
}, - "secondary": {
- "ipAddress": "10.0.1.1/30",
- "asPathPrepend": {
- "out": 1
}, - "med": {
- "out": 20
}
}, - "priority": {
- "active": "primary",
- "startTime": null
}, - "maxPrefixLimit": 100
}, - "destination": {
- "publicServiceKey": "YourSellerServiceKey",
- "publicServiceId": "X000000000001",
- "publicServiceName": "YourSellerServiceName",
- "primary": {
- "tenantId": "aaaaae40743f460685040c46167cf19e",
- "portId": "F010123456789",
- "portName": "PortName",
- "vlan": 113,
- "ipAddress": "10.0.0.2/30",
- "asn": "65000"
}, - "secondary": {
- "tenantId": "aaaaae40743f460685040c46167cf19e",
- "portId": "F019876543210",
- "portName": "PortName",
- "vlan": 114,
- "ipAddress": "10.0.1.2/30",
- "asn": "65000"
}
}, - "interTenant": false,
- "toPublicService": true,
- "resourceGroup": {
- "source": "PUR01-jpeast02",
- "destination": null
}
}
]
}Create Premium Router to Port Premium Connection(XaaS接続)
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
Accepted 要求は受け付けられました
Bad Request リクエストが不正
Unauthorized 認証エラー
Conflict 競合エラー
Request samples
- Payload
{- "connection": {
- "name": "YourConnectionName",
- "bandwidth": "100M",
- "source": {
- "routerId": "F920123456789",
- "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": {
- "out": null
}, - "med": {
- "out": 10
}
}, - "secondary": {
- "ipAddress": "10.0.1.1/30",
- "asPathPrepend": {
- "out": 1
}, - "med": {
- "out": 20
}
}, - "maxPrefixLimit": 100
}, - "destination": {
- "publicServiceKey": null,
- "primary": {
- "portId": "F010123456789",
- "vlan": 113,
- "ipAddress": "10.0.0.2/30",
- "asn": "65000"
}, - "secondary": {
- "portId": "F019876543210",
- "vlan": 114,
- "ipAddress": "10.0.1.2/30",
- "asn": "65000"
}
}, - "approvalRequestId": "req0000000001"
}
}Response samples
- 202
{- "connection": {
- "id": "F930123456789",
- "name": "YourConnectionName",
- "redundant": true,
- "tenantId": "db8b0e40743f460685040c46167cf19e",
- "area": "JPEAST",
- "operationStatus": "Processing",
- "bandwidth": "100M",
- "source": {
- "tenantId": "db8b0e40743f460685040c46167cf19e",
- "routerId": "F920123456789",
- "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": {
- "out": null
}, - "med": {
- "out": 10
}
}, - "secondary": {
- "ipAddress": "10.0.1.1/30",
- "asPathPrepend": {
- "out": 1
}, - "med": {
- "out": 20
}
}, - "priority": {
- "active": "primary",
- "startTime": null
}, - "maxPrefixLimit": 100
}, - "destination": {
- "publicServiceKey": null,
- "publicServiceId": null,
- "publicServiceName": null,
- "primary": {
- "tenantId": "aaaaae40743f460685040c46167cf19e",
- "portId": "F010123456789",
- "portName": "PortName",
- "vlan": null,
- "ipAddress": "10.0.0.2/30",
- "asn": "65000"
}, - "secondary": {
- "tenantId": "aaaaae40743f460685040c46167cf19e",
- "portId": "F019876543210",
- "portName": "PortName",
- "vlan": null,
- "ipAddress": "10.0.1.2/30",
- "asn": "65000"
}
}, - "interTenant": false,
- "toPublicService": true,
- "resourceGroup": {
- "source": null,
- "destination": null
}, - "operationId": "2fb5baa5a5834e0b952d3f0d93c3e64a"
}
}Show Premium Router to Port Premium Connection(XaaS接続)
指定したPremium Router to Port Premium コネクション(XaaS接続)の詳細情報を取得します。
path Parameters
| id required | string ^F[0-9]{12}$ Example: F930123456789 対象コネクションID |
header Parameters
| Content-Type required | string Value: "application/json" |
| X-Auth-Token required | string ^[0-9a-f]{32}$ Example: dc03494823a841338430052e9ee95e07 クライアントが Keystone を利用して取得した認証 Token |
Responses
OK 成功しました
Bad Request リクエストが不正
Unauthorized 認証エラー
Not Found 未検出エラー
Conflict 競合エラー
Response samples
- 200
{- "connection": {
- "id": "F930123456789",
- "name": "YourConnectionName",
- "redundant": true,
- "tenantId": "db8b0e40743f460685040c46167cf19e",
- "area": "JPEAST",
- "operationStatus": "Completed",
- "bandwidth": "100M",
- "source": {
- "tenantId": "db8b0e40743f460685040c46167cf19e",
- "routerId": "F920123456789",
- "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": {
- "out": null
}, - "med": {
- "out": 10
}
}, - "secondary": {
- "ipAddress": "10.0.1.1/30",
- "asPathPrepend": {
- "out": 1
}, - "med": {
- "out": 20
}
}, - "priority": {
- "active": "primary",
- "startTime": null
}, - "maxPrefixLimit": 100
}, - "destination": {
- "publicServiceKey": "YourSellerServiceKey",
- "publicServiceId": "X000000000001",
- "publicServiceName": "YourSellerServiceName",
- "primary": {
- "tenantId": "aaaaae40743f460685040c46167cf19e",
- "portId": "F010123456789",
- "portName": "PortName",
- "vlan": 113,
- "ipAddress": "10.0.0.2/30",
- "asn": "65000"
}, - "secondary": {
- "tenantId": "aaaaae40743f460685040c46167cf19e",
- "portId": "F019876543210",
- "portName": "PortName",
- "vlan": 114,
- "ipAddress": "10.0.1.2/30",
- "asn": "65000"
}
}, - "interTenant": false,
- "toPublicService": true,
- "resourceGroup": {
- "source": "PUR01-jpeast02",
- "destination": null
}
}
}Update Premium Router to Port Premium Connection(XaaS接続)
指定したPremium Router to Port Premium コネクション(XaaS接続)を変更します。各種変更操作は同時実行できます。
XaaS接続の場合、帯域変更と経路変更の同時実行は不可。(帯域変更とリソース名変更は同時実行可能。)
path Parameters
| id required | string ^F[0-9]{12}$ Example: F930123456789 対象コネクション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 | object |
Responses
Accepted 要求は受け付けられました
Bad Request リクエストが不正
Unauthorized 認証エラー
Not Found 未検出エラー
Conflict 競合エラー
Request samples
- Payload
{- "connection": {
- "name": "YourConnectionNameUpdate"
}
}Response samples
- 202
{- "connection": {
- "id": "F930123456789",
- "name": "YourConnectionName",
- "redundant": true,
- "tenantId": "db8b0e40743f460685040c46167cf19e",
- "area": "JPEAST",
- "operationStatus": "Processing",
- "bandwidth": "100M",
- "source": {
- "tenantId": "db8b0e40743f460685040c46167cf19e",
- "routerId": "F920123456789",
- "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": {
- "out": null
}, - "med": {
- "out": 10
}
}, - "secondary": {
- "ipAddress": "10.0.1.1/30",
- "asPathPrepend": {
- "out": 1
}, - "med": {
- "out": 20
}
}, - "priority": {
- "active": "primary",
- "startTime": null
}, - "maxPrefixLimit": 100
}, - "destination": {
- "publicServiceKey": "YourSellerServiceKey",
- "publicServiceId": "X000000000001",
- "publicServiceName": "YourSellerServiceName",
- "primary": {
- "tenantId": "aaaaae40743f460685040c46167cf19e",
- "portId": "F010123456789",
- "portName": "PortName",
- "vlan": 113,
- "ipAddress": "10.0.0.2/30",
- "asn": "65000"
}, - "secondary": {
- "tenantId": "aaaaae40743f460685040c46167cf19e",
- "portId": "F019876543210",
- "portName": "PortName",
- "vlan": 114,
- "ipAddress": "10.0.1.2/30",
- "asn": "65000"
}
}, - "interTenant": false,
- "toPublicService": true,
- "resourceGroup": {
- "source": "PUR01-jpeast02",
- "destination": null
}, - "operationId": "2fb5baa5a5834e0b952d3f0d93c3e64a"
}
}Delete Premium Router to Port Premium Connection(XaaS接続)
指定したPremium Router to Port Premium コネクション(XaaS接続)を廃止します。
path Parameters
| id required | string ^F[0-9]{12}$ Example: F930123456789 対象コネクションID |
header Parameters
| Content-Type required | string Value: "application/json" |
| X-Auth-Token required | string ^[0-9a-f]{32}$ Example: dc03494823a841338430052e9ee95e07 クライアントが Keystone を利用して取得した認証 Token |
Responses
Accepted 要求は受け付けられました
Bad Request リクエストが不正
Unauthorized 認証エラー
Not Found 未検出エラー
Conflict 競合エラー
Response samples
- 202
{- "connection": {
- "id": "F930123456789",
- "name": "YourConnectionName",
- "redundant": true,
- "tenantId": "db8b0e40743f460685040c46167cf19e",
- "area": "JPEAST",
- "operationStatus": "Processing",
- "bandwidth": "100M",
- "source": {
- "tenantId": "db8b0e40743f460685040c46167cf19e",
- "routerId": "F920123456789",
- "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": {
- "out": null
}, - "med": {
- "out": 10
}
}, - "secondary": {
- "ipAddress": "10.0.1.1/30",
- "asPathPrepend": {
- "out": 1
}, - "med": {
- "out": 20
}
}, - "priority": {
- "active": "primary",
- "startTime": null
}, - "maxPrefixLimit": 100
}, - "destination": {
- "publicServiceKey": "YourSellerServiceKey",
- "publicServiceId": "X000000000001",
- "publicServiceName": "YourSellerServiceName",
- "primary": {
- "tenantId": "aaaaae40743f460685040c46167cf19e",
- "portId": "F010123456789",
- "portName": "PortName",
- "vlan": 113,
- "ipAddress": "10.0.0.2/30",
- "asn": "65000"
}, - "secondary": {
- "tenantId": "aaaaae40743f460685040c46167cf19e",
- "portId": "F019876543210",
- "portName": "PortName",
- "vlan": 114,
- "ipAddress": "10.0.1.2/30",
- "asn": "65000"
}
}, - "interTenant": false,
- "toPublicService": true,
- "resourceGroup": {
- "source": "PUR01-jpeast02",
- "destination": null
}, - "operationId": "2fb5baa5a5834e0b952d3f0d93c3e64a"
}
}Update Premium Router to Port Premium Connection(XaaS接続) Priority
指定したPremium Router to Port Premium コネクション(XaaS接続)のPriortyを変更します。
path Parameters
| id required | string ^F[0-9]{12}$ Example: F930123456789 対象コネクション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
Accepted 要求は受け付けられました
Bad Request リクエストが不正
Unauthorized 認証エラー
Not Found 未検出エラー
Conflict 競合エラー
Request samples
- Payload
{- "connection": {
- "source": {
- "priority": {
- "active": "secondary"
}
}
}
}Response samples
- 202
{- "connection": {
- "id": "F930123456789",
- "name": "YourConnectionName",
- "redundant": true,
- "tenantId": "db8b0e40743f460685040c46167cf19e",
- "area": "JPEAST",
- "operationStatus": "Processing",
- "bandwidth": "100M",
- "source": {
- "tenantId": "db8b0e40743f460685040c46167cf19e",
- "routerId": "F920123456789",
- "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": {
- "out": null
}, - "med": {
- "out": 10
}
}, - "secondary": {
- "ipAddress": "10.0.1.1/30",
- "asPathPrepend": {
- "out": 1
}, - "med": {
- "out": 20
}
}, - "priority": {
- "active": "secondary",
- "startTime": "2026-03-01T06:48:00Z"
}, - "maxPrefixLimit": 100
}, - "destination": {
- "publicServiceKey": "YourSellerServiceKey",
- "publicServiceId": "X000000000001",
- "publicServiceName": "YourSellerServiceName",
- "primary": {
- "tenantId": "aaaaae40743f460685040c46167cf19e",
- "portId": "F010123456789",
- "portName": "PortName",
- "vlan": 113,
- "ipAddress": "10.0.0.2/30",
- "asn": "65000"
}, - "secondary": {
- "tenantId": "aaaaae40743f460685040c46167cf19e",
- "portId": "F019876543210",
- "portName": "PortName",
- "vlan": 114,
- "ipAddress": "10.0.1.2/30",
- "asn": "65000"
}
}, - "interTenant": false,
- "toPublicService": true,
- "resourceGroup": {
- "source": "PUR01-jpeast02",
- "destination": null
}, - "operationId": "2fb5baa5a5834e0b952d3f0d93c3e64a"
}
}List Premium Router to Virtual Port(XaaS)【Pattern S】AWS(Public VIF) Premium Connections
Premium Router to Virtual Port(XaaS)【Pattern S】AWS(Public VIF) Premium コネクションの詳細情報一覧を取得します。
query Parameters
| id | string ^F[0-9]{12}$ Example: id=F930123456789 コネクションID |
| name | string [ 1 .. 64 ] characters Example: name=YourConnectionName コネクション名 半角英数及び一部記号&()-_ 64文字 |
| tenantId | string <uuid> ^[0-9a-f]{32}$ Example: tenantId=db8b0e40743f460685040c46167cf19e テナントID 半角英数32文字 |
| area | string Enum: "JPEAST" "JPWEST" Example: area=JPEAST エリア名 'JPEAST'または'JPWEST' |
| resourceGroup | string Example: resourceGroup=PCR01-jpeast02 故障やメンテナンスにて影響を受ける範囲毎に割り当てられたグループ |
header Parameters
| Content-Type required | string Value: "application/json" |
| X-Auth-Token required | string ^[0-9a-f]{32}$ Example: dc03494823a841338430052e9ee95e07 クライアントが Keystone を利用して取得した認証 Token |
Responses
OK 成功しました
Bad Request リクエストが不正
Unauthorized 認証エラー
Conflict 競合エラー
Response samples
- 200
{- "connections": [
- {
- "id": "F930123456789",
- "name": "YourConnectionName",
- "redundant": true,
- "tenantId": "db8b0e40743f460685040c46167cf19e",
- "area": "JPEAST",
- "operationStatus": "Completed",
- "bandwidth": "100M",
- "source": {
- "tenantId": "db8b0e40743f460685040c46167cf19e",
- "routerId": "F920123456789",
- "groupName": "group_1",
- "routeFilter": {
- "in": "customRoute",
- "prefixInType": "permit",
- "maxBgpPrefixListIn": 10,
- "customRoutePrefixIn": [
- {
- "address": "100.250.140.0/24",
- "filterType": "exact"
}, - {
- "address": "10.0.0.0/8",
- "filterType": "orlonger"
}
], - "out": "natRoute"
}, - "primary": {
- "asPathPrepend": {
- "out": null
}
}, - "secondary": {
- "asPathPrepend": {
- "out": 1
}
}, - "community": {
- "out": "7224:9100"
}, - "priority": {
- "active": "primary",
- "startTime": null
}
}, - "destination": {
- "publicServiceKey": "YourSellerServiceKey",
- "publicServiceId": "X000000000001",
- "publicServiceName": "YourSellerServiceName",
- "tenantId": "aaaaae40743f460685040c46167cf19e",
- "portId": "F910123456789",
- "primary": {
- "asn": "65515"
}, - "secondary": {
- "asn": "65515"
}, - "qosType": "guarantee",
- "awsAccountId": "123456789012",
- "advertisedPublicPrefixes": [
- "100.131.66.79/32",
- "100.131.66.80/32"
], - "awsAccountName": "aaabbb"
}, - "primaryConnectedNwAddress": "10.0.0.0/30",
- "secondaryConnectedNwAddress": "10.0.1.0/30",
- "interTenant": true,
- "toPublicService": true,
- "resourceGroup": {
- "source": "PCR01-jpeast02",
- "destination": null
}
}
]
}Create Premium Router to Virtual Port(XaaS)【Pattern S】AWS(Public VIF) Premium Connection
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
Accepted 要求は受け付けられました
Bad Request リクエストが不正
Unauthorized 認証エラー
Conflict 競合エラー
Request samples
- Payload
{- "connection": {
- "name": "YourConnectionName",
- "bandwidth": "100M",
- "source": {
- "routerId": "F920123456789",
- "groupName": "group_1",
- "routeFilter": {
- "in": "customRoute",
- "prefixInType": "permit",
- "maxBgpPrefixListIn": 10,
- "customRoutePrefixIn": [
- {
- "address": "100.250.140.0/24",
- "filterType": "exact"
}, - {
- "address": "10.0.0.0/8",
- "filterType": "orlonger"
}
], - "out": "natRoute"
}, - "primary": {
- "asPathPrepend": {
- "out": null
}
}, - "secondry": {
- "asPathPrepend": {
- "out": 1
}
}, - "community": {
- "out": "7224:9100"
}
}, - "destination": {
- "publicServiceKey": null,
- "portId": "F910123456789",
- "qosType": "guarantee",
- "awsAccountId": "123456789012",
- "advertisedPublicPrefixes": [
- "100.131.66.79/32",
- "100.131.66.80/32"
], - "awsAccountName": "aaabbb"
}, - "approvalRequestId": "req1234567890"
}
}Response samples
- 202
{- "connection": {
- "id": "F930123456789",
- "name": "YourConnectionName",
- "redundant": true,
- "tenantId": "db8b0e40743f460685040c46167cf19e",
- "area": "JPEAST",
- "operationStatus": "Processing",
- "bandwidth": "100M",
- "source": {
- "tenantId": "db8b0e40743f460685040c46167cf19e",
- "routerId": "F920123456789",
- "groupName": "group_1",
- "routeFilter": {
- "in": "customRoute",
- "prefixInType": "permit",
- "maxBgpPrefixListIn": 10,
- "customRoutePrefixIn": [
- {
- "address": "100.250.140.0/24",
- "filterType": "exact"
}, - {
- "address": "10.0.0.0/8",
- "filterType": "orlonger"
}
], - "out": "natRoute"
}, - "primary": {
- "asPathPrepend": {
- "out": null
}
}, - "secondary": {
- "asPathPrepend": {
- "out": 1
}
}, - "community": {
- "out": "7224:9100"
}, - "priority": {
- "active": "primary",
- "startTime": null
}
}, - "destination": {
- "publicServiceKey": null,
- "publicServiceId": null,
- "publicServiceName": null,
- "tenantId": "aaaaae40743f460685040c46167cf19e",
- "portId": "F910123456789",
- "primary": {
- "asn": "65515"
}, - "secondary": {
- "asn": "65515"
}, - "qosType": "guarantee",
- "awsAccountId": "123456789012",
- "advertisedPublicPrefixes": [
- "100.131.66.79/32",
- "100.131.66.80/32"
], - "awsAccountName": "aaabbb"
}, - "primaryConnectedNwAddress": "10.0.0.0/30",
- "secondaryConnectedNwAddress": "10.0.1.0/30",
- "interTenant": true,
- "toPublicService": true,
- "resourceGroup": {
- "source": null,
- "destination": null
}, - "operationId": "2fb5baa5a5834e0b952d3f0d93c3e64a"
}
}Show Premium Router to Virtual Port(XaaS)【Pattern S】AWS(Public VIF) Premium Connection
指定したPremium Router to Virtual Port(XaaS)【Pattern S】AWS(Public VIF) Premium コネクションの詳細情報を取得します。
path Parameters
| id required | string ^F[0-9]{12}$ Example: F930123456789 対象コネクションID |
header Parameters
| Content-Type required | string Value: "application/json" |
| X-Auth-Token required | string ^[0-9a-f]{32}$ Example: dc03494823a841338430052e9ee95e07 クライアントが Keystone を利用して取得した認証 Token |
Responses
OK 成功しました
Bad Request リクエストが不正
Unauthorized 認証エラー
Not Found 未検出エラー
Conflict 競合エラー
Response samples
- 200
{- "connection": {
- "id": "F930123456789",
- "name": "YourConnectionName",
- "redundant": true,
- "tenantId": "db8b0e40743f460685040c46167cf19e",
- "area": "JPEAST",
- "operationStatus": "Completed",
- "bandwidth": "100M",
- "source": {
- "tenantId": "db8b0e40743f460685040c46167cf19e",
- "routerId": "F920123456789",
- "groupName": "group_1",
- "routeFilter": {
- "in": "customRoute",
- "prefixInType": "permit",
- "maxBgpPrefixListIn": 10,
- "customRoutePrefixIn": [
- {
- "address": "100.250.140.0/24",
- "filterType": "exact"
}, - {
- "address": "10.0.0.0/8",
- "filterType": "orlonger"
}
], - "out": "natRoute"
}, - "primary": {
- "asPathPrepend": {
- "out": null
}
}, - "secondary": {
- "asPathPrepend": {
- "out": 1
}
}, - "community": {
- "out": "7224:9100"
}, - "priority": {
- "active": "primary",
- "startTime": null
}
}, - "destination": {
- "publicServiceKey": "YourSellerServiceKey",
- "publicServiceId": "X000000000001",
- "publicServiceName": "YourSellerServiceName",
- "tenantId": "aaaaae40743f460685040c46167cf19e",
- "portId": "F910123456789",
- "primary": {
- "asn": "65515"
}, - "secondary": {
- "asn": "65515"
}, - "qosType": "guarantee",
- "awsAccountId": "123456789012",
- "advertisedPublicPrefixes": [
- "100.131.66.79/32",
- "100.131.66.80/32"
], - "awsAccountName": "aaabbb"
}, - "primaryConnectedNwAddress": "10.0.0.0/30",
- "secondaryConnectedNwAddress": "10.0.1.0/30",
- "interTenant": true,
- "toPublicService": true,
- "resourceGroup": {
- "source": "PCR01-jpeast02",
- "destination": null
}
}
}Update Premium Router to Virtual Port(XaaS)【Pattern S】AWS(Public VIF) Premium Connection
指定したPremium Router to Virtual Port(XaaS)【Pattern S】AWS(Public VIF) Premium コネクションの設定を変更します。
各種変更操作は同時実行できます。
path Parameters
| id required | string ^F[0-9]{12}$ Example: F930123456789 対象コネクション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 | object |
Responses
Accepted 要求は受け付けられました
Bad Request リクエストが不正
Unauthorized 認証エラー
Not Found 未検出エラー
Conflict 競合エラー
Request samples
- Payload
{- "connection": {
- "name": "YourConnectionNameUpdate"
}
}Response samples
- 202
{- "connection": {
- "id": "F930123456789",
- "name": "YourConnectionName",
- "redundant": true,
- "tenantId": "db8b0e40743f460685040c46167cf19e",
- "area": "JPEAST",
- "operationStatus": "Processing",
- "bandwidth": "100M",
- "source": {
- "tenantId": "db8b0e40743f460685040c46167cf19e",
- "routerId": "F920123456789",
- "groupName": "group_1",
- "routeFilter": {
- "in": "noRoute",
- "prefixInType": "off",
- "maxBgpPrefixListIn": 20,
- "customRoutePrefixIn": [
- {
- "address": "100.250.150.0/24",
- "filterType": "exact"
}, - {
- "address": "10.1.0.0/8",
- "filterType": "orlonger"
}
], - "out": "noRoute"
}, - "primary": {
- "asPathPrepend": {
- "out": null
}
}, - "secondary": {
- "asPathPrepend": {
- "out": 1
}
}, - "community": {
- "out": "7224:9200"
}, - "priority": {
- "active": "primary",
- "startTime": null
}
}, - "destination": {
- "publicServiceKey": "YourSellerServiceKey",
- "publicServiceId": "X000000000001",
- "publicServiceName": "YourSellerServiceName",
- "tenantId": "aaaaae40743f460685040c46167cf19e",
- "portId": "F910123456789",
- "primary": {
- "asn": "65515"
}, - "secondary": {
- "asn": "65515"
}, - "qosType": "guarantee",
- "awsAccountId": "123456789012",
- "advertisedPublicPrefixes": [
- "100.131.66.79/32",
- "100.131.66.80/32"
], - "awsAccountName": "aaabbb"
}, - "primaryConnectedNwAddress": "10.0.0.0/30",
- "secondaryConnectedNwAddress": "10.0.1.0/30",
- "interTenant": true,
- "toPublicService": true,
- "resourceGroup": {
- "source": "PCR01-jpeast02",
- "destination": null
}, - "operationId": "2fb5baa5a5834e0b952d3f0d93c3e64a"
}
}Delete Premium Router to Virtual Port(XaaS)【Pattern S】AWS(Public VIF) Premium Connection
指定したPremium Router to Virtual Port(XaaS)【Pattern S】AWS(Public VIF) Premium コネクションを廃止します。
path Parameters
| id required | string ^F[0-9]{12}$ Example: F930123456789 対象コネクションID |
header Parameters
| Content-Type required | string Value: "application/json" |
| X-Auth-Token required | string ^[0-9a-f]{32}$ Example: dc03494823a841338430052e9ee95e07 クライアントが Keystone を利用して取得した認証 Token |
Responses
Accepted 要求は受け付けられました
Bad Request リクエストが不正
Unauthorized 認証エラー
Not Found 未検出エラー
Conflict 競合エラー
Response samples
- 202
{- "connection": {
- "id": "F930123456789",
- "name": "YourConnectionName",
- "redundant": true,
- "tenantId": "db8b0e40743f460685040c46167cf19e",
- "area": "JPEAST",
- "operationStatus": "Processing",
- "bandwidth": "100M",
- "source": {
- "tenantId": "db8b0e40743f460685040c46167cf19e",
- "routerId": "F920123456789",
- "groupName": "group_1",
- "routeFilter": {
- "in": "customRoute",
- "prefixInType": "permit",
- "maxBgpPrefixListIn": 10,
- "customRoutePrefixIn": [
- {
- "address": "100.250.140.0/24",
- "filterType": "exact"
}, - {
- "address": "10.0.0.0/8",
- "filterType": "orlonger"
}
], - "out": "natRoute"
}, - "primary": {
- "asPathPrepend": {
- "out": null
}
}, - "secondary": {
- "asPathPrepend": {
- "out": 1
}
}, - "community": {
- "out": "7224:9100"
}, - "priority": {
- "active": "primary",
- "startTime": null
}
}, - "destination": {
- "publicServiceKey": "YourSellerServiceKey",
- "publicServiceId": "X000000000001",
- "publicServiceName": "YourSellerServiceName",
- "tenantId": "aaaaae40743f460685040c46167cf19e",
- "portId": "F910123456789",
- "primary": {
- "asn": "65515"
}, - "secondary": {
- "asn": "65515"
}, - "qosType": "guarantee",
- "awsAccountId": "123456789012",
- "advertisedPublicPrefixes": [
- "100.131.66.79/32",
- "100.131.66.80/32"
], - "awsAccountName": "aaabbb"
}, - "primaryConnectedNwAddress": "10.0.0.0/30",
- "secondaryConnectedNwAddress": "10.0.1.0/30",
- "interTenant": true,
- "toPublicService": true,
- "resourceGroup": {
- "source": "PCR01-jpeast02",
- "destination": null
}, - "operationId": "2fb5baa5a5834e0b952d3f0d93c3e64a"
}
}Update Premium Router to Virtual Port(XaaS)【Pattern S】AWS(Public VIF) Premium Connection Priority
指定したPremium Router to Virtual Port(XaaS)【Pattern S】AWS(Public VIF) Premium コネクションの優先度を変更します。
path Parameters
| id required | string ^F[0-9]{12}$ Example: F930123456789 対象コネクション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
Accepted 要求は受け付けられました
Bad Request リクエストが不正
Unauthorized 認証エラー
Not Found 未検出エラー
Conflict 競合エラー
Request samples
- Payload
{- "connection": {
- "source": {
- "priority": {
- "active": "secondary"
}
}
}
}Response samples
- 202
{- "connection": {
- "id": "F930123456789",
- "name": "YourConnectionName",
- "redundant": true,
- "tenantId": "db8b0e40743f460685040c46167cf19e",
- "area": "JPEAST",
- "operationStatus": "Processing",
- "bandwidth": "100M",
- "source": {
- "tenantId": "db8b0e40743f460685040c46167cf19e",
- "routerId": "F920123456789",
- "groupName": "group_1",
- "routeFilter": {
- "in": "customRoute",
- "prefixInType": "permit",
- "maxBgpPrefixListIn": 10,
- "customRoutePrefixIn": [
- {
- "address": "100.250.140.0/24",
- "filterType": "exact"
}, - {
- "address": "10.0.0.0/8",
- "filterType": "orlonger"
}
], - "out": "natRoute"
}, - "primary": {
- "asPathPrepend": {
- "out": null
}
}, - "secondary": {
- "asPathPrepend": {
- "out": 1
}
}, - "community": {
- "out": "7224:9100"
}, - "priority": {
- "active": "secondary",
- "startTime": "2026-03-01T06:48:00Z"
}
}, - "destination": {
- "publicServiceKey": "YourSellerServiceKey",
- "publicServiceId": "X000000000001",
- "publicServiceName": "YourSellerServiceName",
- "tenantId": "aaaaae40743f460685040c46167cf19e",
- "portId": "F910123456789",
- "primary": {
- "asn": "65515"
}, - "secondary": {
- "asn": "65515"
}, - "qosType": "guarantee",
- "awsAccountId": "123456789012",
- "advertisedPublicPrefixes": [
- "100.131.66.79/32",
- "100.131.66.80/32"
], - "awsAccountName": "aaabbb"
}, - "primaryConnectedNwAddress": "10.0.0.0/30",
- "secondaryConnectedNwAddress": "10.0.1.0/30",
- "interTenant": true,
- "toPublicService": true,
- "resourceGroup": {
- "source": "PCR01-jpeast02",
- "destination": null
}, - "operationId": "2fb5baa5a5834e0b952d3f0d93c3e64a"
}
}List Premium Router to Virtual Port(XaaS)【Pattern X】Premium Connections
Premium Router to Virtual Port(XaaS)【Pattern X】 Premium コネクション情報の一覧を取得します。
query Parameters
| id | string ^F[0-9]{12}$ Example: id=F030123456789 コネクションID |
| name | string [ 1 .. 64 ] characters Example: name=YourConnectionName コネクション名 半角英数及び一部記号&()-_ 64文字 |
| tenantId | string <uuid> ^[0-9a-f]{32}$ Example: tenantId=db8b0e40743f460685040c46167cf19e テナントID 半角英数32文字 |
| area | string Enum: "JPEAST" "JPWEST" Example: area=JPEAST エリア名 'JPEAST'または'JPWEST' |
| interTenant | boolean Example: interTenant=true テナント間接続フラグ 'true'(テナント間接続)固定 |
| resourceGroup | string Example: resourceGroup=UR01-jpeast01 故障やメンテナンスにて影響を受ける範囲毎に割り当てられたグループ |
header Parameters
| Content-Type required | string Value: "application/json" |
| X-Auth-Token required | string ^[0-9a-f]{32}$ Example: dc03494823a841338430052e9ee95e07 クライアントが Keystone を利用して取得した認証 Token |
Responses
OK 成功しました
Bad Request リクエストが不正
Unauthorized 認証エラー
Conflict 競合エラー
Response samples
- 200
{- "connections": [
- {
- "id": "F930123456789",
- "name": "YourConnectionName",
- "redundant": true,
- "tenantId": "db8b0e40743f460685040c46167cf19e",
- "area": "JPEAST",
- "operationStatus": "Completed",
- "bandwidth": "100M",
- "source": {
- "tenantId": "db8b0e40743f460685040c46167cf19e",
- "routerId": "F920123456789",
- "groupName": "group_1",
- "routeFilter": {
- "in": "fullRoute",
- "prefixInType": "permit",
- "maxBgpPrefixListIn": 10,
- "customRoutePrefixIn": [
- {
- "address": "100.250.140.0/24",
- "filterType": "exact"
}, - {
- "address": "35.180.0.0/16",
- "filterType": "orlonger"
}
], - "out": "fullRouteWithDefaultRoute",
- "prefixOutType": "permit",
- "maxBgpPrefixListOut": 10,
- "customRoutePrefixOut": [
- {
- "address": "100.250.140.0/24",
- "filterType": "exact"
}, - {
- "address": "35.180.0.0/16",
- "filterType": "orlonger"
}
]
}, - "primary": {
- "ipAddress": "10.0.0.1/30",
- "asPathPrepend": {
- "out": null
}, - "med": {
- "out": 10
}
}, - "secondary": {
- "ipAddress": "10.0.1.1/30",
- "asPathPrepend": {
- "out": 1
}, - "med": {
- "out": 20
}
}, - "priority": {
- "active": "primary",
- "startTime": null
}, - "maxPrefixLimit": 100
}, - "destination": {
- "publicServiceKey": "YourSellerServiceKey",
- "publicServiceId": "X000000000001",
- "publicServiceName": "YourSellerServiceName",
- "primary": {
- "tenantId": "aaaaae40743f460685040c46167cf19e",
- "portId": "F910123456789",
- "portName": "PortName",
- "vlan": 113,
- "ipAddress": "10.0.0.2/30",
- "asn": "65000"
}, - "secondary": {
- "tenantId": "aaaaae40743f460685040c46167cf19e",
- "portId": "F919876543210",
- "portName": "PortName",
- "vlan": 114,
- "ipAddress": "10.0.1.2/30",
- "asn": "65000"
}
}, - "interTenant": true,
- "toPublicService": true,
- "resourceGroup": {
- "source": "PUR01-jpeast02",
- "destination": null
}
}
]
}Create Premium Router to Virtual Port(XaaS)【Pattern X】Premium Connection
※このAPIは承認の申請をする際にApproval-RequestのAPIでbody{}の中に記述いただくAPIであり、
直接お客様がお使いになられるAPIではございません。
サービス概要や、注意事項等の詳細情報に関しましてはこちらをご参照下さい。
画面での操作に関しましてはこちらをご参照下さい。
・Premium Router to Virtual Port(XaaS)【Pattern X】 Premium コネクションを購入するに当たって、接続元となるFIC-Routerが必要となります。
<接続までの大まかな流れは以下のとおりです。>
STEP1 作成承認申請
Approval-Request のAPIに必須となる項目を入力して、接続承認を申請する。
STEP2 承認/否認
接続先XaaS事業者にて承認行為は実施される。
STEP3 作成
承認された時に返ってくるapprovalRequestIdを、Approval-Request のAPIのExecuteのパス(/v1/approval-requests/{request_id}/execute)に入力し、実行する。
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
Accepted 要求は受け付けられました
Bad Request リクエストが不正
Unauthorized 認証エラー
Conflict 競合エラー
Request samples
- Payload
{- "connection": {
- "name": "YourConnectionName",
- "bandwidth": "100M",
- "routeFilter": {
- "routerId": "F020123456789",
- "groupName": "group_1",
- "in": "fullRoute",
- "prefixInType": "permit",
- "maxBgpPrefixListIn": 10,
- "customRoutePrefixIn": [
- {
- "address": "100.250.140.0/24",
- "filterType": "exact"
}, - {
- "address": "35.180.0.0/16",
- "filterType": "orlonger"
}
], - "out": "fullRouteWithDefaultRoute",
- "prefixOutType": "permit",
- "maxBgpPrefixListOut": 10,
- "customRoutePrefixOut": [
- {
- "address": "100.250.140.0/24",
- "filterType": "exact"
}, - {
- "address": "35.180.0.0/16",
- "filterType": "orlonger"
}
], - "primary": {
- "ipAddress": "10.0.0.1/30",
- "asPathPrepend": {
- "out": null
}, - "med": {
- "out": 10
}
}, - "secondary": {
- "ipAddress": "10.0.1.1/30",
- "asPathPrepend": {
- "out": 1
}, - "med": {
- "out": 20
}
}, - "maxPrefixLimit": 100
}, - "destination": {
- "publicServiceKey": null,
- "primary": {
- "portId": "F910123456789",
- "ipAddress": "10.0.0.2/30"
}, - "secondary": {
- "portId": "F919876543210",
- "ipAddress": "10.0.1.2/30"
}
}, - "approvalRequestId": "req0000000001"
}
}Response samples
- 202
{- "connection": {
- "id": "F930123456789",
- "name": "YourConnectionName",
- "redundant": true,
- "tenantId": "db8b0e40743f460685040c46167cf19e",
- "area": "JPEAST",
- "operationStatus": "Completed",
- "bandwidth": "100M",
- "source": {
- "tenantId": "db8b0e40743f460685040c46167cf19e",
- "routerId": "F920123456789",
- "groupName": "group_1",
- "routeFilter": {
- "in": "fullRoute",
- "prefixInType": "permit",
- "maxBgpPrefixListIn": 10,
- "customRoutePrefixIn": [
- {
- "address": "100.250.140.0/24",
- "filterType": "exact"
}, - {
- "address": "35.180.0.0/16",
- "filterType": "orlonger"
}
], - "out": "fullRouteWithDefaultRoute",
- "prefixOutType": "permit",
- "maxBgpPrefixListOut": 10,
- "customRoutePrefixOut": [
- {
- "address": "100.250.140.0/24",
- "filterType": "exact"
}, - {
- "address": "35.180.0.0/16",
- "filterType": "orlonger"
}
]
}, - "primary": {
- "ipAddress": "10.0.0.1/30",
- "asPathPrepend": {
- "out": null
}, - "med": {
- "out": 10
}
}, - "secondary": {
- "ipAddress": "10.0.1.1/30",
- "asPathPrepend": {
- "out": 1
}, - "med": {
- "out": 20
}
}, - "priority": {
- "active": "primary",
- "startTime": null
}, - "maxPrefixLimit": 100
}, - "destination": {
- "publicServiceKey": null,
- "publicServiceId": null,
- "publicServiceName": null,
- "primary": {
- "tenantId": "aaaaae40743f460685040c46167cf19e",
- "portId": "F910123456789",
- "portName": "PortName",
- "vlan": 113,
- "ipAddress": "10.0.0.2/30",
- "asn": "65000"
}, - "secondary": {
- "tenantId": "aaaaae40743f460685040c46167cf19e",
- "portId": "F919876543210",
- "portName": "PortName",
- "vlan": 114,
- "ipAddress": "10.0.1.2/30",
- "asn": "65000"
}
}, - "interTenant": true,
- "toPublicService": true,
- "resourceGroup": {
- "source": "PUR01-jpeast02",
- "destination": null
}
}, - "operationId": "2fb5baa5a5834e0b952d3f0d93c3e64a"
}Show Premium Router to Virtual Port(XaaS)【Pattern X】Premium Connection
指定したPremium Router to Virtual Port(XaaS)【Pattern X】 Premium コネクションの詳細情報を取得します。
path Parameters
| id required | string ^F[0-9]{12}$ Example: F930123456789 対象コネクションID |
header Parameters
| Content-Type required | string Value: "application/json" |
| X-Auth-Token required | string ^[0-9a-f]{32}$ Example: dc03494823a841338430052e9ee95e07 クライアントが Keystone を利用して取得した認証 Token |
Responses
OK 成功しました
Bad Request リクエストが不正
Unauthorized 認証エラー
Not Found 未検出エラー
Conflict 競合エラー
Response samples
- 200
{- "connection": {
- "id": "F930123456789",
- "name": "YourConnectionName",
- "redundant": true,
- "tenantId": "db8b0e40743f460685040c46167cf19e",
- "area": "JPEAST",
- "operationStatus": "Completed",
- "bandwidth": "100M",
- "source": {
- "tenantId": "db8b0e40743f460685040c46167cf19e",
- "routerId": "F920123456789",
- "groupName": "group_1",
- "routeFilter": {
- "in": "fullRoute",
- "prefixInType": "permit",
- "maxBgpPrefixListIn": 10,
- "customRoutePrefixIn": [
- {
- "address": "100.250.140.0/24",
- "filterType": "exact"
}, - {
- "address": "35.180.0.0/16",
- "filterType": "orlonger"
}
], - "out": "fullRouteWithDefaultRoute",
- "prefixOutType": "permit",
- "maxBgpPrefixListOut": 10,
- "customRoutePrefixOut": [
- {
- "address": "100.250.140.0/24",
- "filterType": "exact"
}, - {
- "address": "35.180.0.0/16",
- "filterType": "orlonger"
}
]
}, - "primary": {
- "ipAddress": "10.0.0.1/30",
- "asPathPrepend": {
- "out": null
}, - "med": {
- "out": 10
}
}, - "secondary": {
- "ipAddress": "10.0.1.1/30",
- "asPathPrepend": {
- "out": 1
}, - "med": {
- "out": 20
}
}, - "priority": {
- "active": "primary",
- "startTime": null
}, - "maxPrefixLimit": 100
}, - "destination": {
- "publicServiceKey": "YourSellerServiceKey",
- "publicServiceId": "X000000000001",
- "publicServiceName": "YourSellerServiceName",
- "primary": {
- "tenantId": "aaaaae40743f460685040c46167cf19e",
- "portId": "F910123456789",
- "portName": "PortName",
- "vlan": 113,
- "ipAddress": "10.0.0.2/30",
- "asn": "65000"
}, - "secondary": {
- "tenantId": "aaaaae40743f460685040c46167cf19e",
- "portId": "F919876543210",
- "portName": "PortName",
- "vlan": 114,
- "ipAddress": "10.0.1.2/30",
- "asn": "65000"
}
}, - "interTenant": true,
- "toPublicService": true,
- "resourceGroup": {
- "source": "PUR01-jpeast02",
- "destination": null
}
}
}Update Premium Router to Virtual Port(XaaS)【Pattern X】Premium Connection
指定したPremium Router to Virtual Port(XaaS)【Pattern X】 Premium コネクションを変更します。
XaaS接続の場合、帯域変更と経路変更の同時実行は不可。(帯域変更とリソース名変更は同時実行可能。)
path Parameters
| id required | string ^F[0-9]{12}$ Example: F930123456789 対象コネクション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
※このAPIは承認の申請をする際にApproval-Request のAPIでbody{}の中に記述いただくAPIであり、直接お客様がお使いになられるAPIではございません。
・Premium Router to Virtual Port(XaaS)【Pattern X】 Premium コネクションを変更するに当たって、接続元となるFIC-Routerが必要となります。
<接続までの大まかな流れは以下のとおりです。>
STEP1 作成承認申請
Approval-Request のAPIに必須となる項目を入力して、接続承認を申請する。
STEP2 承認/否認
接続先XaaS事業者にて承認行為は実施される。
STEP3 作成
承認された時に返ってくるapprovalRequestIdを、Approval-RequestのAPIのExecuteのパス(/v1/approval-requests/{request_id}/execute)に入力し、実行する。
| connection required | object |
Responses
Accepted 要求は受け付けられました
Bad Request リクエストが不正
Unauthorized 認証エラー
Not Found 未検出エラー
Conflict 競合エラー
Request samples
- Payload
{- "connection": {
- "name": "YourConnectionNameUpdate"
}
}Response samples
- 202
{- "connection": {
- "id": "F930123456789",
- "name": "YourConnectionName",
- "redundant": true,
- "tenantId": "db8b0e40743f460685040c46167cf19e",
- "area": "JPEAST",
- "operationStatus": "Completed",
- "bandwidth": "100M",
- "source": {
- "tenantId": "db8b0e40743f460685040c46167cf19e",
- "routerId": "F920123456789",
- "groupName": "group_1",
- "routeFilter": {
- "in": "fullRoute",
- "prefixInType": "permit",
- "maxBgpPrefixListIn": 10,
- "customRoutePrefixIn": [
- {
- "address": "100.250.140.0/24",
- "filterType": "exact"
}, - {
- "address": "35.180.0.0/16",
- "filterType": "orlonger"
}
], - "out": "fullRouteWithDefaultRoute",
- "prefixOutType": "permit",
- "maxBgpPrefixListOut": 10,
- "customRoutePrefixOut": [
- {
- "address": "100.250.140.0/24",
- "filterType": "exact"
}, - {
- "address": "35.180.0.0/16",
- "filterType": "orlonger"
}
]
}, - "primary": {
- "ipAddress": "10.0.0.1/30",
- "asPathPrepend": {
- "out": null
}, - "med": {
- "out": 10
}
}, - "secondary": {
- "ipAddress": "10.0.1.1/30",
- "asPathPrepend": {
- "out": 1
}, - "med": {
- "out": 20
}
}, - "priority": {
- "active": "primary",
- "startTime": null
}, - "maxPrefixLimit": 100
}, - "destination": {
- "publicServiceKey": "YourSellerServiceKey",
- "publicServiceId": "X000000000001",
- "publicServiceName": "YourSellerServiceName",
- "primary": {
- "tenantId": "aaaaae40743f460685040c46167cf19e",
- "portId": "F910123456789",
- "portName": "PortName",
- "vlan": 113,
- "ipAddress": "10.0.0.2/30",
- "asn": "65000"
}, - "secondary": {
- "tenantId": "aaaaae40743f460685040c46167cf19e",
- "portId": "F919876543210",
- "portName": "PortName",
- "vlan": 114,
- "ipAddress": "10.0.1.2/30",
- "asn": "65000"
}
}, - "interTenant": true,
- "toPublicService": true,
- "resourceGroup": {
- "source": "PUR01-jpeast02",
- "destination": null
}, - "operationId": "2fb5baa5a5834e0b952d3f0d93c3e64a"
}
}Delete Premium Router to Virtual Port(XaaS)【Pattern X】Premium Connection
指定したPremium Router to Virtual Port(XaaS)【Pattern X】 Premium コネクションを廃止します。
path Parameters
| id required | string ^F[0-9]{12}$ Example: F930123456789 対象コネクションID |
header Parameters
| Content-Type required | string Value: "application/json" |
| X-Auth-Token required | string ^[0-9a-f]{32}$ Example: dc03494823a841338430052e9ee95e07 クライアントが Keystone を利用して取得した認証 Token |
Responses
Accepted 要求は受け付けられました
Bad Request リクエストが不正
Unauthorized 認証エラー
Not Found 未検出エラー
Conflict 競合エラー
Response samples
- 202
{- "connection": {
- "id": "F930123456789",
- "name": "YourConnectionName",
- "redundant": true,
- "tenantId": "db8b0e40743f460685040c46167cf19e",
- "area": "JPEAST",
- "operationStatus": "Completed",
- "bandwidth": "100M",
- "source": {
- "tenantId": "db8b0e40743f460685040c46167cf19e",
- "routerId": "F920123456789",
- "groupName": "group_1",
- "routeFilter": {
- "in": "fullRoute",
- "prefixInType": "permit",
- "maxBgpPrefixListIn": 10,
- "customRoutePrefixIn": [
- {
- "address": "100.250.140.0/24",
- "filterType": "exact"
}, - {
- "address": "35.180.0.0/16",
- "filterType": "orlonger"
}
], - "out": "fullRouteWithDefaultRoute",
- "prefixOutType": "permit",
- "maxBgpPrefixListOut": 10,
- "customRoutePrefixOut": [
- {
- "address": "100.250.140.0/24",
- "filterType": "exact"
}, - {
- "address": "35.180.0.0/16",
- "filterType": "orlonger"
}
]
}, - "primary": {
- "ipAddress": "10.0.0.1/30",
- "asPathPrepend": {
- "out": null
}, - "med": {
- "out": 10
}
}, - "secondary": {
- "ipAddress": "10.0.1.1/30",
- "asPathPrepend": {
- "out": 1
}, - "med": {
- "out": 20
}
}, - "priority": {
- "active": "primary",
- "startTime": null
}, - "maxPrefixLimit": 100
}, - "destination": {
- "publicServiceKey": "YourSellerServiceKey",
- "publicServiceId": "X000000000001",
- "publicServiceName": "YourSellerServiceName",
- "primary": {
- "tenantId": "aaaaae40743f460685040c46167cf19e",
- "portId": "F910123456789",
- "portName": "PortName",
- "vlan": 113,
- "ipAddress": "10.0.0.2/30",
- "asn": "65000"
}, - "secondary": {
- "tenantId": "aaaaae40743f460685040c46167cf19e",
- "portId": "F919876543210",
- "portName": "PortName",
- "vlan": 114,
- "ipAddress": "10.0.1.2/30",
- "asn": "65000"
}
}, - "interTenant": true,
- "toPublicService": true,
- "resourceGroup": {
- "source": "PUR01-jpeast02",
- "destination": null
}, - "operationId": "2fb5baa5a5834e0b952d3f0d93c3e64a"
}
}Update Premium Router to Virtual Port(XaaS)【Pattern X】Premium Connection Priority
指定したPremium Router to Virtual Port(XaaS)【Pattern X】 Premium コネクションのPriortyを変更します。
path Parameters
| id required | string ^F[0-9]{12}$ Example: F930123456789 対象コネクション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
Accepted 要求は受け付けられました
Bad Request リクエストが不正
Unauthorized 認証エラー
Not Found 未検出エラー
Conflict 競合エラー
Request samples
- Payload
{- "connection": {
- "source": {
- "priority": {
- "active": "secondary"
}
}
}
}Response samples
- 202
{- "connection": {
- "id": "F930123456789",
- "name": "YourConnectionName",
- "redundant": true,
- "tenantId": "db8b0e40743f460685040c46167cf19e",
- "area": "JPEAST",
- "operationStatus": "Completed",
- "bandwidth": "100M",
- "source": {
- "tenantId": "db8b0e40743f460685040c46167cf19e",
- "routerId": "F920123456789",
- "groupName": "group_1",
- "routeFilter": {
- "in": "fullRoute",
- "prefixInType": "permit",
- "maxBgpPrefixListIn": 10,
- "customRoutePrefixIn": [
- {
- "address": "100.250.140.0/24",
- "filterType": "exact"
}, - {
- "address": "35.180.0.0/16",
- "filterType": "orlonger"
}
], - "out": "fullRouteWithDefaultRoute",
- "prefixOutType": "permit",
- "maxBgpPrefixListOut": 10,
- "customRoutePrefixOut": [
- {
- "address": "100.250.140.0/24",
- "filterType": "exact"
}, - {
- "address": "35.180.0.0/16",
- "filterType": "orlonger"
}
]
}, - "primary": {
- "ipAddress": "10.0.0.1/30",
- "asPathPrepend": {
- "out": null
}, - "med": {
- "out": 10
}
}, - "secondary": {
- "ipAddress": "10.0.1.1/30",
- "asPathPrepend": {
- "out": 1
}, - "med": {
- "out": 20
}
}, - "priority": {
- "active": "secondary",
- "startTime": "2026-03-01T06:48:00Z"
}, - "maxPrefixLimit": 100
}, - "destination": {
- "publicServiceKey": "YourSellerServiceKey",
- "publicServiceId": "X000000000001",
- "publicServiceName": "YourSellerServiceName",
- "primary": {
- "tenantId": "aaaaae40743f460685040c46167cf19e",
- "portId": "F910123456789",
- "portName": "PortName",
- "vlan": 113,
- "ipAddress": "10.0.0.2/30",
- "asn": "65000"
}, - "secondary": {
- "tenantId": "aaaaae40743f460685040c46167cf19e",
- "portId": "F919876543210",
- "portName": "PortName",
- "vlan": 114,
- "ipAddress": "10.0.1.2/30",
- "asn": "65000"
}
}, - "interTenant": true,
- "toPublicService": true,
- "resourceGroup": {
- "source": "PUR01-jpeast02",
- "destination": null
}, - "operationId": "2fb5baa5a5834e0b952d3f0d93c3e64a"
}
}List Port Premium Virtual Port(XaaS)【Pattern X】
指定したFIC-Port(XaaS)に紐づくPremium Virtual Port(XaaS)【Pattern X】の一覧を取得します。
path Parameters
| id required | string ^F[0-9]{12}$ Example: F010123456789 対象ポートID |
query Parameters
| tenantId | string ^[0-9a-f]{32}$ Example: tenantId=db8b0e40743f460685040c46167cf19e テナントID 半角英数32文字 |
header Parameters
| Content-Type required | string Value: "application/json" |
| X-Auth-Token required | string ^[0-9a-f]{32}$ Example: dc03494823a841338430052e9ee95e07 クライアントが Keystone を利用して取得した認証 Token |
Responses
OK 成功しました
Bad Request リクエストが不正
Unauthorized 認証エラー
Conflict 競合エラー
Response samples
- 200
{- "premiumVirtualPortsPatternX": [
- {
- "id": "F930123456789",
- "name": "YourPortName",
- "tenantId": "db8b0e40743f460685040c46167cf19e",
- "area": "JPEAST",
- "operationStatus": "Completed",
- "role": "primary",
- "isPublicServiceEndpoint": true,
- "vlanRanges": [
- "113-128"
], - "location": "TK7-PATCH-PANEL",
- "numOfVlans": 16,
- "vlans": [
- {
- "vid": 113,
- "status": "unused"
}, - {
- "vid": 114,
- "status": "unused"
}
], - "ownerPortId": "F010123456789",
- "ownerTenantId": "aaaaae40743f460685040c46167cf19e",
- "maxBandwidth": "1000M"
}
], - "allocatedBandwidth": "20G"
}