モジュール名: flowservice

機能名 説明
configuration/get フローサービスの設定情報を取得します
configuration/set フローサービスの設定情報を変更します
clear フローサービスが保持しているアカウント情報キャッシュ、データベース接続プールまたはプロジェクトキャッシュをクリアします
suspend 実行中のフローサービスを一時停止状態にします
resume 一時停止状態にになっているフローサービスを再開します
configuration/checkpoint/get チェックポイントの設定情報を取得します
configuration/checkpoint/set チェックポイントの設定情報を変更します
server/get サーバーの情報を取得します
server/name/set サーバーの名前を変更します

機能名: configuration/get

説明

フローサービスの設定情報を取得します。

権限

administrator、developer、operator

リクエスト
HTTPメソッド リクエストURL
GET http://{Hostname}:{Port}/mcapi/flowservice/configuration/get
リクエストパラメーター
パラメーター 必須 説明
process はい 取得するプロセスの種別を指定します。
  • flowEngine - フローエンジン情報
  • httpListener - HTTPリスナー情報
  • httpsListner - HTTPSリスナー情報
  • flowDesignerLister - フローデザイナーリスナー情報
  • all - すべての情報
リクエスト例
GET /mcapi/flowservice/configuration/get?process=flowEngine HTTP/1.1
X-As-SessionId: 76B7EDBB1F14443FA538E62E05C5EEA4
レスポンス
HTTPステータスコード

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

実行結果(共通)

実行に成功すると指定したプロセスの設定情報が返ります。 各種実行設定の共通の情報として、次の情報が取得できます。

以下に各種実行設定個別の情報と実行結果の例を記します。

実行結果(フローエンジン情報の場合)

フローエンジンの個別の情報としては次の情報が取得できます。

{
    "result": {
        "status": "success",
        "data": {
            "configuration": {
                "flowEngine": {
                    "threadPoolSize": 32,
                    "threadMaxSize": 32,
                    "requestQueueSize": 64,
                    "requestQueueWarningSize": 48,
                    "observationTimeOut": 300,
                    "projectCacheSize": 30,
                    "sessionTimeOut": 1800,
                    "connectionPoolSize": 20,
                    "connectionPoolTimeOut": 7200,
                    "connectionReuseCount": 100,
                    "aacCacheTime": 900,
                    "dtdXmlSchemaFilePath": "services/flowservice/dtd",
                    "jdbcForwardOnlyDrivers": [
                    	"sun.jdbc.odbc.JdbcOdbcDriver",
                    	"com.fujitsu.symfoware.jdbc.SYMDriver",
                    	"jp.co.dw_sapporo.JDBC.JDBCDriver"
                    ],
                    "recoveryInteval": 300,
                    "recoveryRetryCount": 3,
                    "recoveryMailNotify": true,
                    "parallelThreadMaxSize": 32,
                    "parallelThreadObservationTimeOut": 300,
                    "highPriorityThreadMaxSize": 32,
                    "highPriorityThreadObservationTimeOut": 300
                }
            }
        }
    }
}
実行結果(HTTPリスナー情報の場合)

HTTPリスナーの個別の情報として次の情報が取得できます。

{
    "result": {
        "status": "success",
        "data": {
            "configuration": {
                "httpListener": {
                    "threadPoolSize": 8,
                    "threadMaxSize": 32,
                    "requestQueueSize": 64,
                    "requestQueueWarningSize": 48,
                    "observationTimeOut": 300,
                    "enable": true,
                    "port": 21380,
                    "socketOptionEnable": true,
                    "ipControlEnable": false,
                    "ipAllowList": [
                    	"*.*.*.*"
                    ],
                    "ipDenyList": [
                        "120.120.120.1"
                    ],
                    "receiveTimeOut": 60,
                    "receiveBufferSize": 0,
                    "requestLineMaxSize": 2048,
                    "headerMaxSize": 8192,
                    "backlogSize": 0,
                    "dumpEnable": false,
                    "dumpDirectory": ""
                }
            }
        }
    }
}
実行結果(HTTPSリスナー情報の場合)

HTTPSリスナーの個別の情報として次の情報が取得できます。

