モジュール名: log

機能名 説明
path/get 各種ログの出力フォルダ名を取得します
path/set 各種ログの出力フォルダを変更します
system/show ログの内容を取得します
system/file/list ログのファイルリストを取得します
system/file/download ログファイルをダウンロードします
system/file/delete ログを削除します
system/schedule/get ログ削除のスケジュールを取得します
system/schedule/set ログ削除のスケジュールを設定します
system/level/get 各種ログの出力レベルを取得します
system/level/set 各種ログの出力レベルを変更します
application/show アプリケーションログの内容を取得します
application/file/list アプリケーションログのファイル一覧を取得します
application/file/download アプリケーションログのファイルをダウンロードします
application/file/delete アプリケーションログのファイルを削除します
application/configuration/list アプリケーションログの設定一覧を取得します
application/configuration/get アプリケーションログの設定情報を取得します
application/configuration/create アプリケーションログの設定情報を追加します
application/configuration/update アプリケーションログの設定情報を変更します
application/configuration/delete アプリケーションログの設定情報を削除します

機能名: path/get

説明

各種ログの出力フォルダ名を取得します。

権限

administrator、developer、operator

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

なし

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

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

実行結果

実行に成功すると各種ログの出力フォルダ名が返ります。

{
    "result": {
        "status": "success",
        "data": {
            "path": "./log"
        }
    }
}
エラーケース

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

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

▲ このページのトップへ

機能名: path/set

説明

各種ログの出力フォルダを変更します。

権限

administrator

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

パラメーター 必須 説明
path はい 各種ログの出力フォルダを指定します。
[INSTALL_DIR]/flow からの相対パスか、絶対パスで設定します

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

path=./newpath
レスポンス
HTTPステータスコード

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

実行結果

実行に成功すると各種ログの出力フォルダを変更します。

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

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

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

▲ このページのトップへ

機能名: system/show

説明

ログの内容を取得します。

権限

administrator、developer、operator

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

パラメーター 必須 説明
type はい 取得するログのタイプを指定します。
  • asteria
  • asteria-console
  • FlowCompile
  • FlowAccess
  • FlowService
  • FtpService
  • api
  • api-access
date いいえ 取得するログの日付をyyyy-MM-ddの形式で指定します。
指定しなかった場合はシステム日付となります。
startTime いいえ 取得するログの開始時刻をHH:mm:ssの形式で指定します。
指定しなかった場合は「00:00:00」となります。
endTime いいえ 取得するログの終了時刻をHH:mm:ssの形式で指定します。
指定しなかった場合は「23:59:59」となります。
level いいえ 取得するログの出力レベルを指定します。
  • fatal - 致命的エラー
  • error - エラー
  • warn - 警告
  • info - 情報
  • debug - デバッグ
指定しなかった場合は「info」となります。
keyword いいえ ログの内容を検索する場合、キーワードを指定します。
キーワードを複数指定する場合、スペースで区切ります。
isAnd いいえ 指定されたキーワードのAND・OR条件を指定します。
「AND」の場合は「true」、「OR」の場合は「false」。
指定しなかった場合は「AND」となります。
pageSize いいえ ログの取得行数を指定します。
指定しなかった場合は1000件となります。
pageNumber いいえ 取得するログのページを指定します。
指定しなかった場合は１ページ目となります。
order いいえ 取得するログの表示順を指定します。
  • asc - 時刻の昇順で表示する（日時の古いログが先頭になります）
  • desc - 時刻の降順で表示する（日時の新しいログが先頭になります）
指定しなかった場合は「desc」となります。

リクエスト例
GET /mcapi/log/system/show?type=FlowService&date=2013-01-01&startTime=10:00:00&pageCount=500&order=asc&keyword=scheduler HTTP/1.1
X-As-SessionId: 76B7EDBB1F14443FA538E62E05C5EEA4
レスポンス
HTTPステータスコード

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

実行結果

実行に成功するとログのファイルリストが返ります。
ログの内容としては次の情報が取得できます。 

