10.1.9　コマンド文生成（V02-40以降）

ユーザーファイルの操作を実行するコマンド文を生成できます。

ユーザーファイル一覧画面で，［その他の操作］から［コマンド文生成］ボタンをクリックします。起動する以下のダイアログに必要な情報を入力し，［生成とJSONファイルのダウンロード］ボタンをクリックすると，選択した操作のコマンド文の生成と，リクエストボディとなるJSONファイルのテンプレートをダウンロードできます。

生成されたコマンド文をコピーしてリクエストボディ（JSONファイル）などを編集し，クライアント端末からJSONファイルを指定してコマンドを実行することで選択した操作ができます。コマンド文を実行すると，サービスポータルに対してREST APIでの通信が発生するため，通信ができるように事前にポートの許可設定などを実施してください。

なお，REST API発行時の認証のために，リクエストヘッダーに「x-jp1cs-portal-auth」を付与し，値として「ポータルのユーザーID:パスワードをBase64エンコードで符号化した文字列」を指定してください。このリクエストヘッダーは，コマンド文中にテンプレートとして埋め込まれています。ユーザーID・パスワードを指定しなかった場合や誤っていた場合，またはパスワードの有効期限が切れている場合，認証が必要なことを示すステータスコード「401」が返却されます。

システム負荷の軽減のため，複数の操作コマンドを同時に実行しないでください。

注意事項

コマンド文を生成して操作する場合，閉域の環境（AWS Transit Gatewayなどによりサービスと接続されているネットワーク）から接続して操作を行ってください。インターネット経由での操作はできませんのでご注意ください。

項目	説明	指定要否
操作種別	操作種別を選択します。サポートされる操作種別だけが表示されます。 種別 一覧表示（一覧取得） アップロード ダウンロード 削除 ディレクトリ作成	必須
コマンド実行先ホストのOS	LinuxかWindowsから選択します。	必須

各操作種別のコマンド文について，リクエスト時のパラメーターやレスポンスボディの形式などを以下に示します。

なお，URIで使用できない文字を指定する場合，URLエンコードが必要です。文字コードは，UTF-8を使用してください。

操作種別	説明
一覧表示（一覧取得）	クエリパラメーターの形式を以下に示します。 targethost_id 操作対象のマネージャーホスト名を指定します。このマネージャーホストに紐づくユーザーファイルに対して操作が行われます。 dir_path 一覧表示（一覧取得）するディレクトリのパスを指定します。/usrfileからの相対パス（ドット(.)から始まる文字列）をエンコードして指定します。 ＜使用禁止文字＞ 制御文字および " ' ` $ ” ’ ‘ < > | : * ? \ レスポンスボディの形式を※1に示します。 レスポンスで返却する主なステータスコードを※2に示します。
アップロード	JSONファイルとして指定するリクエストボディの形式を※3に示します。 アップロードするファイルはバイナリファイル（file）として指定しますが，コンマ（,）やセミコロン（;），環境依存文字を含んだファイルは指定できません。 なお，システムにアップロードされるときのファイル名は，リクエストボディ中に指定する名前（name）になります。 レスポンスで返却する主なステータスコードを※4に示します。
ダウンロード	クエリパラメーターの形式を以下に示します。 targethost_id 操作対象のマネージャーホスト名を指定します。このマネージャーホストに紐づくユーザーファイルに対して操作が行われます。 name ダウンロード対象のファイル名をエンコードして指定します。 dir_path ダウンロード対象のファイルが格納されているディレクトリのパスを指定します。/usrfileからの相対パス（ドット(.)から始まる文字列）をエンコードして指定します。 ＜使用禁止文字＞ 制御文字および " ' ` $ ” ’ ‘ < > | : * ? \ ダウンロードしたファイルの内容はレスポンスボディとして標準出力に出力されます。このため，出力先となるファイル名を指定して実行してください。 レスポンスで返却する主なステータスコードを※5に示します。
削除	リクエストボディの形式を※6に示します。 レスポンスで返却する主なステータスコードを※7に示します。
ディレクトリ作成	リクエストボディの形式を※8に示します。 レスポンスで返却する主なステータスコードを※9に示します。

