モジュール名: sftpservice

機能名 説明
configuration/get SFTPサービスの設定情報を取得します
configuration/set SFTPサービスの設定情報を変更します
serverkey/set SFTPサービス用のホストキーをアップロードします

機能名: configuration/get

説明

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

権限

administrator、developer、operator

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

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

実行結果

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

{
    "result": {
        "status": "success",
        "data": {
            "configuration": {
                "port": 22,
                "idleTimeOut": 300,
                "maxConnectionCount": 100,
                "defaultDomainName": "/",
                "serverKeyFingerprint": "SHA256:GaRDH77tZjuiuUhmaxUoFM5ccjIswCh4LeJ0zoToG4Y",
                "authId": true,
                "authPk": true,
                "authType": "password and public key"
            }
        }
    }
}
エラーケース

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

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

▲ このページのトップへ

機能名: configuration/set

説明

SFTPサービスの設定情報を変更します。

権限

administrator

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

getConfiguraionで取得できる結果と同じ形式のデータをHTTPボディに設定します。
認証タイプ(authType)、サーバーホストキーのフィンガープリント(serverKeyFingerprint)は指定しません。
指定されていない値は更新されません。

POST /mcapi/sftpservice/configuration/set HTTP/1.1
Content-Type: application/json; charset=UTF-8
X-As-SessionId: 76B7EDBB1F14443FA538E62E05C5EEA4
Content-Length: 205

{
    "configuration": {
        "port": 22,
        "idleTimeOut": 300,
        "maxConnectionCount": 100,
        "defaultDomainName": "/",
        "authId": true,
        "authPk": true
    }
}
レスポンス
HTTPステータスコード

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

実行結果

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

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

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

HTTPステータスコード エラーコード 説明
400 Bad Request 2002 パラメーターの値が設定されなかった場合
2102 Jsonデータの必須項目が入力されなかった場合
2303 Content-Typeが誤っている場合
403 Forbidden 3001 ログインしていなかった場合
500 Internal Server Error 5001 設定ファイルの読み込みに失敗した場合
5002 設定ファイルの書き込みに失敗した場合
5003 設定ファイルの解析に失敗した場合
5201 指定したプロセス情報が存在しなかった場合
5202 プロセス情報が存在しなかった場合
5205 プロセス情報の解析に失敗した場合

▲ このページのトップへ

機能名: serverkey/set

説明

SFTPサーバーのホストキーをアップロードします。

権限

administrator

リクエスト
HTTPメソッド リクエストURL
POST http://{Hostname}:{Port}/mcapi/sftpservice/serverkey/set
リクエストパラメーター
パラメーター 必須 説明
serverKey はい SFTPサーバーのホストキーを指定します
serverKeyPassphrase はい serverKeyでアップロードするホストキーのパスフレーズを指定します。
リクエスト例

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

POST /mcapi/sftpservice/configuration/set HTTP/1.1
X-As-SessionId: 76B7EDBB1F14443FA538E62E05C5EEA4
Content-Length: 334
Content-Type: multipart/form-data; boundary=----120912416424652

----120912416424652
Content-Disposition: form-data; name="serverKey"; filename="sftp.key"
Content-Type: text/plain

[The file will be appended in binary form as the data of the request]
----120912416424652
Content-Disposition: form-data; name="serverKeyPassphrase"

sftppw
----120912416424652
レスポンス
HTTPステータスコード

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

実行結果

実行に成功するとSFTPサーバーのホストキーが格納されます。

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

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

HTTPステータスコード エラーコード 説明
400 Bad Request 2002 パラメーターの値が設定されなかった場合
2003 パラメーターの値が正しくなかった場合
2201 ホストキーを保存できなかった場合
2202 リクエストからファイル名を取得できなかった場合
2203 リクエストからファイルデータを取得できなかった場合
2301 リクエストデータの解析でエラーが発生した場合
403 Forbidden 3001 ログインしていなかった場合
500 Internal Server Error 5002 ホストキーの読み込み/書き込みに失敗した場合。または、パスフレーズが間違っていた場合。

▲ このページのトップへ