FIC-Premium Connection Google Cloud - Flexible InterConnect API リファレンス (20.0)
Download OpenAPI specification:Download
本APIでは、Flexible InterConnectが提供するリソースの参照・操作が可能です。
Premium Router to Google Cloud Premium コネクションの購入・参照・変更・廃止等の操作に関するAPIドキュメントです。
List Premium Router to Google Cloud Premium Connections
Premium Router to Google Cloud 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": "fullRoute",
- "out": "noRoute"
}, - "primary": {
- "med": {
- "out": 10
}
}, - "secondary": {
- "med": {
- "out": 20
}
}, - "prioryty": {
- "active": "primary",
- "startTime": null
}, - "maxPrefixLimit": 100
}, - "destination": {
- "primary": {
- "interconnect": "GCP-TYO-1",
- "pairingKey": "d27476e6-e8a8-4214-a88f-9d3131db465d/asia-northeast1/1",
- "mtu": 1440
}, - "secondary": {
- "interconnect": "GCP-TYO-2",
- "pairingKey": "17c64c4e-f845-4450-82e9-843095e18526/asia-northeast1/2",
- "mtu": 1440
}, - "qosType": "guarantee"
}, - "primaryConnectedNwAddress": "10.0.0.0/30",
- "secondaryConnectedNwAddress": "10.0.1.0/30",
- "resourceGroup": {
- "source": "PCR01-jpeast02",
- "destination": null
}
}
}Create Premium Router to Google Cloud 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": "fullRoute",
- "out": "noRoute"
}, - "primary": {
- "med": {
- "out": 10
}
}, - "secondary": {
- "med": {
- "out": 20
}
}, - "maxPrefixLimit": 100
}, - "destination": {
- "primary": {
- "interconnect": "GCP-TYO-1",
- "pairingKey": "d27476e6-e8a8-4214-a88f-9d3131db465d/asia-northeast1/1"
}, - "secondary": {
- "interconnect": "GCP-TYO-2",
- "pairingKey": "17c64c4e-f845-4450-82e9-843095e18526/asia-northeast1/2"
}, - "qosType": "guarantee"
}
}
}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",
- "out": "noRoute"
}, - "primary": {
- "med": {
- "out": 10
}
}, - "secondary": {
- "med": {
- "out": 20
}
}, - "prioryty": {
- "active": "primary",
- "startTime": null
}, - "maxPrefixLimit": 100
}, - "destination": {
- "primary": {
- "interconnect": "GCP-TYO-1",
- "pairingKey": "d27476e6-e8a8-4214-a88f-9d3131db465d/asia-northeast1/1",
- "mtu": 1440
}, - "secondary": {
- "interconnect": "GCP-TYO-2",
- "pairingKey": "17c64c4e-f845-4450-82e9-843095e18526/asia-northeast1/2",
- "mtu": 1440
}, - "qosType": "guarantee"
}, - "primaryConnectedNwAddress": "10.0.0.0/30",
- "secondaryConnectedNwAddress": "10.0.1.0/30",
- "resourceGroup": {
- "source": null,
- "destination": null
}, - "operationId": "2fb5baa5a5834e0b952d3f0d93c3e64a"
}
}Show Premium Router to Google Cloud Premium Connection
指定したPremium Router to Google Cloud 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
{- "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",
- "out": "noRoute"
}, - "primary": {
- "med": {
- "out": 10
}
}, - "secondary": {
- "med": {
- "out": 20
}
}, - "prioryty": {
- "active": "primary",
- "startTime": null
}, - "maxPrefixLimit": 100
}, - "destination": {
- "primary": {
- "interconnect": "GCP-TYO-1",
- "pairingKey": "d27476e6-e8a8-4214-a88f-9d3131db465d/asia-northeast1/1",
- "mtu": 1440
}, - "secondary": {
- "interconnect": "GCP-TYO-2",
- "pairingKey": "17c64c4e-f845-4450-82e9-843095e18526/asia-northeast1/2",
- "mtu": 1440
}, - "qosType": "guarantee"
}, - "primaryConnectedNwAddress": "10.0.0.0/30",
- "secondaryConnectedNwAddress": "10.0.1.0/30",
- "resourceGroup": {
- "source": "PCR01-jpeast02",
- "destination": null
}
}
}Update Premium Router to Google Cloud Premium Connection
指定したPremium Router to Google Cloud 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": {
- "name": "YourConnectionNameUpdate"
}
}Response samples
- 202
{- "connections": {
- "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",
- "out": "privateRoute"
}, - "primary": {
- "med": {
- "out": 10
}
}, - "secondary": {
- "med": {
- "out": 20
}
}, - "prioryty": {
- "active": "primary",
- "startTime": null
}, - "maxPrefixLimit": 100
}, - "destination": {
- "primary": {
- "interconnect": "GCP-TYO-1",
- "pairingKey": "d27476e6-e8a8-4214-a88f-9d3131db465d/asia-northeast1/1",
- "mtu": 1440
}, - "secondary": {
- "interconnect": "GCP-TYO-2",
- "pairingKey": "17c64c4e-f845-4450-82e9-843095e18526/asia-northeast1/2",
- "mtu": 1440
}, - "qosType": "guarantee"
}, - "primaryConnectedNwAddress": "10.0.0.0/30",
- "secondaryConnectedNwAddress": "10.0.1.0/30",
- "resourceGroup": {
- "source": "PCR01-jpeast02",
- "destination": null
}, - "operationId": "2fb5baa5a5834e0b952d3f0d93c3e64a"
}
}Delete Premium Router to Google Cloud Premium Connection
指定したPremium Router to Google Cloud 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": "fullRoute",
- "out": "noRoute"
}, - "primary": {
- "med": {
- "out": 10
}
}, - "secondary": {
- "med": {
- "out": 20
}
}, - "prioryty": {
- "active": "primary",
- "startTime": null
}, - "maxPrefixLimit": 100
}, - "destination": {
- "primary": {
- "interconnect": "GCP-TYO-1",
- "pairingKey": "d27476e6-e8a8-4214-a88f-9d3131db465d/asia-northeast1/1",
- "mtu": 1440
}, - "secondary": {
- "interconnect": "GCP-TYO-2",
- "pairingKey": "17c64c4e-f845-4450-82e9-843095e18526/asia-northeast1/2",
- "mtu": 1440
}, - "qosType": "guarantee"
}, - "primaryConnectedNwAddress": "10.0.0.0/30",
- "secondaryConnectedNwAddress": "10.0.1.0/30",
- "resourceGroup": {
- "source": null,
- "destination": null
}, - "operationId": "2fb5baa5a5834e0b952d3f0d93c3e64a"
}
}Update Premium Router to Google Cloud Premium Connection Priority
指定したPremium Router to Google Cloud 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
{- "connections": {
- "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",
- "out": "noRoute"
}, - "primary": {
- "med": {
- "out": 10
}
}, - "secondary": {
- "med": {
- "out": 20
}
}, - "prioryty": {
- "active": "secondary",
- "startTime": "2026-03-01T06:48:00Z"
}, - "maxPrefixLimit": 100
}, - "destination": {
- "primary": {
- "interconnect": "GCP-TYO-1",
- "pairingKey": "d27476e6-e8a8-4214-a88f-9d3131db465d/asia-northeast1/1",
- "mtu": 1440
}, - "secondary": {
- "interconnect": "GCP-TYO-2",
- "pairingKey": "17c64c4e-f845-4450-82e9-843095e18526/asia-northeast1/2",
- "mtu": 1440
}, - "qosType": "guarantee"
}, - "primaryConnectedNwAddress": "10.0.0.0/30",
- "secondaryConnectedNwAddress": "10.0.1.0/30",
- "resourceGroup": {
- "source": "PCR01-jpeast02",
- "destination": null
}, - "operationId": "2fb5baa5a5834e0b952d3f0d93c3e64a"
}
}