{
    "result": {
        "status": "success",
        "data": {
            "configuration": {
                "httpsListener": {
                    "threadPoolSize": 8,
                    "threadMaxSize": 32,
                    "requestQueueSize": 64,
                    "requestQueueWarningSize": 48,
                    "observationTimeOut": 300,
                    "enable": false,
                    "port": 21443,
                    "socketOptionEnable": false,
                    "ipControlEnable": false,
                    "ipAllowList": [
                        "*.*.*.*"
                    ],
                    "ipDenyList": [
                        ""
                    ],
                    "receiveTimeOut": 60,
                    "receiveBufferSize": 0,
                    "requestLineMaxSize": 2048,
                    "headerMaxSize": 8192,
                    "backlogSize": 0,
                    "sslDebugLogEnable": false,
                    "clientAuthentication": true,
                    "acceptNotValidYetClientCertification": false,
                    "acceptExpiredClientCertification": false,
                    "dumpEnable": false,
                    "dumpDirectory": ""
                }
            }
        }
    }
}
実行結果(フローデザイナーリスナー情報の場合)

フローデザイナーリスナーの個別の情報として次の情報が取得できます。

{
    "result": {
        "status": "success",
        "data": {
            "configuration": {
                "flowDesignerListener": {
                    "threadPoolSize": 8,
                    "threadMaxSize": 32,
                    "requestQueueSize": 64,
                    "requestQueueWarningSize": 48,
                    "observationTimeOut": 300,
                    "socketOptionEnable": false,
                    "dumpEnable": false,
                    "dumpDirectory": ""
                }
            }
        }
    }
}
エラーケース

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

HTTPステータスコード エラーコード 説明
400 Bad Request 2001 パラメーター process の値が正しくなかった場合
2002 パラメーター process の値が設定されていなかった場合
403 Forbidden 3001 ログインしていなかった場合
500 Internal Server Error 5001 設定ファイルの読み込みに失敗した場合
5003 設定ファイルの解析に失敗した場合
5201 指定したプロセス情報が存在しなかった場合
5202 プロセス情報が存在しなかった場合
5205 プロセス情報の解析に失敗した場合

▲ このページのトップへ

機能名: configuration/set

説明

フローサービスの設定情報を変更します。

権限

administrator

リクエスト
HTTPメソッド リクエストURL
POST http://{Hostname}:{Port}/mcapi/flowservice/configuration/set
リクエストパラメーター
なし
リクエスト例

getConfiguraionで取得できる結果と同じ形式のデータをHTTPボディに設定します。
項目が存在しない場合は更新されません。

次の例ではflowEngine(フローエンジン情報)が更新されます。

POST /mcapi/flowservice/configuration/set HTTP/1.1
Content-Type: application/json; charset=UTF-8
X-As-SessionId: 76B7EDBB1F14443FA538E62E05C5EEA4
Content-Length: 1197

{
    "configuration": {
        "flowEngine": {
            "threadPoolSize": 32,
            "threadMaxSize": 32,
            "requestQueueSize": 64,
            "requestQueueWarningSize": 48,
            "observationTimeOut": 300,
            "projectCacheSize": 30,
            "sessionTimeOut": 1800,
            "connectionPoolSize": 20,
            "connectionPoolTimeOut": 7200,
            "connectionReuseCount": 100,
            "aacCacheTime": 900,
            "dtdXmlSchemaFilePath": "services/flowservice/dtd",
            "jdbcForwardOnlyDrivers": [
            	"sun.jdbc.odbc.JdbcOdbcDriver",
            	"com.fujitsu.symfoware.jdbc.SYMDriver",
            	"jp.co.dw_sapporo.JDBC.JDBCDriver"
            ],
            "recoveryInteval": 300,
            "recoveryRetryCount": 3,
            "recoveryMailNotify": true,
            "parallelThreadMaxSize": 32,
            "parallelThreadObservationTimeOut": 300,
            "highPriorityThreadMaxSize": 32,
            "highPriorityThreadObservationTimeOut": 300
        }
    }
}
レスポンス
HTTPステータスコード

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

実行結果

実行に成功するとフローサービスの設定情報を変更します。

{
    "result": {
        "status": "success",
        "data": {}
    }
}
エラーケース

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

HTTPステータスコード エラーコード 説明
400 Bad Request 2001 パラメーター process の値が正しくなかった場合
2002 パラメーター process の値が設定されていなかった場合
2102 Jsonデータの必須項目が入力されなかった場合
2103 Jsonデータの値のタイプが正しくなかった場合
403 Forbidden 3001 ログインしていなかった場合
500 Internal Server Error 5001 設定ファイルの読み込みに失敗した場合
5002 設定ファイルの書き込みに失敗した場合
5003 設定ファイルの解析に失敗した場合
5201 指定したプロセス情報が存在しなかった場合
5202 プロセス情報が存在しなかった場合
5205 プロセス情報の解析に失敗した場合

▲ このページのトップへ

機能名: clear

説明

フローサービスが保持しているアカウント情報キャッシュ、データベース接続プールまたはプロジェクトキャッシュをクリアします。

権限

administrator、operator

