FIC-Connection Port (同一テナント内接続/テナント間接続) - Flexible InterConnect API リファレンス (2.0.0)
Download OpenAPI specification:Download
本APIでは、Flexible InterConnectが提供するリソースの参照・操作が可能です。
Port to Portコネクションの購入・参照・変更・廃止等の操作に関するAPIドキュメントです。
List Port to Port Connections(同一テナント内接続/テナント間接続)
Port to Portコネクション情報の一覧を取得します。
query Parameters
id | string <uuid> ^F[0-9]{12}$ Example: id=F031900000001 コネクションID |
name | string [ 1 .. 64 ] characters Example: name=YourConnectionName コネクション名 半角英数及び一部記号&()-_ 64文字 |
tenantId | string ^[0-9a-f]{32}$ Example: tenantId=db8b0e40743f460685040c46167cf19e テナントID |
area | string Enum: "JPEAST" "JPWEST" Example: area=JPEAST エリア名 ‘JPEAST’または’JPWEST’ |
interTenant | boolean Example: interTenant=true テナント間接続フラグ ’true’(テナント間接続)または‘false’(同一テナント内接続) |
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": "F031900000001",
- "name": "YourConnectionName",
- "redundant": true,
- "tenantId": "db8b0e40743f460685040c46167cf19e",
- "area": "JPEAST",
- "operationStatus": "Completed",
- "source": {
- "primary": {
- "tenantId": "db8b0e40743f460685040c46167cf19e",
- "portId": "F011900000001",
- "vlan": 113
}, - "secondary": {
- "tenantId": "db8b0e40743f460685040c46167cf19e",
- "portId": "F011900000002",
- "vlan": 213
}
}, - "destination": {
- "publicServiceKey": null,
- "publicServiceId": null,
- "publicServiceName": null,
- "primary": {
- "tenantId": "aaaaae40743f460685040c46167cf19e",
- "portId": "F011900000003",
- "vlan": 114
}, - "secondary": {
- "tenantId": "aaaaae40743f460685040c46167cf19e",
- "portId": "F011900000004",
- "vlan": 214
}
}, - "bandwidth": "100M",
- "toPublicService": false,
- "interTenant": false
}
]
}
Create Port to Port 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",
- "source": {
- "primary": {
- "portId": "F011900000001",
- "vlan": 113
}, - "secondary": {
- "portId": "F011900000002",
- "vlan": 213
}
}, - "destination": {
- "publicServiceKey": null,
- "primary": {
- "portId": "F011900000003",
- "vlan": 114
}, - "secondary": {
- "portId": "F011900000004",
- "vlan": 214
}
}, - "bandwidth": "100M"
}
}
Response samples
- 202
{- "connection": {
- "id": "F031900000001",
- "name": "YourConnectionName",
- "redundant": true,
- "tenantId": "db8b0e40743f460685040c46167cf19e",
- "area": "JPEAST",
- "operationStatus": "Processing",
- "source": {
- "primary": {
- "tenantId": "db8b0e40743f460685040c46167cf19e",
- "portId": "F011900000001",
- "vlan": 113
}, - "secondary": {
- "tenantId": "db8b0e40743f460685040c46167cf19e",
- "portId": "F011900000002",
- "vlan": 213
}
}, - "destination": {
- "publicServiceKey": null,
- "primary": {
- "tenantId": "aaaaae40743f460685040c46167cf19e",
- "portId": "F011900000003",
- "vlan": 114
}, - "secondary": {
- "tenantId": "aaaaae40743f460685040c46167cf19e",
- "portId": "F011900000004",
- "vlan": 214
}
}, - "bandwidth": "100M",
- "toPublicService": false,
- "interTenant": false,
- "operationId": "389aa5c9bc324460a62405f6e0d5c243"
}
}
Show Port to Port Connection(同一テナント内接続/テナント間接続)
指定したPort to Portコネクションの詳細情報を取得します。
path Parameters
id 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
OK 成功しました
Bad Request リクエストが不正
Unauthorized 認証エラー
Forbidden 未検出エラー
Not Found 競合エラー
Response samples
- 200
{- "connection": {
- "id": "F031900000001",
- "name": "YourConnectionName",
- "redundant": true,
- "tenantId": "db8b0e40743f460685040c46167cf19e",
- "area": "JPEAST",
- "operationStatus": "Processing",
- "source": {
- "primary": {
- "tenantId": "db8b0e40743f460685040c46167cf19e",
- "portId": "F011900000001",
- "vlan": 113
}, - "secondary": {
- "tenantId": "db8b0e40743f460685040c46167cf19e",
- "portId": "F011900000002",
- "vlan": 213
}
}, - "destination": {
- "publicServiceKey": null,
- "publicServiceId": null,
- "publicServiceName": null,
- "primary": {
- "tenantId": "aaaaae40743f460685040c46167cf19e",
- "portId": "F011900000003",
- "vlan": 114
}, - "secondary": {
- "tenantId": "aaaaae40743f460685040c46167cf19e",
- "portId": "F011900000004",
- "vlan": 214
}
}, - "bandwidth": "100M",
- "toPublicService": false,
- "interTenant": false
}
}
Update Port to Port Connection(同一テナント内接続/テナント間接続)
指定したPort to Portコネクションを変更します。各種変更操作は同時実行できます。
path Parameters
id 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
Accepted 要求は受け付けられました
Bad Request リクエストが不正
Unauthorized 認証エラー
Not Found 未検出エラー
Conflict 競合エラー
Request samples
- Payload
{- "connection": {
- "name": "YourConnectionNameUpdate"
}
}
Response samples
- 202
{- "connection": {
- "id": "F031900000001",
- "name": "YourConnectionNameUpdate",
- "redundant": true,
- "tenantId": "db8b0e40743f460685040c46167cf19e",
- "area": "JPEAST",
- "operationStatus": "Processing",
- "source": {
- "primary": {
- "tenantId": "db8b0e40743f460685040c46167cf19e",
- "portId": "F011900000001",
- "vlan": 113
}, - "secondary": {
- "tenantId": "db8b0e40743f460685040c46167cf19e",
- "portId": "F011900000002",
- "vlan": 213
}
}, - "destination": {
- "publicServiceKey": null,
- "primary": {
- "tenantId": "aaaaae40743f460685040c46167cf19e",
- "portId": "F011900000003",
- "vlan": 114
}, - "secondary": {
- "tenantId": "aaaaae40743f460685040c46167cf19e",
- "portId": "F011900000004",
- "vlan": 214
}
}, - "bandwidth": "100M",
- "toPublicService": false,
- "interTenant": false,
- "operationId": "389aa5c9bc324460a62405f6e0d5c243"
}
}
Delete Port to Port Connection(同一テナント内接続/テナント間接続)
指定したPort to Portコネクションを廃止します。
path Parameters
id 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
Accepted 要求は受け付けられました
Bad Request リクエストが不正
Unauthorized 認証エラー
Not Found 未検出エラー
Conflict 競合エラー
Response samples
- 202
{- "connection": {
- "id": "F031900000001",
- "name": "YourConnectionName",
- "redundant": true,
- "tenantId": "db8b0e40743f460685040c46167cf19e",
- "area": "JPEAST",
- "operationStatus": "Processing",
- "source": {
- "primary": {
- "tenantId": "db8b0e40743f460685040c46167cf19e",
- "portId": "F011900000001",
- "vlan": 113
}, - "secondary": {
- "tenantId": "db8b0e40743f460685040c46167cf19e",
- "portId": "F011900000002",
- "vlan": 213
}
}, - "destination": {
- "publicServiceKey": null,
- "primary": {
- "tenantId": "aaaaae40743f460685040c46167cf19e",
- "portId": "F011900000003",
- "vlan": 114
}, - "secondary": {
- "tenantId": "aaaaae40743f460685040c46167cf19e",
- "portId": "F011900000004",
- "vlan": 214
}
}, - "bandwidth": "100M",
- "toPublicService": false,
- "interTenant": false,
- "operationId": "389aa5c9bc324460a62405f6e0d5c243"
}
}
List Router to Port Connections(同一テナント内接続/テナント間接続)
Router to Portコネクション情報の一覧を取得します。
query Parameters
id | string <uuid> ^F[0-9]{12}$ Example: id=F031900000001 コネクションID |
name | string [ 1 .. 64 ] characters Example: name=YourConnectionName コネクション名 半角英数及び一部記号&()-_ 64文字 |
tenantId | string ^[0-9a-f]{32}$ Example: tenantId=db8b0e40743f460685040c46167cf19e テナントID |
area | string Enum: "JPEAST" "JPWEST" Example: area=JPEAST エリア名 ‘JPEAST’または’JPWEST’ |
interTenant | boolean Example: interTenant=true テナント間接続フラグ ’true’(テナント間接続)または‘false’(同一テナント内接続) |
resourceGroup | string Example: r |