$fn.getPresignedUrl(path,options)

WebPerformerNXの実行環境にあるファイルマネージャに対してアクセスするための署名付きURLの発行します。[非同期]

ノート

• プレミアム実行環境のみ使用可能な関数です。
• 非同期関数であるため、コール時にawait式が必要になります。
• アクセス権を与えたいファイルのパスを指定することで、そのファイルを指定有効時間、外部からアップロード/ダウンロード/削除することができます。
  • ファイルのアップロードは、最大5GBまでとなります。
  • 有効時間に制限はありませんが、セキュリティの観点から長時間有効にする設定は推奨していません。

引数

名前	型	説明
path	string	1. 署名付きURLを発行するファイルマネージャのファイルパス 2. 下記のクエリパラメータに対応 クエリパラメータ 説明 response-content-type レスポンスヘッダのContent-typeを上書き 指定なしの場合 binary/octet-stream が設定されます response-cache-control レスポンスヘッダのCache-controlを上書き
options	object	署名付きURLの有効時間

options詳細

プロパティ	型	説明
expiresIn	number	署名付きURLの有効時間（秒） デフォルトは900
bypassAccessControl	boolean	falseの場合にフォルダへのアクセス制御の対象となります。 デフォルトはfalse

ノート

• [path]プロパティで2種類のワイルドカードを指定することができます。
  • アスタリスク(*)：0個以上の文字に一致する
  • 疑問符(?)：1つの文字に一致する
• [path]プロパティにマルチバイトや特殊記号(スペース ” # $ & ’ ( ) * + , / : ; < = > ? @ [ \ ] ^ _ { | } `)を含む場合はエンコードが必要です。
  使用可能文字や使用不可文字、使用を推奨しない文字については、Amason S3のページ を参照してください。
  • マルチバイトを含むパスの場合は、encodeURI関数でパス全体をエンコードする必要があります。
  • パスに特殊記号を含む場合、特殊記号を含む部分を個別にencodeURIComponent関数でエンコードを行い、パスを結合してください。
• [path]プロパティに指定する文字の最大バイト数は988バイトです。
• フォルダにアクセス権を与える場合は、[path]プロパティには「/フォルダ名/*」のようにフォルダ配下にアクセス権を与えるようにワイルドカードを指定してください。
  • ワイルドカードを指定して発行した署名付きURLを使用する場合は、ワイルドカードの部分はファイル名に変更してください。
• [path]プロパティにクエリパラメータを含める場合は、? はバックスラッシュでエスケープ必要になります。
• [path]プロパティにresponse-content-typeを含める場合、MIMEタイプのスラッシュがエンコードされます。発行した署名付きURLは、スラッシュに戻してから使用してください。
• キャッシュを有効化しているブラウザでファイルダウンロードを行うと、有効時間外でディスクキャッシュからダウンロードされる場合があります。クエリパラメータを使用してキャッシュを保存しないようにしてください。

戻り値

型	説明
string	署名付きURL

サンプル

// ファイルパスにクエリパラメータ（キャッシュ:保存しない、MIMEタイプ:application/pdf）指定
const path = $ui.filePath.value + "\?response-cache-control=no-store&response-content-type=application/pdf";
// 有効時間10分の署名付きURLを発行
$ui.url.value = await $fn.getPresignedUrl(path, {expiresIn:600});

ノート

署名付きURLの有効期限について
有効期限切れ時刻の直前にクライアントが大きなファイルのダウンロードを開始した場合、ダウンロード中に有効期限切れ時刻が経過してもダウンロードは完了します。
TCP接続が中断し、有効期限切れ時刻が経過した後にクライアントがダウンロードを再開した場合、ダウンロードは失敗します。

ノート

署名付きURLを使用してファイルをアップロードする手順例
curlコマンドを実行して、ファイルをアップロードする例になります。

1. [path]プロパティにアクセスしたいフォルダ配下にアクセス権を与える署名付きURLを発行する。
   例：await $fn.getPresignedUrl(‘/My_Folder/*’, {expiresIn:600});

2. 手順1で発行したURLのワイルドカード部分(*)を、ファイルマネージャにアップロードするファイル名に変更する。
   例）アップロードするファイル名をsample.jpgとする https://<ドメイン>/<オーナーID>/My_Folder/sample.jpg?Policy=・・・

3. curl コマンドを実行して、ファイルをアップロードする。
   例：curl -X PUT —upload-file C:\temp\sample.jpg “手順2で更新した署名付きURL”