モジュール名: maintenance

機能名 説明
list バックアップファイルの一覧を取得します
show バックアップファイルの詳細情報を取得します
backup バックアップします
restore バックアップファイルからリストアします
delete バックアップファイルを削除します
upload バックアップファイルをアップロードします
download バックアップファイルをダウンロードします

機能名: list

説明

バックアップの一覧を取得します。

権限

administrator、developer、operator

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

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

実行結果

実行に成功するとバックアップの一覧が返ります。
バックアップの情報としては次の情報が取得できます。 

{
    "result": {
        "status": "success",
        "data": {
            "backup": [
                {
                    "time": "2013-01-01 13:13:01",
                    "fileName": "backup-20130101-131301.zip",
                    "comment": "backup test",
                    "fileSize": 91626
                },
                {
                    "time": "2013-01-02 13:13:01",
                    "fileName": "backup-20130101-131301.zip",
                    "comment": "backup test2",
                    "fileSize": 91626
                }
            ]
        }
    }
}
エラーケース

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

エラーコード HTTPステータスコード 説明
403 Forbidden 3001 ログインしていなかった場合
500 Internal Server Error 5001 設定ファイルの読み込みに失敗した場合
5003 設定ファイルの解析に失敗した場合
5005 ZIPファイルのフォーマットが正しくなかった場合
5008 フォルダーを作成した時にエラーが発生した場合

▲ このページのトップへ

機能名: show

説明

バックアップの詳細情報を取得します。

権限

administrator、developer、operator

リクエスト
HTTPメソッド リクエストURL
GET http://{Hostname}:{Port}/mcapi/maintenance/show
リクエストパラメーター
パラメーター 必須 説明
fileName はい リストアするバックアップのファイル名を指定します。
リクエスト例
GET /mcapi/maintenance/show?fileName=backup-2013-01-01-13.13.01.zip HTTP/1.1
X-As-SessionId: 76B7EDBB1F14443FA538E62E05C5EEA4
レスポンス
HTTPステータスコード

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

実行結果

実行に成功するとバックアップの一覧が返ります。
バックアップの情報としては次の情報が取得できます。 

{
    "result": {
        "status": "success",
        "data": {
            "backup": {
                "time": "2013-01-01 13:13:01",
                "fileName": "backup-20130101-131301",
                "comment": "backup test",
                "fileSize": 91626
            }
        }
    }
}
エラーケース

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

エラーコード HTTPステータスコード 説明
400 Bad Request 2001 パラメーター fileName の値が正しくなかった場合
2002 パラメーター fileName の値が設定されていなかった場合
403 Forbidden 3001 ログインしていなかった場合
404 Not Found 4008 パラメーター fileName で指定したファイルが存在しなかった場合
500 Internal Server Error 5001 設定ファイルの読み込みに失敗した場合
5003 設定ファイルの解析に失敗した場合
5005 ZIPファイルのフォーマットが正しくなかった場合
5008 フォルダーを作成した時にエラーが発生した場合

▲ このページのトップへ

機能名: backup

説明

バックアップします。

権限

administrator、operator

リクエスト
HTTPメソッド リクエストURL
POST http://{Hostname}:{Port}/mcapi/maintenance/backup
リクエストパラメーター
なし
リクエスト例
POST /mcapi/maintenance/backup HTTP/1.1
Content-Type: application/x-www-form-urlencoded; charset=UTF-8
X-As-SessionId: 76B7EDBB1F14443FA538E62E05C5EEA4
Content-Length: 36

{
    "backup": {
        "comment": "backup test"
    }
}
レスポンス
HTTPステータスコード

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

実行結果

実行に成功するとバックアップします。

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

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

エラーコード HTTPステータスコード 説明
400 Bad Request 2102 Jsonデーターの必須項目が入力されなかった場合
403 Forbidden 3001 ログインしていなかった場合
500 Internal Server Error 5001 設定ファイルの読み込みに失敗した場合
5002 設定ファイルの書き込みに失敗した場合
5003 設定ファイルの解析に失敗した場合
5005 ZIPファイルのフォーマットが正しくなかった場合
5006 ファイルをZIPした時にエラーが発生した場合
5008 フォルダーを作成した時にエラーが発生した場合

▲ このページのトップへ

機能名: restore

説明

バックアップの情報をリストアします。

権限

administrator

