モジュール名: ftpservice

機能名	説明
configuration/get	FTPサービスの設定情報を取得します
configuration/set	FTPサービスの設定情報を変更します

機能名: configuration/get

説明

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

権限

administrator、developer、operator

リクエスト

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

リクエストパラメーター

なし

リクエスト例

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

レスポンス

HTTPステータスコード

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

実行結果

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

待ち受けポート番号（port）
アクティブモードデータ接続ポート番号（activeModePort）
パッシブモードデータ接続ポートの設定（passiveModePortAutomaticSpecification）
「自動割り当て」の場合は「true」、「範囲設定」の場合は「false」
「範囲設定」の場合のみ次の「パッシブモードデータ接続ポートの下限」と「パッシブモードデータ接続ポートの上限」が取得できます
パッシブモードデータ接続ポートの下限（passiveModePortMin）
パッシブモードデータ接続ポートの上限（passiveModePortMax）
アイドルタイムアウト（idleTimeOut）
最大接続数（maxConnectionCount）
ログイン時のデフォルトドメイン名（defaultDomainName）
Anonymousログイン（anonymousLoginEnable）
匿名でのログインを許可する場合は「true」、許可しない場合は「false」
許可する場合のみ次の「Anonymousホームフォルダー」と「最大Anonymousログイン数」が取得できます
Anonymousホームフォルダー（anonymousHomeDirectory）
最大Anonymousログイン数（maxAnonymousConnectionCount）
仮想ルートフォルダー（virtualRootDirectory）

{
    "result": {
        "status": "success",
        "data": {
            "configuration": {
                "port": 21,
                "activeModePort": 20,
                "passiveModePortAutomaticSpecification": false,
                "passiveModePortMin": 1025,
                "passiveModePortMax": 65535,
                "idleTimeOut": 300,
                "maxConnectionCount": 100,
                "defaultDomainName": "/",
                "anonymousLoginEnable": true,
                "anonymousHomeDirectory": "home/anonftp",
                "maxAnonymousConnectionCount": 10,
                "virtualRootDirectory": ""
            }
        }
    }
}

エラーケース

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

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

▲ このページのトップへ

機能名: configuration/set

説明

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

権限

administrator