モジュール名: service

機能名 説明
list サービスの一覧を取得します
show サービスの基本情報を取得します
configuration/get サービスの設定情報を取得します
configuration/set サービスの設定情報を更新します
autostart/set サービスの起動方法を更新します
start サービスを起動します
stop サービスを停止します
kill サービスを強制終了します
gc サービスをガベージコレクションします
info/list サービスの情報を取得します

機能名: list

説明

サービスの一覧を取得します。

権限

administrator、developer、operator

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

なし

リクエスト例
GET /mcapi/service/list HTTP/1.1
X-As-SessionId: 76B7EDBB1F14443FA538E62E05C5EEA4
レスポンス
HTTPステータスコード

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

実行結果

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

{
    "result": {
        "status": "success",
        "data": {
            "service": [
                {
                    "name": "AccessControl",
                    "autoStart": true,
                    "external": false,
                    "status": "RUNNING",
                    "moduleNo": "0101"
                },
                {
                    "name": "ManagementConsole",
                    "autoStart": true,
                    "external": true,
                    "status": "RUNNING",
                    "moduleNo": "0201"
                },
                {
                    "name": "ManagementConsoleAPI",
                    "autoStart": true,
                    "external": false,
                    "status": "RUNNING",
                    "moduleNo": "0202"
                },
                {
                    "name": "InternalDataStorage",
                    "autoStart": false,
                    "external": true,
                    "status": "STOPPED",
                    "moduleNo": "0301"
                },
                {
                    "name": "FlowService",
                    "autoStart": true,
                    "external": false,
                    "status": "RUNNING",
                    "moduleNo": "0501"
                },
                {
                    "name": "Scheduler",
                    "autoStart": false,
                    "external": false,
                    "status": "STOPPED",
                    "moduleNo": "0601"
                },
                {
                    "name": "FtpService",
                    "autoStart": false,
                    "external": false,
                    "status": "STOPPED",
                    "moduleNo": "0701"
                },
                {
                    "name": "Tomcat",
                    "autoStart": false,
                    "external": true,
                    "status": "STOPPED",
                    "moduleNo": "0801"
                }
            ]
        }
    }
}
エラーケース

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

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

▲ このページのトップへ

機能名: show

説明

サービスの基本情報を取得します。

権限

administrator、developer、operator

リクエスト
HTTPメソッド リクエストURL
GET http://{Hostname}:{Port}/mcapi/service/show
リクエストパラメーター
パラメーター 必須 説明
service はい 取得するサービスのサービス名を指定します。

リクエスト例
GET /mcapi/service/show?service=FlowService HTTP/1.1
X-As-SessionId: 76B7EDBB1F14443FA538E62E05C5EEA4
レスポンス
HTTPステータスコード

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

実行結果

実行に成功するとサービスの基本情報が返ります。
サービスの情報としては次の情報が取得できます。

{
    "result": {
        "status": "success",
        "data": {
            "service": {
            	"serviceId": "flowservice",
                "name": "FlowService",
                "autoStart": true,
                "external": false,
                "status": "RUNNING",
                "moduleNo": "0501"
            }
        }
    }
}
エラーケース

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

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

▲ このページのトップへ

機能名: configuration/get

説明

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

権限

administrator、developer、operator

リクエスト
HTTPメソッド リクエストURL
GET http://{Hostname}:{Port}/mcapi/service/configuration/get
リクエストパラメーター
パラメーター 必須 説明
service はい 取得するサービスのサービス名を指定します。

リクエスト例
GET /mcapi/service/configuration/get?service=FlowService HTTP/1.1
X-As-SessionId: 76B7EDBB1F14443FA538E62E05C5EEA4
レスポンス
HTTPステータスコード

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

実行結果

実行に成功するとサービスの設定情報が返ります。
設定情報としては次の情報が取得できます。

{
    "result": {
        "status": "success",
        "data": {
            "configuration": {
                "javaOptions": {
                    "-XX:PermSize": "64m",
                    "-server": "",
                    "-Xmx": "1024m",
                    "-XX:MaxPermSize": "128m"
                },
                "systemProperties": {
                    "java.awt.headless": "true"
                }
            },
            "defaultMaxMemory": 1000000000
        }
    }
}
エラーケース

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

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

▲ このページのトップへ

機能名: configuration/set

説明

