FIC-Port/FIC-Port(XaaS)/FIC-Virtual Port (XaaS) - Flexible InterConnect API リファレンス (2.0.0)

Download OpenAPI specification:Download

Flexible InterConnect

概要

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

FIC-Port/FIC-Port(XaaS)/FIC-Virtual Port (XaaS)の購入・参照・変更・廃止等の操作に関するAPIドキュメントです。

Port

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

200

OK 成功しました

400

Bad Request リクエストが不正

401

Unauthorized 認証エラー

409

Conflict 競合エラー

get/v1/ports

https://api.ntt.com/fic-eri/v1/ports

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"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)

Switchを指定してポートを購入します。

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

202

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

400

Bad Request リクエストが不正

401

Unauthorized 認証エラー

409

Conflict 競合エラー

post/v1/ports

https://api.ntt.com/fic-eri/v1/ports

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"port": 
{"name": "YourPortName",
"isPublicServiceEndpoint": true,
"numOfVlans": 32,
"vlanRanges": 
["113-128",
"129-144"
],
"switchName": "SwitchName",
"portType": "1G"
}
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"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

200

OK 成功しました

400

Bad Request リクエストが不正

401

Unauthorized 認証エラー

404

Not Found 未検出エラー

409

Conflict 競合エラー

get/v1/ports/{portId}

https://api.ntt.com/fic-eri/v1/ports/{portId}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"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

202

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

400

Bad Request リクエストが不正

401

Unauthorized 認証エラー

404

Not Found 未検出エラー

409

Conflict 競合エラー

patch/v1/ports/{portId}

https://api.ntt.com/fic-eri/v1/ports/{portId}

Request samples

Payload

Content type

application/json

Example

Copy

Expand all Collapse all


{"port": 
{"name": "YourPortNameUpdate"
}
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"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

202

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

400

Bad Request リクエストが不正

401

Unauthorized 認証エラー

404

Not Found 未検出エラー

409

Conflict 競合エラー

delete/v1/ports/{portId}

https://api.ntt.com/fic-eri/v1/ports/{portId}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"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

202

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

400

Bad Request リクエストが不正

401

Unauthorized 認証エラー

404

Not Found 未検出エラー

409

Conflict 競合エラー

post/v1/ports/{portId}/activate

https://api.ntt.com/fic-eri/v1/ports/{portId}/activate

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"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,
"status": "unused"
}
],
"vlanRangeDetails": 
[
{"sourceVlanRange": "113-128",
"purpose": "PublicServiceEndpoint"
}
],
"operationId": "80a7b22906be4badb2ba8c096b17c572"
}
}

Virtual-Port(XaaS)【Pattern S】

List FIC-Virtual Port(XaaS)【Pattern S】

Virtual Port(XaaS)【Pattern S】情報の一覧を取得します。

query Parameters

id	string ^F[0-9]{12}$ Example: id=F010123456789 VirtualPort ID
name	string Example: name=YourVirtualPortName VirtualPort名半角英数及び一部記号&()-_ 64文字
tenantId	string <uuid> ^[0-9a-f]{32}$ Example: tenantId=f0dc3a0ff7cbc4f49b7ec70ac6af57104 テナントID
serviceName	string Example: serviceName=ecl 接続先クラウド名 "ecl","awsPrivate"のいずれかが設定可能
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

200

OK 成功しました

400

Bad Request リクエストが不正

401

Unauthorized 認証エラー

409

Conflict 競合エラー

get/v1/virtual-ports-patterns

https://api.ntt.com/fic-eri/v1/virtual-ports-patterns

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"virtualPortsPatternS": 
[
{"id": "F011900000003",
"name": "virtualPortPatternS",
"operationStatus": "Completed",
"tenantId": "0dc3a0ff7cbc4f49b7ec70ac6af57104",
"serviceName": "ecl",
"interconnect": "JP1-1",
"isPublicServiceEndpoint": true,
"area": "JPEAST"
}
]
}

