Switch - Flexible InterConnect API リファレンス (2.0.0)

Download OpenAPI specification:Download

Flexible InterConnect

概要

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

スイッチの参照操作に関するAPIドキュメントです。

Switch

List Switches

スイッチ情報の一覧を取得します。

query Parameters

id	string <uuid> ^[0-9a-f]{32}$ Example: id=7ae9d49a2b234e818758257ecef8e1e7 スイッチID
switchName	string Example: switchName=SwitchName スイッチのエイリアス名
name	string Enum: "JPEAST" "JPWEST" Example: name=JPEAST エリア名 'JPEAST'または'JPWEST'
location	string Example: location=NTTComTokyo(NW1) ロケーション(データセンター)名
enablePremium	boolean Enum: true false Example: enablePremium=true プレミアム接続可否プレミアム利用時'true'(接続OK)またはスタンダード利用時'false'(接続NG)
role	string Enum: "primary" "secondary" Example: role=primary プレミアム接続時の優先度 'primary'または'secondary'

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/switches

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

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"switches": 
[
{"id": "7ae9d49a2b234e818758257ecef8e1e7",
"switchName": "SwitchName",
"area": "JPEAST",
"location": "NTTComTokyo(NW1)",
"enablePremium": true,
"role": "primary",
"portTypes": 
[
{"portType": "1G",
"available": true
},
{"portType": "10G",
"available": true
}
],
"numOfAvailableVlans": 3200,
"vlanRanges": 
[
{"vlanRange": "113-128",
"available": true
},
{"vlanRange": "129-144",
"available": true
}
]
}
]
}