注※1

レスポンスボディの形式を以下に示します。

項目	説明
{	−
"userfiles" : [ {	−
"id" : ファイルID,	ファイルID（文字列）が設定されます。
"name" : 名前,	ユーザーファイル名（文字列）が設定されます。
"dir_path" : ディレクトリ階層,	ファイルが格納されているディレクトリのパス（文字列）が設定されます。/usrfileからの相対パス（ドット(.)から始まる文字列）が設定されます。
"type" : 種別,	種別（文字列）が設定されます。 識別子（値）の意味を次に示します。 f：ファイル d：ディレクトリ
"last_modified" : 最終更新日時,	最終更新日時（yyyy-MM-dd'T'hh:mm:ss'Z'のISO8601拡張形式）が設定されます。
"size" : サイズ,	サイズ（数値，単位：バイト）が設定されます。ファイルの種別がディレクトリの場合はnullが設定されます。
"owner" : 所有者,	所有者の種類（文字列）が設定されます。 識別子（値）の意味を次に示します。 exec：実行ユーザー other：その他
"mode" : 所有者権限,	所有者権限（数値）が設定されます。読み取り・書き込み・実行権限の有無を10進数表記したときの値が設定されます。
"processing" : ステータス	操作中かどうかがtrueまたはfalseで設定されます。
}, ... ]	応答ユーザーファイル数分だけ繰り返されます。対象となるユーザーファイルが存在しない場合，空配列となります。
}	−

注※2

レスポンスで返却する主なステータスコードを以下に示します。

ステータスコード	説明
200	成功しました。
400	リクエスト内容が不正です（KBDC10028-E，KBDC10101-E）。
401	認証情報が無効です（KBDC20102-E，KBDC10104-E）。
403	権限がありません（KBDC10028-E，KBDC10020-E）。
404	対象が存在しません（KBDC10028-E，KBDC10020-E）。
503	メンテナンス中です（KBDC13016-E，KBDC13017-E）。

注※3

JSONファイルとして指定するリクエストボディの形式を以下に示します。

項目	説明
{	−
"userfile" : {	−
"name" : 名前,	ユーザーファイル名（文字列）を指定します。
"dir_path" : ディレクトリ階層,	ファイルを格納するディレクトリのパス（文字列）を指定します。/usrfileからの相対パス（ドット(.)から始まる文字列）を指定します。 ＜使用禁止文字＞ 制御文字および " ' ` $ ” ’ ‘ < > | : * ? \
"mode" : 所有者権限,	所有者権限（数値）を指定します。読み取り・書き込み・実行権限の有無を10進数表記したときの値を指定します。
"overwrite" : 上書き可否,	同名のファイルが存在した場合に上書きするかどうかをtrueまたはfalseで指定します。false指定のときに同名のファイルが存在した場合，重複エラーを示すステータスコード「412」が返却されます。
"targethost_id" : 操作対象マネージャーホスト名	操作対象のマネージャーホスト名（文字列）を指定します。このマネージャーホストに紐づくユーザーファイルに対して操作が行われます。
}	−
}	−

注※4

レスポンスで返却する主なステータスコードを以下に示します。

ステータスコード	説明
202	成功しました。タスクIDを返却します。
400	リクエスト内容が不正です（KBDC10028-E，KBDC10101-E）。
401	認証情報が無効です（KBDC20102-E，KBDC10104-E）。
403	権限がありません（KBDC10028-E，KBDC10020-E）。
404	対象が存在しません（KBDC10028-E，KBDC10020-E，KBDC13033-E，KBDC13028-E）。
409	操作中です（KBDC10501-W，KBDC13025-E）。
412	ファイル名が重複しています（KBDC13033-E，KBDC13027-E，KBDC13031-E）。
413	ファイルサイズが上限を超えています（KBDC13033-E，KBDC13013-E）。
503	メンテナンス中です（KBDC13016-E，KBDC13017-E）。