{
    "result": {
        "status": "success",
        "data": {
        	"maxPageNumber": 3,
            "log": [
                {
                    "row": 1,
                    "dateTime": "2013-01-01T13:13:01.002 JST",
                    "level": "info",
                    "catagory": "scheduler",
                    "thread": "Scheduler,Scheduler.Engine.worker.1",
                    "message": "SCH_I_0003: スケジュールを実行します: b3863934ff6a4d448531cc5881029f3c"
                },
                {
                    "row": 2,
                    "dateTime": "2013-01-01T13:13:02.002 JST",
                    "level": "info",
                    "catagory": "scheduler",
                    "thread": "Scheduler,Scheduler.Engine.worker.1",
                    "message": "SCH_I_0003: スケジュールを実行します: b3863934ff6a4d448531cc5881029f3c"
                }
            ]
        }
    }
}
エラーケース

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

HTTPステータスコード エラーコード 説明
400 Bad Request 2001 パラメーター type, date, startTime, endTime, level, order の値が正しくなかった場合
2002 パラメーター type の値が設定されなかった場合
2003 パラメーターの値のデータ型が正しくなかった場合
403 Forbidden 2001 ログインしていなかった場合
404 Not Found 2007 指定したログが存在しなかった場合
500 Internal Server Error 5001 ファイルの読み込みに失敗した場合
5003 ファイルの解析に失敗した場合
5501 ログの検索でエラーが発生した場合

▲ このページのトップへ

機能名: system/file/list

説明

ログのファイルリストを取得します。

権限

administrator、operator

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

パラメーター 必須 説明
type いいえ 取得するログのタイプを指定します。
  • asteria
  • asteria-console
  • FlowCompile
  • FlowAccess
  • FlowService
  • FtpService
  • api
  • api-access
指定しなかった場合はすべてのログのファイルリストを取得します。

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

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

実行結果

実行に成功するとログのファイルリストが返ります。

{
    "result": {
        "status": "success",
        "data": {
            "FlowService": [
                "FlowService.log",
                "FlowService.log.2013-01-01",
                "FlowService.log.2013-01-02"
            ],
            "FtpService": [
                "FTPService.log"
            ]
        }
    }
}
エラーケース

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

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

▲ このページのトップへ

機能名: system/file/download

説明

ログファイルをダウンロードします。

権限

administrator、developer、operator

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

パラメーター 必須 説明
type いいえ ダウンロードするログのタイプを指定します。
指定しなかった場合はすべてのタイプのログファイルをダウンロードします。
date いいえ ダウンロードするログの日付（yyyy-MM-dd）を指定します。
指定しなかった場合はすべての日付のログファイルをダウンロードします。

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

type=FlowService&date=2013-01-01
レスポンス
HTTPステータスコード

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

実行結果

実行に成功するとログファイルのzipが返ります。

HTTP/1.1 200 OK
Content-Type: application/zip
Content-Length: 44556
Content-Disposition: filename="log.zip"

[レスポンスのボディとしてzipファイルがバイナリ形式で付加されます]
エラーケース

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

エラーコード HTTPステータスコード 説明
400 Bad Request 2001 パラメーター type の値が正しくなかった場合
2306 日付 date の解析にエラーが発生した場合
403 Forbidden 3001 ログインしていなかった場合
404 Not Found 2007 指定したログが存在しなかった場合
500 Internal Server Error 5001 ファイルの読み込みに失敗した場合
5003 ファイルの解析に失敗した場合
5006 ファイルをZIPした時にエラーが発生した場合

▲ このページのトップへ

機能名: system/file/delete

説明

ログを削除します。

権限

administrator、operator

リクエスト
HTTPメソッド リクエストURL
POST http://{Hostname}:{Port}/mcapi/log/system/file/delete
リクエストパラメーター
パラメーター 必須 説明
type いいえ 削除するログのタイプを指定します。
指定しなかった場合はすべてのログを削除します。
date いいえ 指定した日付までのログを削除します（指定した日付は含まれません）。
指定しなかった場合は前日までのログを削除します。

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