サービスの設定情報を変更します。
設定する情報は、configuration/getで取得できる形式の設定情報と同じ形式でリクエストのボディに設定します。
デフォルト最大メモリサイズ(defaultMaxMemory)は設定できません。

権限

administrator

リクエスト
HTTPメソッド リクエストURL
POST http://{Hostname}:{Port}/mcapi/service/configuration/set
リクエストパラメーター
パラメーター 必須 説明
service はい 取得するサービスのサービス名を指定します。

リクエスト例
POST /mcapi/service/configuration/get?service=FlowService HTTP/1.1
Content-Type: application/json; charset=UTF-8
X-As-SessionId: 76B7EDBB1F14443FA538E62E05C5EEA4
Content-Length: 172

{
    "configuration": {
        "javaOptions": {
            "-XX:PermSize": "64m",
            "-server": "",
            "-Xmx": "2048m",
            "-Xms": "512m",
            "-XX:MaxPermSize": "128m"
        },
        "systemProperties": {
            "java.awt.headless": "true"
        }
    }
}
レスポンス
HTTPステータスコード

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

実行結果

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

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

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

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

▲ このページのトップへ

機能名: autostart/set

説明

サービスの起動方法を変更します。

権限

administrator

リクエスト
HTTPメソッド リクエストURL
POST http://{Hostname}:{Port}/mcapi/service/autostart/set
リクエストパラメーター
パラメーター 必須 説明
service はい サービス名を指定します。
autoStart はい 起動方法を指定します。
「自動」の場合は「true」、「手動」の場合は「false」

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

service=FlowService&autoStart=true
レスポンス
HTTPステータスコード

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

実行結果

実行に成功するとサービスの起動方法を変更します。

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

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

エラーコード HTTPステータスコード 説明
400 Bad Request 2001 パラメーター service の値が正しくなかった場合
2002 パラメーター service, autoStart の値が設定されなかった場合
403 Forbidden 3001 ログインしていなかった場合
500 Internal Server Error 5001 ファイルの読み込みでエラーが発生した場合
5002 ファイルの書き込みでエラーが発生した場合
5003 ファイルの解析でエラーが発生した場合

▲ このページのトップへ

機能名: start

説明

サービスを起動します。

権限

administrator、operator

リクエスト
HTTPメソッド リクエストURL
POST http://{Hostname}:{Port}/mcapi/service/start
リクエストパラメーター
パラメーター 必須 説明
service はい 起動するサービスのサービス名を指定します。

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

service=FlowService
レスポンス
HTTPステータスコード

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

実行結果

実行に成功するとサービスの起動を開始します。

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

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

エラーコード HTTPステータスコード 説明
400 Bad Request 2002 パラメーター service の値が設定されなかった場合
403 Forbidden 3001 ログインしていなかった場合

▲ このページのトップへ

機能名: stop

説明

サービスを停止します。

権限

administrator、operator

リクエスト
HTTPメソッド リクエストURL
POST http://{Hostname}:{Port}/mcapi/service/stop
リクエストパラメーター
パラメーター 必須 説明
service はい 停止するサービスのサービス名を指定します。

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

service=FlowService
レスポンス
HTTPステータスコード

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

実行結果

実行に成功するとサービスの停止を開始します。

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

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

エラーコード HTTPステータスコード 説明
400 Bad Request 2002 パラメーター service の値が設定されなかった場合
403 Forbidden 3001 ログインしていなかった場合

▲ このページのトップへ

機能名: kill

説明

サービスを強制終了します。

権限

administrator、operator

リクエスト
HTTPメソッド リクエストURL
POST http://{Hostname}:{Port}/mcapi/service/kill
リクエストパラメーター
パラメーター 必須 説明
service はい 強制終了するサービスのサービス名を指定します。

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

service=FlowService
レスポンス
HTTPステータスコード

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

実行結果

実行に成功するとサービスの強制終了します。

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

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

エラーコード HTTPステータスコード 説明
400 Bad Request 2002 パラメーター service の値が設定されなかった場合
403 Forbidden 3001 ログインしていなかった場合

▲ このページのトップへ

機能名: gc

説明

サービスをガベージコレクションします。

権限

administrator、operator

リクエスト
HTTPメソッド リクエストURL
POST http://{Hostname}:{Port}/mcapi/service/gc
リクエストパラメーター
パラメーター 必須 説明
service はい ガベージコレクションするサービスのサービス名を指定します。

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