リクエスト
HTTPメソッド リクエストURL
POST http://{Hostname}:{Port}/mcapi/flowservice/clear
リクエストパラメーター
パラメーター 必須 説明
type はい クリアする対象を「aac」、「connection」、「project」、「all」のいずれかで指定します。
  • aac - アカウント情報キャッシュのクリア
  • connection - データベース接続プールのクリア
  • project - プロジェクトキャッシュのクリア
  • all - 上記3項目

リクエスト例
POST /mcapi/flowservice/clear HTTP/1.1
Content-Type: application/x-www-form-urlencoded; charset=UTF-8
X-As-SessionId: 76B7EDBB1F14443FA538E62E05C5EEA4
Content-Length: 8

type=aac
レスポンス
HTTPステータスコード

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

実行結果

実行に成功するとフローサービスの指定対象をクリアします。

{
    "result": {
        "status": "success",
        "data": {}
    }
}
エラーケース

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

HTTPステータスコード エラーコード 説明
400 Bad Request 2001 パラメーター type の値が正しくなかった場合
2002 パラメーター type の値が設定されていなかった場合
403 Forbidden 3001 ログインしていなかった場合
500 Internal Server Error 5001 設定ファイルの読み込みに失敗した場合
5003 設定ファイルの解析に失敗した場合
5101 内部の通信に失敗した場合
5102 サーバー内部にエラーが発生した場合

▲ このページのトップへ

機能名: suspend

説明

実行中のフローサービスを一時停止状態にします。

権限

administrator、operator

リクエスト
HTTPメソッド リクエストURL
POST http://{Hostname}:{Port}/mcapi/flowservice/suspend
リクエストパラメーター

なし

リクエスト例
POST /mcapi/flowservice/suspend HTTP/1.1
Content-Type: application/x-www-form-urlencoded; charset=UTF-8
X-As-SessionId: 76B7EDBB1F14443FA538E62E05C5EEA4
Content-Length: 0
レスポンス
HTTPステータスコード

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

実行結果

実行に成功するとフローサービスを一時停止状態にします。

{
    "result": {
        "status": "success",
        "data": {}
    }
}
エラーケース

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

HTTPステータスコード エラーコード 説明
403 Forbidden 3001 ログインしていなかった場合
500 Internal Server Error 5001 設定ファイルの読み込みに失敗した場合
5003 設定ファイルの解析に失敗した場合
5101 内部の通信に失敗した場合
5102 サーバー内部にエラーが発生した場合

▲ このページのトップへ

機能名: resume

説明

一時停止状態にになっているフローサービスを再開します。

権限

administrator、operator

リクエスト
HTTPメソッド リクエストURL
POST http://{Hostname}:{Port}/mcapi/flowservice/resume
リクエストパラメーター

なし

リクエスト例
POST /mcapi/flowservice/resume HTTP/1.1
Content-Type: application/x-www-form-urlencoded; charset=UTF-8
X-As-SessionId: 76B7EDBB1F14443FA538E62E05C5EEA4
Content-Length: 0
レスポンス
HTTPステータスコード

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

実行結果

実行に成功すると一時停止状態にになっているフローサービスを再開します。

{
    "result": {
        "status": "success",
        "data": {}
    }
}
エラーケース

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

HTTPステータスコード エラーコード 説明
403 Forbidden 3001 ログインしていなかった場合
500 Internal Server Error 5001 設定ファイルの読み込みに失敗した場合
5003 設定ファイルの解析に失敗した場合
5101 内部の通信に失敗した場合
5102 サーバー内部にエラーが発生した場合

▲ このページのトップへ

機能名: configuration/checkpoint/get

説明

チェックポイントの設定情報を取得します。

権限

administrator、developer、operator

リクエスト
HTTPメソッド リクエストURL
GET http://{Hostname}:{Port}/mcapi/flowservice/configuration/checkpoint/get
リクエストパラメーター
なし
リクエスト例
GET /mcapi/flowservice/configuration/checkpoint/get HTTP/1.1
X-As-SessionId: 76B7EDBB1F14443FA538E62E05C5EEA4
レスポンス
HTTPステータスコード

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

実行結果

実行に成功するとチェックポイントの設定情報が返ります。
設定情報としては次の情報が取得できます。

{
    "result": {
        "status": "success",
        "data": {
            "checkpoint": {
                "checkpointStorePath": "checkpoint",
                "checkpointConnection": "internal",
                "checkpointConnectionList": [
                    "internal",
                    "test_connection"
                ],
                "checkpointDefaultMaxRetryCount": 3,
                "checkpointDefaultRetryInterval": 60,
                "serviceRetryInterval": 60,
                "serviceHeartbeatMonitortimeout": 600
            }
        }
    }
}
エラーケース

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