リクエスト
HTTPメソッド リクエストURL
POST http://{Hostname}:{Port}/mcapi/maintenance/restore
リクエストパラメーター
パラメーター 必須 説明
fileName はい リストアするバックアップのファイル名を指定します。

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

fileName=backup-20130101-131301.zip
レスポンス
HTTPステータスコード

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

実行結果

実行に成功するとバックアップ情報をリストアします。

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

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

エラーコード HTTPステータスコード 説明
400 Bad Request 2001 パラメーター fileName の値が正しくなかった場合
2002 パラメーター fileName の値が設定されていなかった場合
2601 サービスが起動していた場合
403 Forbidden 3001 ログインしていなかった場合
404 Not Found 4008 パラメーター fileName で指定したファイルが存在しなかった場合
500 Internal Server Error 5001 設定ファイルの読み込みに失敗した場合
5003 設定ファイルの解析に失敗した場合
5007 ファイルをUNZIPした時にエラーが発生した場合
5008 フォルダーを作成した時にエラーが発生した場合

▲ このページのトップへ

機能名: delete

説明

バックアップの情報を削除します。

権限

administrator

リクエスト
HTTPメソッド リクエストURL
POST http://{Hostname}:{Port}/mcapi/maintenance/delete
リクエストパラメーター
パラメーター 必須 説明
fileName はい 削除するバックアップのファイル名を指定します。

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

fileName=backup-20130101-131301.zip
レスポンス
HTTPステータスコード

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

実行結果

実行に成功するとバックアップ情報を削除します。

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

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

エラーコード HTTPステータスコード 説明
400 Bad Request 2001 パラメーター fileName の値が正しくなかった場合
2002 パラメーター fileName の値が設定されていなかった場合
403 Forbidden 3001 ログインしていなかった場合
404 Not Found 4008 パラメーター fileName で指定したファイルが存在しなかった場合
500 Internal Server Error 5008 フォルダーを作成した時にエラーが発生した場合

▲ このページのトップへ

機能名: upload

説明

バックアップファイルをアップロードします。

権限

administrator

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

HTMLでファイルをアップロードするときに送信されるmultipart/form-data形式と同じ形式のデータをPOSTします。
ただし、バックアップファイルの名前を変更してアップロードするとエラーとなります。
アップロードファイル情報として、次の情報をリクエストのボディに設定します。

POST /mcapi/maintenance/upload HTTP/1.1
Content-Type: multipart/form-data; boundary=---------------------------120912416424652; charset=UTF-8
X-As-SessionId: 76B7EDBB1F14443FA538E62E05C5EEA4
Content-Length: 333

-----------------------------120912416424652 
Content-Disposition: form-data; name="filedata"; filename="backup-20130101-131301.zip" 
Content-Type: application/zip

[リクエストのデータとしてzipファイルがバイナリ形式で付加されます]
-----------------------------120912416424652--
レスポンス
HTTPステータスコード

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

実行結果

実行に成功するとバックアップファイルをアップロードします。

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

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

エラーコード HTTPステータスコード 説明
400 Bad Request 2202 リクエストからファイル名を取得できなかった場合
2203 リクエストからファイルデーターを取得できなかった場合
2205 バックアップファイルの名前が正しくなかった場合
2301 リクエストデーターの解析でエラーが発生した場合
403 Forbidden 3001 ログインしていなかった場合
500 Internal Server Error 5002 ファイルの書き込みでエラーが発生した場合

▲ このページのトップへ

機能名: download

説明

バックアップの情報を取得します。

権限

administrator、operator

リクエスト
HTTPメソッド リクエストURL
POST http://{Hostname}:{Port}/mcapi/maintenance/download
リクエストパラメーター
パラメーター 必須 説明
fileName はい 取得するバックアップのファイル名を指定します。

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

fileName=backup-20130101-131301.zip
レスポンス
HTTPステータスコード

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

実行結果

実行に成功するとバックアップファイルのzipが返ります。

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

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

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

エラーコード HTTPステータスコード 説明
400 Bad Request 2001 パラメーター fileName の値が正しくなかった場合
2002 パラメーター fileName の値が設定されていなかった場合
403 Forbidden 3001 ログインしていなかった場合
404 Not Found 4008 パラメーター fileName で指定したファイルが存在しなかった場合
500 Internal Server Error 5001 ファイルの読み込みに失敗した場合
5008 フォルダーを作成した時にエラーが発生した場合

▲ このページのトップへ