Create FIC-Virtual Port(XaaS)【Pattern S】

Virtual Port(XaaS)【Pattern S】を購入します。

サービス概要や、注意事項等の詳細情報に関しましてはこちらをご参照下さい。

事前にお客さまにご準備いただくものや、画面での操作に関しましてはこちらをご参照下さい。

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

virtualPortPatternS

required

object

Responses

202

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

400

Bad Request リクエストが不正

401

Unauthorized 認証エラー

409

Conflict 競合エラー

post/v1/virtual-ports-patterns

https://api.ntt.com/fic-eri/v1/virtual-ports-patterns

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"virtualPortPatternS": 
{"name": "port1",
"serviceName": "ecl",
"interconnect": "JP1-1",
"isPublicServiceEndpoint": true
}
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"virtualPortPatternS": 
{"id": "F011900000003",
"name": "port1",
"operationStatus": "Processing",
"tenantId": "0dc3a0ff7cbc4f49b7ec70ac6af57104",
"serviceName": "ecl",
"interconnect": "JP1-1",
"isPublicServiceEndpoint": true,
"area": "JPEAST",
"operationId": "8e592a1bb30e47faa226ff5ff6b8f85f"
}
}

Show FIC-Virtual Port(XaaS)【Pattern S】

指定したVirtual Port(XaaS)【Pattern S】の詳細情報を取得します。

path Parameters

portId

required

string

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/virtual-ports-patterns/{portId}

https://api.ntt.com/fic-eri/v1/virtual-ports-patterns/{portId}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"virtualPortPatternS": 
{"id": "F011900000003",
"name": "port1",
"operationStatus": "Completed",
"tenantId": "0dc3a0ff7cbc4f49b7ec70ac6af57104",
"serviceName": "ecl",
"interconnect": "JP1-1",
"isPublicServiceEndpoint": true,
"area": "JPEAST"
}
}

Update FIC-Virtual Port(XaaS)【Pattern S】

指定したVirtual Port(XaaS)【Pattern S】を変更します。

path Parameters

portId

required

string

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

virtualPortPatternS

required

object

Responses

202

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

400

Bad Request リクエストが不正

401

Unauthorized 認証エラー

404

Not Found 未検出エラー

409

Conflict 競合エラー

patch/v1/virtual-ports-patterns/{portId}

https://api.ntt.com/fic-eri/v1/virtual-ports-patterns/{portId}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"virtualPortPatternS": 
{"name": "port1"
}
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"virtualPortPatternS": 
{"id": "F011900000003",
"name": "port1",
"operationStatus": "Processing",
"tenantId": "0dc3a0ff7cbc4f49b7ec70ac6af57104",
"serviceName": "ecl",
"interconnect": "JP1-1",
"isPublicServiceEndpoint": true,
"area": "JPEAST",
"operationId": "8e592a1bb30e47faa226ff5ff6b8f85f"
}
}

Delete FIC-Virtual Port(XaaS)【Pattern S】

指定したVirtual Port(XaaS)【Pattern S】を廃止します。ただし、コネクションで使用されている場合は廃止出来ません。

path Parameters

portId

required

string

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 競合エラー

delete/v1/virtual-ports-patterns/{portId}

https://api.ntt.com/fic-eri/v1/virtual-ports-patterns/{portId}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"virtualPortPatternS": 
{"id": "F011900000003",
"name": "port1",
"operationStatus": "Processing",
"tenantId": "0dc3a0ff7cbc4f49b7ec70ac6af57104",
"serviceName": "ecl",
"interconnect": "JP1-1",
"isPublicServiceEndpoint": true,
"area": "JPEAST",
"operationId": "8e592a1bb30e47faa226ff5ff6b8f85f"
}
}

Virtual-Port(XaaS)【Pattern X】

List FIC-Virtual Port(XaaS)【Pattern X】

Virtual Port(XaaS)【Pattern X】情報の一覧を取得します。

query Parameters