HTTPステータスコード エラーコード 説明
403 Forbidden 3001 ログインしていなかった場合
500 Internal Server Error 5001 設定ファイルの読み込みに失敗した場合
5003 設定ファイルの解析に失敗した場合

▲ このページのトップへ

機能名: configuration/checkpoint/set

説明

チェックポイントの設定情報を変更します。

権限

administrator

リクエスト
HTTPメソッド リクエストURL
POST http://{Hostname}:{Port}/mcapi/flowservice/configuration/checkpoint/set
リクエストパラメーター
なし
リクエスト例

次の情報が設定できます。設定した情報だけを更新します。

POST /mcapi/flowservice/configuration/checkpoint/set HTTP/1.1
Content-Type: application/json; charset=UTF-8
X-As-SessionId: 76B7EDBB1F14443FA538E62E05C5EEA4
Content-Length: 380

{
    "checkpoint": {
        "checkpointStorePath": "checkpoint",
        "checkpointConnection": "internal",
        "checkpointDefaultMaxRetryCount": 3,
        "checkpointDefaultRetryInterval": 60,
        "serviceRetryInterval": 60,
        "serviceHeartbeatMonitortimeout": 600
    }
}
レスポンス
HTTPステータスコード

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

実行結果

実行に成功するとチェックポイントの設定情報が返ります。

{
    "result": {
        "status": "success",
        "data": {
            "checkpoint": {
                "checkpointStorePath": "checkpoint",
                "checkpointConnection": "internal",
                "checkpointConnectionList": [
                    "internal",
                    "test_connection"
                ],
                "checkpointDefaultMaxRetryCount": 3,
                "checkpointDefaultRetryInterval": 60,
                "serviceRetryInterval": 60,
                "serviceHeartbeatMonitortimeout": 600
            }
        }
    }
}
エラーケース

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

HTTPステータスコード エラーコード 説明
400 Bad Request 2101 Jsonデータの値が正しくなかった場合
2102 Jsonデータの必須項目が入力されなかった場合
2103 Jsonデータの値のタイプが正しくなかった場合
403 Forbidden 3001 ログインしていなかった場合
500 Internal Server Error 5001 設定ファイルの読み込みに失敗した場合
5002 設定ファイルの書き込みに失敗した場合
5003 設定ファイルの解析に失敗した場合

▲ このページのトップへ

機能名: server/get

説明

サーバーのIDと名前を取得します。

権限

administrator、developer、operator

リクエスト
HTTPメソッド リクエストURL
GET http://{Hostname}:{Port}/mcapi/flowservice/server/get
リクエストパラメーター
なし
リクエスト例
GET /mcapi/flowservice/server/get HTTP/1.1
X-As-SessionId: 76B7EDBB1F14443FA538E62E05C5EEA4
レスポンス
HTTPステータスコード

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

実行結果

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

{
    "result": {
        "status": "success",
        "data": {
            "server": {
                "id": "fa81528b-bab0-49a5-9a07-a63783e1c9e5",
                "name": "test"
            }
        }
    }
}
エラーケース

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

HTTPステータスコード エラーコード 説明
403 Forbidden 3001 ログインしていなかった場合
500 Internal Server Error 5101 内部の通信に失敗した場合
5102 サーバー内部にエラーが発生した場合
5106 フローサービスが起動していなかった場合

▲ このページのトップへ

機能名: server/name/set

説明

サーバーの名前を変更します。

権限

administrator

リクエスト
HTTPメソッド リクエストURL
POST http://{Hostname}:{Port}/mcapi/flowservice/server/name/set
リクエストパラメーター
パラメーター 必須 説明
name はい サーバー名を指定します。
リクエスト例

POST /mcapi/flowservice/server/name/set HTTP/1.1
Content-Type: application/x-www-form-urlencoded; charset=UTF-8
X-As-SessionId: 76B7EDBB1F14443FA538E62E05C5EEA4
Content-Length: 12

name=newName
レスポンス
HTTPステータスコード

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

実行結果

実行に成功するとサーバーの情報が返ります。

{
    "result": {
        "status": "success",
        "data": {
            "server": {
                "id": "fa81528b-bab0-49a5-9a07-a63783e1c9e5",
                "name": "newName"
            }
        }
    }
}
エラーケース

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

HTTPステータスコード エラーコード 説明
400 Bad Request 2002 パラメーター name の値が設定されなかった場合
403 Forbidden 3001 ログインしていなかった場合
500 Internal Server Error 5101 内部の通信に失敗した場合
5102 サーバー内部にエラーが発生した場合
5106 フローサービスが起動していなかった場合

▲ このページのトップへ