モジュール名: server

機能名 説明
list サーバー一覧を取得します

機能名: list

説明

サーバー一覧を取得します。

リクエスト
HTTPメソッド リクエストURL
GET http://{Hostname}:{Port}/api/server/list
リクエストパラメーター

なし

リクエスト例
GET /api/server/list HTTP/1.1
X-Fs-SessionId: F15B47BC1F004DB489BAF1E4CDD0100D
レスポンス
HTTPステータスコード

APIの実行が成功した場合、HTTPステータスコードは200が返ります。

実行結果

実行に成功するとサーバー一覧が返ります。
サーバーの情報としては次の情報が取得できます。 

<result>
	<status>success</status>
	<data>
		<server>
			<serverId>2abf15cc-0307-4df9-83c4-cbbac5804c5f</serverId>
			<serverName>WARP_SERVER_01</serverName>
		</server>
		<server>
			<serverId>d7a96e5c-62f7-4a52-91e3-96b01257866b</serverId>
			<serverName>WARP_SERVER_02</serverName>
		</server>
	</data>
</result>
エラーケース

下記以外のエラーについては、共通エラーコードを参照してください。

エラーコード HTTPステータスコード 説明
2001 403 Forbidden ログインしていなかった場合

▲ このページのトップへ