type=FlowService&date=2013-01-01
レスポンス
HTTPステータスコード

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

実行結果

実行に成功するとログを削除します。

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

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

エラーコード HTTPステータスコード 説明
400 Bad Request 2001 パラメーター type の値が正しくなかった場合
2306 日付 date の解析にエラーが発生した場合
403 Forbidden 3001 ログインしていなかった場合
500 Internal Server Error 5001 ファイルの読み込みに失敗した場合
5003 ファイルの解析に失敗した場合

▲ このページのトップへ

機能名: system/schedule/get

説明

ログ削除のスケジュールを取得します。

権限

administrator、operator

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

なし

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

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

実行結果

実行に成功するとログ削除のスケジュールが返ります。
ログ削除のスケジュールの情報としては次の情報が取得できます。 

{
    "result": {
        "status": "success",
        "data": {
            "schedule": {
                "type": "none"
            }
        }
    }
}

{
    "result": {
        "status": "success",
        "data": {
            "schedule": {
                "type": "daily",
                "retentionPeriod": 56,
                "checkpoint": true,
                "checkpointRetentionPeriod": 30,
                "hour": 15,
                "minute": 15
            }
        }
    }
}

{
    "result": {
        "status": "success",
        "data": {
            "schedule": {
                "type": "weekly",
                "daysOfWeek": [
                    "Wednesday",
                    "Thursday"
                ],
                "retentionPeriod": 56,
                "checkpoint": true,
                "checkpointRetentionPeriod": 30,
                "hour": 15,
                "minute": 15
            }
        }
    }
}

{
    "result": {
        "status": "success",
        "data": {
            "schedule": {
                "type": "monthly",
                "executeDate": [
                    13,
                    24,
                    27
                ],
                "retentionPeriod": 56,
                "checkpoint": true,
                "checkpointRetentionPeriod": 30,
                "hour": 15,
                "minute": 15
            }
        }
    }
}
エラーケース

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

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

▲ このページのトップへ

機能名: system/schedule/set

説明

ログ削除のスケジュールを設定します。

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

リクエスト例
設定する情報は、schedule/getで取得できる形式の情報と同じ形式でリクエストのボディに設定します。 
POST /mcapi/log/system/schedule/set HTTP/1.1
Content-Type: application/json; charset=UTF-8
X-As-SessionId: 76B7EDBB1F14443FA538E62E05C5EEA4
Content-Length: 118

{
    "schedule": {
        "type": "monthly",
        "retentionPeriod": 30,
        "checkpoint": false,
        "executeTime": 2330,
        "executeDate": [
            1,
            2,
            3,
            30,
            31
        ]
    }
}
レスポンス
HTTPステータスコード

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

実行結果

実行に成功するとログ削除のスケジュールを設定します。

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

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

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

▲ このページのトップへ

機能名: system/level/get

説明

各種ログの出力レベルを取得します。

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

なし

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

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

実行結果

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

{
    "result": {
        "status": "success",
        "data": {
            "level": {
            	"asteria": "info",
            	"flowservice": "warn",
            	"api": "info"
            }
        }
    }
}
エラーケース

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

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

▲ このページのトップへ

機能名: system/level/set

説明

各種ログの出力レベル情報を変更します。

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

リクエスト例
設定する情報は、system/level/getで取得できる形式の情報と同じ形式でリクエストのボディに設定します。
項目が存在しない場合は更新されません。 
POST /mcapi/log/system/level/set HTTP/1.1
Content-Type: application/json; charset=UTF-8
X-As-SessionId: 76B7EDBB1F14443FA538E62E05C5EEA4
Content-Length: 49

{
    "level": {
        "asteria": "info"
    }
}
レスポンス
HTTPステータスコード

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

実行結果

実行に成功すると各種ログの出力レベル情報を変更します。

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

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

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

▲ このページのトップへ

機能名: application/show

説明

