FIC-Port/FIC-Port(XaaS)/FIC-Virtual Port (XaaS) - Flexible InterConnect API リファレンス (2.0.0)
Download OpenAPI specification:Download
本APIでは、Flexible InterConnectが提供するリソースの参照・操作が可能です。
FIC-Port/FIC-Port(XaaS)/FIC-Virtual Port (XaaS)の購入・参照・変更・廃止等の操作に関するAPIドキュメントです。
List FIC-Port/FIC-Port(XaaS)
ポート情報の一覧を取得します。
query Parameters
id | string ^F[0-9]{12}$ Example: id=F010123456789 ポートID |
name | string Example: name=YourPortName ポート名 半角英数及び一部記号&()-_ 64文字 |
tenantId | string <uuid> ^[0-9a-f]{32}$ Example: tenantId=0dc3a0ff7cbc4f49b7ec70ac6af57104 テナントID |
switchName | string Example: switchName=SwitchName スイッチのエイリアス名 |
isPublicServiceEndpoint | boolean Example: isPublicServiceEndpoint=true XaaS事業者対応フラグ ‘false’(対応なし)または’true’(対応あり) |
location | string Example: location=NTTComTokyo(NW1) データセンター名 |
area | string Enum: "JPEAST" "JPWEST" Example: area=JPEAST エリア名 ‘JPEAST’または’JPWEST’ |
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
{- "ports": [
- {
- "id": "F010123456789",
- "name": "YourPortName",
- "operationStatus": "Completed",
- "isActivated": true,
- "isPublicServiceEndpoint": true,
- "numOfVlans": 16,
- "vlanRanges": [
- "113-128"
], - "tenantId": "0dc3a0ff7cbc4f49b7ec70ac6af57104",
- "switchName": "SwitchName",
- "portType": "1G",
- "location": "NTTComTokyo(NW1)",
- "area": "JPEAST",
- "vlans": [
- {
- "vid": 113,
- "status": "unused"
}, - {
- "vid": 114,
- "status": "unused"
}
], - "vlanRangeDetails": [
- {
- "sourceVlanRange": "113-128",
- "purpose": "PublicServiceEndpoint"
}
], - "publicServiceId": "X002300000001",
- "publicServiceName": "PublicServiceName"
}
]
}
Create FIC-Port/FIC-Port(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
port required | object |
Responses
Accepted 要求は受け付けられました
Bad Request リクエストが不正
Unauthorized 認証エラー
Conflict 競合エラー
Request samples
- Payload
{- "port": {
- "name": "YourPortName",
- "isPublicServiceEndpoint": true,
- "numOfVlans": 32,
- "vlanRanges": [
- "113-128",
- "129-144"
], - "switchName": "SwitchName",
- "portType": "1G"
}
}
Response samples
- 202
{- "port": {
- "id": "F010123456789",
- "name": "YourPortName",
- "operationStatus": "Processing",
- "isActivated": false,
- "isPublicServiceEndpoint": true,
- "numOfVlans": 16,
- "vlanRanges": [
- "113-128"
], - "tenantId": "0dc3a0ff7cbc4f49b7ec70ac6af57104",
- "switchName": "SwitchName",
- "portType": "1G",
- "location": "NTTComTokyo(NW1)",
- "area": "JPEAST",
- "vlans": [
- {
- "vid": 113,
- "status": "unused"
}, - {
- "vid": 114,
- "status": "unused"
}
], - "vlanRangeDetails": [
- {
- "sourceVlanRange": "113-128",
- "purpose": "PublicServiceEndpoint"
}, - {
- "sourceVlanRange": "129-144",
- "purpose": "PublicServiceEndpoint"
}
], - "publicServiceId": "X002300000001",
- "publicServiceName": "PublicServiceName",
- "operationId": "80a7b22906be4badb2ba8c096b17c572"
}
}
Show FIC-Port/FIC-Port(XaaS)
指定したポートの詳細情報を取得します。
path Parameters
portId required | string ^F[0-9]{12}$ Example: F010123456789 ポート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
{- "port": {
- "id": "F010123456789",
- "name": "YourPortName",
- "operationStatus": "Processing",
- "isActivated": true,
- "isPublicServiceEndpoint": true,
- "numOfVlans": 16,
- "vlanRanges": [
- "113-128"
], - "tenantId": "0dc3a0ff7cbc4f49b7ec70ac6af57104",
- "switchName": "SwitchName",
- "portType": "1G",
- "location": "NTTComTokyo(NW1)",
- "area": "JPEAST",
- "vlans": [
- {
- "vid": 113,
- "status": "unused"
}, - {
- "vid": 114,
- "status": "unused"
}
], - "vlanRangeDetails": [
- {
- "sourceVlanRange": "113-128",
- "purpose": "PublicServiceEndpoint"
}
], - "publicServiceId": "X002300000001",
- "publicServiceName": "PublicServiceName"
}
}
Update FIC-Port/FIC-Port(XaaS)
指定したポートを変更します。
path Parameters
portId required | string ^F[0-9]{12}$ Example: F010123456789 ポート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
VLAN変更の場合、numOfVlans か vlanRanges のどちらかを選択します。
・VLAN数を増やす場合、現在使用のVLANはそのままで追加
・VLAN数を減らす場合、現在使用のVLANを減らす
APIを使用してのVLANレンジの追加・削除を同時に行うことは出来ません。
VLANレンジの変更をご希望の際は、変更したいVLANレンジを追加後、不要なVLANレンジを削除してください。
リソース名変更とVLAN変更の同一実行は可能です。
ステータス変更は他の変更との同一実行は不可です。
VLAN利用用途変更は、Port(XaaS)の場合のみ変更可能です。(通常Portは変更不可)
VLAN利用用途変更は他の変更との同一実行は不可です。
port required | object |
Responses
Accepted 要求は受け付けられました
Bad Request リクエストが不正
Unauthorized 認証エラー
Not Found 未検出エラー
Conflict 競合エラー
Request samples
- Payload
{- "port": {
- "name": "YourPortNameUpdate"
}
}
Response samples
- 202
{- "port": {
- "id": "F010123456789",
- "name": "YourPortNameUpdate",
- "operationStatus": "Processing",
- "isActivated": false,
- "isPublicServiceEndpoint": true,
- "numOfVlans": 16,
- "vlanRanges": [
- "113-128"
], - "tenantId": "0dc3a0ff7cbc4f49b7ec70ac6af57104",
- "switchName": "SwitchName",
- "portType": "1G",
- "location": "NTTComTokyo(NW1)",
- "area": "JPEAST",
- "vlans": [
- {
- "vid": 113,
- "status": "unused"
}, - {
- "vid": 114,
- "status": "unused"
}
], - "vlanRangeDetails": [
- {
- "sourceVlanRange": "113-128",
- "purpose": "Own"
}
], - "publicServiceId": "X002300000001",
- "publicServiceName": "PublicServiceName",
- "operationId": "h7e55b197d044695834da3dfa6f4336c"
}
}
Delete FIC-Port/FIC-Port(XaaS)
指定したポートを廃止します。ただし、コネクションで使用されている場合は廃止出来ません。
また、ステータスがused或いはpreparingの場合は廃止出来ません。
Virtual-XaaS-Portが紐づいたXaaS-Portは廃止出来ません。(変更は可能です。)
path Parameters
portId required | string ^F[0-9]{12}$ Example: F010123456789 ポート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
{- "port": {
- "id": "F010123456789",
- "name": "YourPortName",
- "operationStatus": "Processing",
- "isActivated": true,
- "isPublicServiceEndpoint": true,
- "numOfVlans": 16,
- "vlanRanges": [
- "113-128"
], - "tenantId": "0dc3a0ff7cbc4f49b7ec70ac6af57104",
- "switchName": "SwitchName",
- "portType": "1G",
- "location": "NTTComTokyo(NW1)",
- "area": "JPEAST",
- "vlans": [
- {
- "vid": 113,
- "status": "unused"
}, - {
- "vid": 114,
- "status": "unused"
}
], - "vlanRangeDetails": [
- {
- "sourceVlanRange": "113-128",
- "purpose": "PublicServiceEndpoint"
}
], - "publicServiceId": "X002300000001",
- "publicServiceName": "PublicServiceName",
- "operationId": "80a7b22906be4badb2ba8c096b17c572"
}
}
Activate FIC-Port/FIC-Port(XaaS)
指定したポートのアクティベートを実行します。
path Parameters
portId required | string ^F[0-9]{12}$ Example: F010123456789 ポート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
{- "port": {
- "id": "F010123456789",
- "name": "YourPortName",
- "operationStatus": "Completed",
- "isActivated": true,
- "isPublicServiceEndpoint": true,
- "numOfVlans": 16,
- "vlanRanges": [
- "113-128"
], - "tenantId": "0dc3a0ff7cbc4f49b7ec70ac6af57104",
- "switchName": "SwitchName",
- "portType": "1G",
- "location": "NTTComTokyo(NW1)",
- "area": "JPEAST",
- "vlans": [
- {
- "vid": 113,
- "status": "unused"
}, - {
- "vid": 114,