service=FlowService
レスポンス
HTTPステータスコード

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

実行結果

実行に成功するとサービスのガベージコレクションを開始します。

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

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

エラーコード HTTPステータスコード 説明
400 Bad Request 2002 パラメーター service の値が設定されなかった場合
403 Forbidden 3001 ログインしていなかった場合

▲ このページのトップへ

機能名: info/list

説明

サービスの実行中のプロセス情報を取得します。

権限

administrator、developer、operator

リクエスト
HTTPメソッド リクエストURL
GET http://{Hostname}:{Port}/mcapi/service/info/list
リクエストパラメーター
パラメーター 必須 説明
service はい サービス名を指定します。

リクエスト例
GET /mcapi/service/info/list?service=FlowService HTTP/1.1
X-As-SessionId: 76B7EDBB1F14443FA538E62E05C5EEA4
レスポンス
HTTPステータスコード

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

実行結果

実行に成功すると実行中のプロセス情報が返ります。
次の情報が取得できます。

{
    "result": {
        "status": "success",
        "data": {
            "freeMemory": 91654272,
            "totalMemory": 120848384,
            "process": [
                {
                    "processName": "Admin-HTTPD",
                    "processingTimeMax": 0,
                    "processingTimeMin": 0,
                    "queueMax": 64,
                    "queueValue": 0,
                    "runCountAccepter": 0,
                    "runCountWorkerIn": 0,
                    "runCountWorkerOut": 0,
                    "workerThreadDead": 0,
                    "workerThreadMax": 32,
                    "workerThreadPool": 8,
                    "workerThreadRun": 0
                },
                {
                    "processName": "FlowService-Engine",
                    "processingTimeMax": 0,
                    "processingTimeMin": 0,
                    "queueMax": 64,
                    "queueValue": 0,
                    "runCountAccepter": 0,
                    "runCountWorkerIn": 0,
                    "runCountWorkerOut": 0,
                    "workerThreadDead": 0,
                    "workerThreadMax": 32,
                    "workerThreadPool": 32,
                    "workerThreadRun": 0
                },
                {
                    "processName": "FlowService-Engine-HighPriority",
                    "processingTimeMax": 0,
                    "processingTimeMin": 0,
                    "queueMax": 0,
                    "queueValue": 0,
                    "runCountAccepter": 0,
                    "runCountWorkerIn": 0,
                    "runCountWorkerOut": 0,
                    "workerThreadDead": 0,
                    "workerThreadMax": 32,
                    "workerThreadPool": 32,
                    "workerThreadRun": 0
                },
                {
                    "processName": "FlowService-Engine-Parallel",
                    "processingTimeMax": 0,
                    "processingTimeMin": 0,
                    "queueMax": 0,
                    "queueValue": 0,
                    "runCountAccepter": 0,
                    "runCountWorkerIn": 0,
                    "runCountWorkerOut": 0,
                    "workerThreadDead": 0,
                    "workerThreadMax": 32,
                    "workerThreadPool": 32,
                    "workerThreadRun": 0
                },
                {
                    "processName": "FlowService-HTTPD",
                    "processingTimeMax": 0,
                    "processingTimeMin": 0,
                    "queueMax": 64,
                    "queueValue": 0,
                    "runCountAccepter": 0,
                    "runCountWorkerIn": 0,
                    "runCountWorkerOut": 0,
                    "workerThreadDead": 0,
                    "workerThreadMax": 32,
                    "workerThreadPool": 8,
                    "workerThreadRun": 0
                },
                {
                    "processName": "PollingService",
                    "processingTimeMax": 0,
                    "processingTimeMin": 0,
                    "queueMax": 64,
                    "queueValue": 0,
                    "runCountAccepter": 0,
                    "runCountWorkerIn": 0,
                    "runCountWorkerOut": 0,
                    "workerThreadDead": 0,
                    "workerThreadMax": 16,
                    "workerThreadPool": 4,
                    "workerThreadRun": 0
                }
            ]
        }
    }
}
エラーケース

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

エラーコード HTTPステータスコード 説明
400 Bad Request 2001 パラメーター service の値が正しくなかった場合
2002 パラメーター service の値が設定されなかった場合
403 Forbidden 3001 ログインしていなかった場合

▲ このページのトップへ