アプリケーションログの内容を取得します。

権限

administrator、developer、operator

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

パラメーター 必須 説明
applicationLogName はい 取得するアプリケーションログの名前を指定します。
fileName いいえ 取得するアプリケーションログのファイル名を指定します。
指定しなかった場合は最新ファイルを取得します。
date いいえ 取得するログの日付を指定します。
startTime いいえ 取得するログの開始時刻を指定します。
dateが指定されている場合のみ有効です。
endTime いいえ 取得するログの終了時刻を指定します。
dateが指定されている場合のみ有効です。
level いいえ 取得するログの出力レベルを指定します。
  • fatal - 致命的エラー
  • error - エラー
  • warn - 警告
  • info - 情報
  • debug - デバッグ
指定しなかった場合は「info」となります。
keyword いいえ ログの内容を検索する場合、キーワードを指定します。
キーワードを複数指定する場合、スペースで区切ります。
isAnd いいえ 指定されたキーワードのAND・OR条件を指定します。
「AND」の場合は「true」、「OR」の場合は「false」。
指定しなかった場合は「AND」となります。
pageSize いいえ ログの取得行数を指定します。
指定しなかった場合は1000行となります。
pageNumber いいえ 取得するログのページを指定します。
指定しなかった場合は１ページ目となります。
order いいえ 取得するログの表示順を指定します。
  • asc - 時刻の昇順で表示する（日時の古いログが先頭になります）
  • desc - 時刻の降順で表示する（日時の新しいログが先頭になります）
指定しなかった場合は「desc」となります。

リクエスト例
GET /mcapi/log/application/show?applicationLogName=test1&failName=test1.log&level=debug&count=500 HTTP/1.1
X-As-SessionId: 76B7EDBB1F14443FA538E62E05C5EEA4
レスポンス
HTTPステータスコード

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

実行結果

実行に成功するとアプリケーションログの設定一覧が返ります。
アプリケーションログの内容としては次の情報が取得できます。 

{
    "result": {
        "status": "success",
        "data": {
            "maxPageNumber": 1,
            "test1": [
                {
                    "row": 2,
                    "time": "10:00:01",
                    "level": "info",
                    "catagory": "scheduler",
                    "thread": "Scheduler,Scheduler.Engine.worker.1",
                    "message": "SCH_I_0003: スケジュールを実行します: b3863934ff6a4d448531cc5881029f3c"
                },
                {
                    "row": 1,
                    "time": "10:03:01",
                    "level": "info",
                    "catagory": "scheduler",
                    "thread": "Scheduler,Scheduler.Engine.worker.1",
                    "message": "SCH_I_0003: スケジュールを実行します: b3863934ff6a4d448531cc5881029f3c"
                }
            ]
        }
    }
}
エラーケース

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

エラーコード HTTPステータスコード 説明
400 Bad Request 2001 パラメーター date, startTime, endTime, level, order の値が正しくなかった場合
2002 パラメーター applicationLogName の値が設定されなかった場合
2003 パラメーターの値のデータ型が正しくなかった場合
403 Forbidden 2001 ログインしていなかった場合
404 Not Found 2007 指定したログが存在しなかった場合
500 Internal Server Error 5001 ファイルの読み込みに失敗した場合
5003 ファイルの解析に失敗した場合
5501 ログの検索でエラーが発生した場合

▲ このページのトップへ

機能名: application/file/list

説明

アプリケーションログのファイル一覧を取得します。

権限

administrator、developer、operator

リクエスト
HTTPメソッド リクエストURL
GET http://{Hostname}:{Port}/mcapi/log/application/file/list
リクエストパラメーター
パラメーター 必須 説明
applicationLogName いいえ 取得するアプリケーションログのログ設定名を指定します。
指定しなかった場合はすべてのアプリケーションログを取得します。
リクエスト例
GET /mcapi/log/application/file/list HTTP/1.1
X-As-SessionId: 76B7EDBB1F14443FA538E62E05C5EEA4
レスポンス
HTTPステータスコード

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

