フローサービスAPI

機能名	説明
test	コネクションの接続テストを行います

機能名: test

説明

コネクションの接続テストを行います。

リクエスト

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

リクエストパラメーター

パラメーター	必須	説明
type	はい	コネクションタイプを指定します。 rdb - RDB http - HTTP ftp - FTP smtp - SMTP pop3 - POP3 imap4 - IMAP4 aws - AWS kintone - kintone notes - Notes
name	はい	コネクション名を指定します。
ownerType	はい	コネクション情報の種別を指定します。「システムコネクション」の場合は「system」、「ユーザーコネクション」の場合は「user」を指定します。
userName	いいえ	取得するユーザーコネクションのユーザー名を指定します。 ownerTypeが「user」のときのみ有効です。指定しなかった場合はログインユーザーとなります。

リクエスト例

GET /api/connection/test?type=rdb&name=test&ownerType=user&userName=/guest HTTP/1.1
X-Fs-SessionId: F15B47BC1F004DB489BAF1E4CDD0100D

レスポンス

HTTPステータスコード

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

実行結果

実行に成功するとコネクションのテスト結果が返ります。

以下に各種コネクション情報の内容と実行結果の例を記します。
JSONで出力する場合、キーの中のアンダースコアはスペースとなります。

実行結果（RDBの場合）

RDBのテスト結果としては次の情報が取得できます。

データベース名（DBMS）
データベースバージョン（DBMS Version）
JDBCドライバー名（JDBC Driver）
JDBCバージョン（jJDBC Driver Version）
JDBCメジャーバージョン（JDBC Driver Major Version）
JDBCマイナーバージョン（JDBC Driver Minor Version）
JDBC URL（JDBC Connection URL）

<result>
	<status>success</status>
	<data>
		<DBMS>HSQL Database Engine</DBMS>
		<DBMS_Version>2.3.2</DBMS_Version>
		<JDBC_Driver>HSQL Database Engine Driver</JDBC_Driver>
		<JDBC_Driver_Version>2.3.2</JDBC_Driver_Version>
		<JDBC_Driver_Major_Version>2</JDBC_Driver_Major_Version>
		<JDBC_Driver_Minor_Version>3</JDBC_Driver_Minor_Version>
		<JDBC_Connection_URL>jdbc:hsqldb:hsql://localhost:29001/asteriadb</JDBC_Connection_URL>
	</data>
</result>

実行結果（Httpの場合）

Httpのテスト結果として次の情報が取得できます。

ステータス（StatusLine）

<result>
	<status>success</status>
	<data>
		<StatusLine>HTTP/1.0 200 OK</StatusLine>
	</data>
</result>

実行結果（Ftpの場合）

Ftpのテスト結果として次の情報が取得できます。

フォルダー（ConnectedDir）

<result>
	<status>success</status>
	<data>
		<ConnectedDir>/</ConnectedDir>
	</data>
</result>

実行結果（SMTPの場合）

SMTPのテスト結果として次の情報が取得できます。

ステータス（NOOP）

<result>
	<status>success</status>
	<data>
		<NOOP>250 2.0.0 Ok</NOOP>
	</data>
</result>

実行結果（POP3の場合）

POP3のテスト結果として次の情報が取得できます。

未読メッセージ数（MessageCount）

<result>
	<status>success</status>
	<data>
		<MessageCount>0</MessageCount>
	</data>
</result>

実行結果（IMAP4の場合）

IMAP4のテスト結果として次の情報が取得できます。

未読メッセージ数（MessageCount）

<result>
	<status>success</status>
	<data>
		<MessageCount>34</MessageCount>
	</data>
</result>

実行結果（AWSの場合）

AWSのテスト結果として次の情報が取得できます。

ユーザー名（User Name）

<result>
	<status>success</status>
	<data>
		<User_Name>user</User_Name>
	</data>
</result>

実行結果（kintoneの場合）

kintoneのテスト結果として次の情報が取得できます。

アプリ数（App Count）

<result>
	<status>success</status>
	<data>
		<App_Count>63</App_Count>
	</data>
</result>

実行結果（Notesの場合）

Notesのテスト結果として次の情報が取得できます。

Notesのバージョン（Notes Client Version）
ユーザー名（User Name）

<result>
	<status>success</status>
	<data>
		<Notes_Client_Version>8.0.1</Notes_Client_Version>
		<User_Name />
	</data>
</result>

エラーケース

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

エラーコード	HTTPステータスコード	説明
2000	400 Bad Request	パラメーター type, ownerType の値が正しくなかった場合パラメーター type, ownerType, name の値は設定されていなかった場合パラメーター userName で指定されたユーザーの取得にエラーが発生した場合
2002	404 Not Found	パラメーター type, name で指定されたコネクション情報が存在しなかった場合
9000	500 Internal Server Error	コネクションのライブラリが存在しなかった場合証明書の認証に失敗した場合内部の通信に失敗した場合サーバー内部にエラーが発生した場合

▲ このページのトップへ

モジュール名: connection

機能名: test