id	string ^F[0-9]{12}$ Example: id=F010123456789 VirtualPort ID
name	string Example: name=YourVirtualPortName VirtualPort名半角英数及び一部記号&()-_ 64文字
tenantId	string <uuid> ^[0-9a-f]{32}$ Example: tenantId=f0dc3a0ff7cbc4f49b7ec70ac6af57104 テナントID
location	string Example: location=TK7-PATCH-PANEL データセンター名
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

200

OK　成功しました

400

Bad Request リクエストが不正

401

Unauthorized 認証エラー

409

Conflict 競合エラー

get/v1/virtual-ports-patternx

https://api.ntt.com/fic-eri/v1/virtual-ports-patternx

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"virtualPortsPatternX": 
[
{"id": "F011900000003",
"name": "port1",
"operationStatus": "Completed",
"numOfVlans": 16,
"vlanRanges": 
["113-128"
],
"tenantId": "0dc3a0ff7cbc4f49b7ec70ac6af57104",
"ownerPortId": "F011900000001",
"ownerTenantId": "24661ade0df34648ae6ca58d83b3173a",
"maxBandwidth": "100M",
"isPublicServiceEndpoint": true,
"location": "NTTComTokyo(NW1)",
"area": "JPEAST",
"vlans": 
[
{"vid": 113,
"status": "unused"
},
{"vid": 114,
"status": "unused"
}
]
}
]
}

Create FIC-Virtual Port(XaaS)【Pattern X】

※このAPIは承認の申請をする際にApproval-Request　のAPIでbody{}の中に記述いただくAPIであり、直接お客様がお使いになられるAPIではございません。

サービス概要や、注意事項等の詳細情報に関しましてはこちらをご参照下さい。

画面での操作に関しましてはこちらをご参照下さい。

・Virtual Port(XaaS)【Pattern X】を変更するに当たって、接続先FIC-Port(XaaS)の情報が必要となります。

<接続までの大まかな流れは以下のとおりです。>

STEP1 作成承認申請

Approval-Request　のAPIに必須となる項目を入力して、接続承認を申請する。

STEP2 承認/否認

FIC-Port(XaaS)を所有している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

virtualPortPatternX

required

object

Responses

202

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

400

Bad Request リクエストが不正

401

Unauthorized 認証エラー

409

Conflict 競合エラー

post/v1/virtual-ports-patternx

https://api.ntt.com/fic-eri/v1/virtual-ports-patternx

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"virtualPortPatternX": 
{"name": "port1",
"numOfVlans": 32,
"ownerPortId": "F011900000001",
"ownerTenantId": "24661ade0df34648ae6ca58d83b3173a",
"maxBandwidth": "100M",
"isPublicServiceEndpoint": true,
"approvalRequestId": "req0000000001"
}
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"virtualPortPatternX": 
{"id": "F011900000003",
"name": "port1",
"operationStatus": "Processing",
"numOfVlans": 32,
"vlanRanges": 
["113-128",
"129-144"
],
"tenantId": "0dc3a0ff7cbc4f49b7ec70ac6af57104",
"ownerPortId": "F011900000001",
"ownerTenantId": "24661ade0df34648ae6ca58d83b3173a",
"maxBandwidth": "100M",
"isPublicServiceEndpoint": true,
"location": "NTTComTokyo(NW1)",
"area": "JPEAST",
"vlans": 
[
{"vid": 113,
"status": "unused"
},
{"vid": 114,
"status": "unused"
}
],
"operationId": "8e592a1bb30e47faa226ff5ff6b8f85f"
}
}

Show FIC-Virtual Port(XaaS)【Pattern X】

指定したVirtual Port(XaaS)【Pattern X】の詳細情報を取得します。

path Parameters

portId

required

string

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/virtual-ports-patternx/{portId}