実行結果

実行に成功するとアプリケーションログのファイル一覧が返ります。

{
    "result": {
        "status": "success",
        "data": {
            "test1": [
                "test1.log",
                "test1.log.001"
            ],
            "test2": [
                "test2.log"
            ]
        }
    }
}
エラーケース

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

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

▲ このページのトップへ

機能名: application/file/download

説明

アプリケーションログファイルをダウンロードします。

権限

administrator、developer、operator

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

パラメーター 必須 説明
fileName いいえ ダウンロードするアプリケーションログのファイル名を指定します。
指定しなかった場合、「applicationLogName」で指定したアプリケーションログのすべてのファイルをダウンロードします。
applicationLogName いいえ ダウンロードするアプリケーションログのログ設定名を指定します。
指定しなかった場合はすべてのアプリケーションログをダウンロードします。
「fileName」を指定した場合、「applicationLogName」の値にかかわらず、「fileName」で指定したファイルをダウンロードします。

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

fileName=app1.log.2013-01-01
レスポンス
HTTPステータスコード

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

実行結果

実行に成功するとログファイルのzipが返ります。

HTTP/1.1 200 OK
Content-Type: application/zip
Content-Length: 44556
Content-Disposition: filename="log.zip"

[レスポンスのボディとしてzipファイルがバイナリ形式で付加されます]
エラーケース

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

エラーコード HTTPステータスコード 説明
403 Forbidden 3001 ログインしていなかった場合
404 Not Found 4015 指定したログが存在しなかった場合
500 Internal Server Error 5001 ファイルの読み込みに失敗した場合
5003 ファイルの解析に失敗した場合
5006 ファイルをZIPした時にエラーが発生した場合

▲ このページのトップへ

機能名: application/file/delete

説明

アプリケーションログファイルを削除します。

権限

administrator、operator

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

パラメーター 必須 説明
fileName いいえ 削除するアプリケーションログのファイル名を指定します。
指定しなかった場合、「applicationLogName」で指定したアプリケーションログのすべてのファイルを削除します。
applicationLogName いいえ 削除するアプリケーションログのログ設定名を指定します。
指定しなかった場合はすべてのアプリケーションログを削除します。
「fileName」を指定した場合、「applicationLogName」の値にかかわらず、「fileName」で指定したファイルを削除します。

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

applicationLogName=app1
レスポンス
HTTPステータスコード

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

実行結果

実行に成功すると指定したログファイルを削除します。

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

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

エラーコード HTTPステータスコード 説明
403 Forbidden 3001 ログインしていなかった場合
404 Not Found 4015 指定したログが存在しなかった場合
500 Internal Server Error 5001 ファイルの読み込みに失敗した場合

▲ このページのトップへ

機能名: application/configuration/list

説明

アプリケーションログの設定一覧を取得します。

権限

administrator、developer、operator

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

なし

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

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

実行結果

実行に成功するとアプリケーションログの設定一覧が返ります。
アプリケーションログの設定情報としては次の情報が取得できます。 

{
    "result": {
        "status": "success",
        "data": {
            "configuration": [
                {
                    "name": "test1",
                    "type": "date",
                    "fileName": "./log/application/test1.log"
                },
                {
                    "name": "test2",
                    "type": "size",
                    "fileName": "./log/application/test2.log"
                }
            ]
        }
    }
}
エラーケース

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

エラーコード HTTPステータスコード 説明
403 Forbidden 2001 ログインしていなかった場合

▲ このページのトップへ

機能名: application/configuration/get

説明

アプリケーションログの設定情報を取得します。

権限

administrator、developer、operator

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

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

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

実行結果

実行に成功するとアプリケーションログの設定情報が返ります。
アプリケーションログの設定情報としては次の情報が取得できます。

サブカテゴリの情報としては次の情報が取得できます。 

