モジュール名: scheduler

機能名	説明
configuration/get	スケジューラーの設定情報を取得します
configuration/set	スケジューラーの設定情報を変更します

機能名: configuration/get

スケジューラーの設定情報を取得します。

administrator、developer、operator

HTTPメソッド	リクエストURL
GET	http://{Hostname}:{Port}/mcapi/scheduler/configuration/get

パラメーター	必須	説明
process	はい	取得するプロセスの種別を指定します。 schedulerService - スケジューラーサービス schedulerEngine - スケジューラーエンジン all - すべての情報

GET /mcapi/scheduler/configuration/get HTTP/1.1
X-Fs-SessionId: 76B7EDBB1F14443FA538E62E05C5EEA4

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

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

• スレッドプールサイズ
• スレッド最大サイズ
• リクエストキューサイズ
• リクエストキュー警告サイズ
• 監視タイムアウト（秒）

{
    "result": {
        "status": "success",
        "data": {
            "configuration": {
                "schedulerService": {
                    "threadPoolSize": 1,
                    "threadMaxSize": 10,
                    "requestQueueSize": 64,
                    "requestQueueWarningSize": 48,
                    "observationTimeOut": 1000
                }
            }
        }
    }
}

{
    "result": {
        "status": "success",
        "data": {
            "configuration": {
                "schedulerEngine": {
                    "threadPoolSize": 1,
                    "threadMaxSize": 5,
                    "requestQueueSize": 64,
                    "requestQueueWarningSize": 48,
                    "observationTimeOut": 1000
                }
            }
        }
    }
}

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

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

▲ このページのトップへ

機能名: configuration/set

スケジューラーの設定情報を変更します。

administrator

HTTPメソッド	リクエストURL
POST	http://{Hostname}:{Port}/mcapi/scheduler/configuration/set

なし

configuration/getで取得できる結果と同じ形式のデータをHTTPボディに設定します。
項目が存在しない場合は更新されません。
次の例ではschedulerService（スケジューラーサービス情報）が更新されます。

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

{
    "configuration": {
        "schedulerService": {
            "threadPoolSize": 10,
            "threadMaxSize": 10,
            "requestQueueSize": 64,
            "requestQueueWarningSize": 48,
            "observationTimeOut": 1000
        }
    }
}

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

実行に成功するとスケジューラーの設定情報を変更します。

{
    "result": {
        "status": "success",
        "data": {}
    }
}

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

HTTPステータスコード	エラーコード	説明
400 Bad Request	2005	スレッド最大サイズがリクエストキューサイズより小さい場合
	2102	Jsonデータの必須項目が入力されなかった場合
	2103	Jsonデータの値のタイプが正しくなかった場合
500 Internal Server Error	5001	設定ファイルの読み込みに失敗した場合
	5002	設定ファイルの書き込みに失敗した場合
	5003	設定ファイルの解析に失敗した場合
	5201	指定したプロセス情報が存在しなかった場合
	5202	プロセス情報が存在しなかった場合
	5205	プロセス情報の解析に失敗した場合

▲ このページのトップへ