https://api.ntt.com/fic-eri/v1/virtual-ports-patternx/{portId}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"virtualPortPatternX": 
{"id": "F011900000003",
"name": "port1",
"operationStatus": "Processing",
"numOfVlans": 32,
"vlanRanges": 
["113-128",
"129-144"
],
"tenantId": "0dc3a0ff7cbc4f49b7ec70ac6af57104",
"ownerPortId": "F011900000001",
"ownerTenantId": "24661ade0df34648ae6ca58d83b3173a",
"maxBandwidth": "100M",
"isPublicServiceEndpoint": true,
"location": "NTTComTokyo(NW1)",
"area": "JPEAST",
"vlans": 
[
{"vid": 113,
"status": "unused"
},
{"vid": 114,
"status": "unused"
}
]
}
}

Update FIC-Virtual Port(XaaS)【Pattern X】

※このAPIは承認の申請をする際にApproval-Request　のAPIでbody{}の中に記述いただくAPIであり、直接お客様がお使いになられるAPIではございません。

・Virtual Port(XaaS)【Pattern X】を変更するに当たって、接続先FIC-Port(XaaS)の情報が必要となります。

<接続までの大まかな流れは以下のとおりです。>

STEP1 作成承認申請

Approval-Request　のAPIに必須となる項目を入力して、接続承認を申請する。

STEP2 承認/否認

FIC-Port(XaaS)を所有しているXaaS事業者にて承認行為は実施される。

STEP3 作成

承認された時に返ってくるapprovalRequestIdを、Approval-Request　のAPIのExecuteのパス(/v1/approval-requests/{request_id}/execute)に入力し、実行する。

path Parameters

portId

required

string

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

virtualPortPatternX

required

object

Responses

202

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

400

Bad Request リクエストが不正

401

Unauthorized 認証エラー

404

Not Found 未検出エラー

409

Conflict 競合エラー

patch/v1/virtual-ports-patternx/{portId}

https://api.ntt.com/fic-eri/v1/virtual-ports-patternx/{portId}

Request samples

Payload

Content type

application/json

Example

Copy

Expand all Collapse all


{"virtualPortPatternX": 
{"name": "port1"
}
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"virtualPortPatternX": 
{"id": "F011900000003",
"name": "port1",
"operationStatus": "Processing",
"numOfVlans": 32,
"vlanRanges": 
["113-128",
"129-144"
],
"tenantId": "4c126bc2e2f14c5aa43659962089a72e",
"ownerPortId": "F011900000001",
"ownerTenantId": "24661ade0df34648ae6ca58d83b3173a",
"maxBandwidth": "100M",
"isPublicServiceEndpoint": true,
"location": "NTTComTokyo(NW1)",
"area": "JPEAST",
"vlans": 
[
{"vid": 113,
"status": "unused"
},
{"vid": 114,
"status": "unused"
}
],
"operationId": "8e592a1bb30e47faa226ff5ff6b8f85f"
}
}

Delete FIC-Virtual Port(XaaS)【Pattern X】

指定したVirtual Port(XaaS)【Pattern X】を廃止します。

ただし、紐づくConnectionが存在する場合は廃止出来ません。

紐づくPublic Serviceが存在する場合も廃止出来ません。

path Parameters

portId

required

string

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 競合エラー

delete/v1/virtual-ports-patternx/{portId}

https://api.ntt.com/fic-eri/v1/virtual-ports-patternx/{portId}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"virtualPortPatternX": 
{"id": "F011900000003",
"name": "port1",
"operationStatus": "Processing",
"numOfVlans": 32,
"vlanRanges": 
["113-128",
"129-144"
],
"tenantId": "0dc3a0ff7cbc4f49b7ec70ac6af57104",
"ownerPortId": "F011900000001",
"ownerTenantId": "24661ade0df34648ae6ca58d83b3173a",
"maxBandwidth": "100M",
"isPublicServiceEndpoint": true,
"location": "NTTComTokyo(NW1)",
"area": "JPEAST",
"vlans": 
[
{"vid": 113,
"status": "unused"
},
{"vid": 114,
"status": "unused"
}
],
"operationId": "8e592a1bb30e47faa226ff5ff6b8f85f"
}
}