{
    "result": {
        "status": "success",
        "data": {
            "configuration": {
                "name": "test2",
                "type": "size",
                "fileSize": 2,
                "fileNumber": 5,
                "level": "info",
                "subCatagory": [
                    {
                        "name": "catagory1",
                        "level": "debug"
                    },
                    {
                        "name": "catagory2",
                        "level": "error"
                    }
                ]
            }
        }
    }
}
エラーケース

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

エラーコード HTTPステータスコード 説明
403 Forbidden 2001 ログインしていなかった場合
404 Not Found 2007 指定したログが存在しなかった場合

▲ このページのトップへ

機能名: application/configuration/create

説明

アプリケーションログの設定情報を追加します。

権限

administrator、developer

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

リクエスト例
設定する情報は、configuration/getで取得できる形式の情報と同じ形式でリクエストのボディに設定します。
サブカテゴリ以外は全部必須です。 
POST /mcapi/log/application/configuration/create HTTP/1.1
Content-Type: application/json; charset=UTF-8
X-As-SessionId: 76B7EDBB1F14443FA538E62E05C5EEA4
Content-Length: 181

{
    "configuration": {
        "name": "test3",
        "type": "size",
        "fileSize": 2,
        "fileNumber": 5,
        "level": "info",
        "subCatagory": [
            {
                "name": "catagory1",
                "level": "debug"
            },
            {
                "name": "catagory2",
                "level": "error"
            }
        ]
    }
}
レスポンス
HTTPステータスコード

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

実行結果

実行に成功すると各種ログのアプリケーションログの設定情報を変更します。

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

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

エラーコード HTTPステータスコード 説明
400 Bad Request 2102 Jsonデータの必須項目が入力されなかった場合
2103 Jsonデータの値のタイプが正しくなかった場合
2904 同じ名前のアプリケーションログが既に存在していた場合
403 Forbidden 3001 ログインしていなかった場合
500 Internal Server Error 5002 ファイルの書き込みに失敗した場合

▲ このページのトップへ

機能名: application/configuration/update

説明

アプリケーションログの設定情報を変更します。

権限

administrator、developer

リクエスト
HTTPメソッド リクエストURL
POST http://{Hostname}:{Port}/mcapi/log/application/configuration/update
リクエストパラメーター
パラメーター 必須 説明
name はい 変更する情報のログ設定名を指定します。

リクエスト例
設定する情報は、application/configuration/getで取得できる形式の情報と同じ形式でリクエストのボディに設定します。
項目が存在しない場合は更新されません。
サブカテゴリの情報があった場合、既存のサブカテゴリ情報をすべて置き換えます。
ログ設定名を変更することはできません。 
POST /mcapi/log/application/configuration/update?name=test2 HTTP/1.1
Content-Type: application/json; charset=UTF-8
X-As-SessionId: 76B7EDBB1F14443FA538E62E05C5EEA4
Content-Length: 181

{
    "configuration": {
        "type": "size",
        "fileSize": 2,
        "fileNumber": 5,
        "level": "info",
        "subCatagory": [
            {
                "name": "catagory1",
                "level": "debug"
            },
            {
                "name": "catagory2",
                "level": "error"
            }
        ]
    }
}
レスポンス
HTTPステータスコード

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

実行結果

実行に成功すると各種ログのアプリケーションログの設定情報を変更します。

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

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

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

▲ このページのトップへ

機能名: application/configuration/delete

説明

アプリケーションログの設定情報を削除します。

権限

administrator、developer

リクエスト
HTTPメソッド リクエストURL
POST http://{Hostname}:{Port}/mcapi/log/application/configuration/delete
リクエストパラメーター
パラメーター 必須 説明
name はい 削除する情報のログ設定名を指定します。

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

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

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

実行結果

実行に成功すると各種ログのアプリケーションログの設定情報を削除します。

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

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

エラーコード HTTPステータスコード 説明
403 Forbidden 3001 ログインしていなかった場合
404 Not Found 2007 指定したログが存在しなかった場合
500 Internal Server Error 5002 ファイルの書き込みに失敗した場合

▲ このページのトップへ