注※5

レスポンスで返却する主なステータスコードを以下に示します。

ステータスコード	説明
200	成功しました。
400	リクエスト内容が不正です（KBDC10028-E，KBDC10101-E）。
401	認証情報が無効です（KBDC20102-E，KBDC10104-E）。
403	権限がありません（KBDC10028-E，KBDC10020-E）。
404	対象が存在しません（KBDC10028-E，KBDC10020-E，KBDC13034-E，KBDC13028-E）。
409	他のダウンロード操作を実行中です（KBDC10501-W，KBDC13025-E）。
413	ファイルサイズが上限を超えています（KBDC13034-E，KBDC13013-E）。
422	サポート対象外のファイルがあります（KBDC13012-E，KBDC13032-E）。
503	メンテナンス中です（KBDC13016-E，KBDC13017-E）。

注※6

リクエリパラメーターの形式を以下に示します。

項目	説明
{	−
"userfile" : {	−
"name" : 名前,	ユーザーファイル名（文字列）を指定します。
"dir_path" : ディレクトリ階層,	ファイルが格納されているディレクトリのパス（文字列）を指定します。/usrfileからの相対パス（ドット(.)から始まる文字列）を指定します。 ＜使用禁止文字＞ 制御文字および " ' ` $ ” ’ ‘ < > | : * ? \
"type" : 種別,	種別（文字列）が設定されます。 識別子（値）の意味を次に示します。 f：ファイル d：ディレクトリ
"targethost_id" : 操作対象マネージャーホスト名	操作対象のマネージャーホスト名（文字列）を指定します。このマネージャーホストに紐づくユーザーファイルに対して操作が行われます。
}, ... ]	要求ユーザーファイル数分だけ繰り返して指定してください。
}	−

注※7

レスポンスで返却する主なステータスコードを以下に示します。

ステータスコード	説明
202	成功しました。タスクIDを返却します。
400	リクエスト内容が不正です（KBDC10028-E，KBDC10101-E）。
401	認証情報が無効です（KBDC20102-E，KBDC10104-E）。
403	権限がありません（KBDC10028-E，KBDC10020-E）。
404	対象が存在しません（KBDC10028-E，KBDC10020-E，KBDC13020-E，KBDC13028-E）。
409	操作中です（KBDC10501-W，KBDC13025-E）。
503	メンテナンス中です（KBDC13016-E，KBDC13017-E）。

注※8

リクエストボディの形式を以下に示します。

項目	説明
{	−
"userfile" : {	−
"name" : 名前,	ユーザーファイル名（文字列）を指定します。
"dir_path" : ディレクトリ階層,	作成先となるディレクトリのパス（文字列）を指定します。/usrfileからの相対パス（ドット(.)から始まる文字列）を指定します。 ＜使用禁止文字＞ 制御文字および " ' ` $ ” ’ ‘ < > | : * ? \
"mode" : 所有者権限,	所有者権限（数値）を指定します。読み取り・書き込み・実行権限の有無を10進数表記したときの値を指定します。
"targethost_id" : 操作対象マネージャーホスト名	操作対象のマネージャーホスト名（文字列）を指定します。このマネージャーホストに紐づく専用ストレージに対して操作が行われます。
}
}

注※9

レスポンスで返却する主なステータスコードを以下に示します。

ステータスコード	説明
202	成功しました。タスクIDを返却します。
400	リクエスト内容が不正です（KBDC10028-E，KBDC10101-E，KBDC13019-E，KBDC80152-E）。
401	認証情報が無効です（KBDC20102-E，KBDC10104-E）。
403	権限がありません（KBDC10028-E，KBDC10020-E）。
404	対象が存在しません（KBDC10028-E，KBDC10020-E，KBDC13019-E，KBDC13028-E）。
409	操作中です（KBDC10501-W，KBDC13025-E）。
412	ディレクトリ名が重複しています（KBDC13019-E，KBDC13031-E）。
503	メンテナンス中です（KBDC13016-E，KBDC13017-E）。

ページの先頭へ