モジュール名: mc

機能名 説明
configuration/get HTTP/HTTPSリスナーの設定情報を取得します
configuration/set HTTP/HTTPSリスナーの設定情報を変更します

機能名: configuration/get

説明

HTTP/HTTPSリスナーの設定情報を取得します。

権限

administrator、developer、operator

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

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

実行結果

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

{
    "result": {
        "status": "success",
        "data": {
            "configuration": {
                "threadPoolSize": 32,
                "threadMaxSize": 32,
                "requestQueueSize": 64,
                "requestQueueWarningSize": 48,
                "observationTimeOut": 300,
                "https": false,
                "loginTimeout": 30
            }
        }
    }
}
エラーケース

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

HTTPステータスコード エラーコード 説明
500 Internal Server Error 5001 設定ファイルの読み込みに失敗した場合
5003 設定ファイルの解析に失敗した場合
5201 指定したプロセス情報が存在しなかった場合
5202 プロセス情報が存在しなかった場合
5205 プロセス情報の解析に失敗した場合

▲ このページのトップへ

機能名: configuration/set

説明

HTTP/HTTPSリスナーの設定情報を変更します。

権限

administrator

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

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

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

{
    "result": {
        "status": "success",
        "data": {
            "configuration": {
                "threadPoolSize": 24,
                "threadMaxSize": 32,
                "requestQueueSize": 64,
                "requestQueueWarningSize": 48,
                "observationTimeOut": 300,
                "https": false,
                "loginTimeout": 30
            }
        }
    }
}
レスポンス
HTTPステータスコード

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

実行結果

実行に成功するとHTTP/HTTPSリスナーの設定情報を変更します。

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

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

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

▲ このページのトップへ