モジュール名: session

機能名	説明
list	セッションの一覧を取得します
show	セッション情報を取得します

機能名: list

説明

セッションの一覧を取得します。

リクエスト

HTTPメソッド	リクエストURL
GET	`http://{Hostname}:{Port}/api/session/list`

リクエストパラメーター

なし

リクエスト例

GET /api/session/list HTTP/1.1
X-Fs-SessionId: F15B47BC1F004DB489BAF1E4CDD0100D

レスポンス

HTTPステータスコード

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

実行結果

実行に成功するとセッションの一覧が返ります。
セッションの情報としては次の情報が取得できます。

セッションID
実行ユーザー名
実行ユーザーが設定されていない場合は空となります。
タイムアウトするまでの残り時間
ステータス
セッションが実行中の場合は「Running」となります。実行中でない場合は空です。

<result>
	<status>success</status>
	<data>
		<session>
			<sessionId>75466093-c239-4a24-acf5-95d939f74b77</sessionId>
			<user>/guest</user>
			<remain>18min46sec</remain>
			<status>Running</status>
		</session>
		<session>
			<sessionId>cf9ae36d-9952-4e9a-9d57-e10248514cdd</sessionId>
			<user></user>
			<remain>21min39sec</remain>
			<status></status>
		</session>
	</data>
</result>

エラーケース

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

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

▲ このページのトップへ

機能名: show

説明

指定のセッションについての情報を取得します。

リクエスト

HTTPメソッド	リクエストURL
GET	`http://{Hostname}:{Port}/api/session/show`

リクエストパラメーター

パラメーター	必須	説明
sessionId	はい	情報を取得するセッションのセッションIDを指定します。セッションIDは、list APIの実行結果で取得できます。

リクエスト例

GET /api/session/show?sessionId=cf9ae36d-9952-4e9a-9d57-e10248514cdd HTTP/1.1
X-Fs-SessionId: F15B47BC1F004DB489BAF1E4CDD0100D

レスポンス

HTTPステータスコード

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

実行結果

実行に成功するとセッションの情報が返ります。
セッションの情報としては次の情報が取得できます。

セッションのタイムアウト時間
作成日時
実行ユーザー名
実行ユーザーが設定されていない場合は空となります。
タイムアウトするまでの残り時間
外部変数セットのセッション変数の内容
StreamPutコンポーネントでセッションに保存されたストリームの内容

<result>
	<status>success</status>
	<data>
		<lifeTime>30min</lifeTime>
		<createTime>2012-08-24T18:21:17 JST</createTime>
		<user>/guest</user>
		<remain>29min12sec</remain>
		<externalVariables>
			<externalVariable>
				<name>ExVar1</name>
				<variables>
					<variable>
						<name>var1</name>
						<value>value1</value>
					</variable>
					<variable>
						<name>var2</name>
						<value>value2</value>
					</variable>
				</variables>
			</externalVariable>
			<externalVariable>
				<name>ExVar2</name>
				<variables>
					<variable>
						<name>var1</name>
						<value>value1</value>
					</variable>
					<variable>
						<name>var2</name>
						<value>value2</value>
					</variable>
				</variables>
			</externalVariable>
		</externalVariables>
		<streams>
			<stream>
				<name>stream1</name>
				<value>value1</value>
			</stream>
			<stream>
				<name>stream2</name>
				<value>value2</value>
			</stream>
		</streams>
	</data>
</result>

エラーケース

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

エラーコード	HTTPステータスコード	説明
2000	400 Bad Request	sessionIdパラメーターが存在しなかった場合
2001	403 Forbidden	ログインしていなかった場合
2002	404 Not Found	sessionIdで指定したセッションが存在しなかった場合

▲ このページのトップへ