Assembly を再実行する
以前の Assembly の入力と Instructions を使用して、新しい Assembly を開始します。
https://api2.transloadit.com/ assemblies/ {assemblyId}/ replayAssembly がクラッシュし、当社が入力ファイルを復元できる場合、Transloadit はその実行を再試行できます。
params に新しい notify_url パラメーターを指定すると、Assembly にすでに指定されている URL の再実行を避けることができます。
再実行する元の Assembly の Steps を上書きするには、steps パラメーターを指定してください。
新しく作成される Assembly は、元の Assembly Status オブジェクトを parent_assembly_status に埋め込みます。その assembly_url は、再実行の対象となるクラッシュした Assembly を識別します。
リクエスト例
ASSEMBLY_ID に、パーセントエンコードせずにリソースの値を設定してください。
curl が使用できるサーバー側のシェルで、適切な Bearer トークンを TRANSLOADIT_TOKEN に設定し、このリクエストを実行してください。トークンが必要な場合は、以下のセットアップを展開してください。
Bearer トークンが必要ですか?
curl と jq が使用できる信頼できるサーバー側のシェルで、TRANSLOADIT_KEY と TRANSLOADIT_SECRET にそれぞれ Auth Key と Auth Secret を設定してください。両方の認証情報と生成されるトークンを秘密に保ってください。このセットアップをブラウザーのコードで実行してはいけません。
まず、このエンドポイントで必要なスコープを持つトークンを作成してください。Auth Key には、それらのスコープがすでに付与されている必要があります。
if ! TOKEN_RESPONSE="$(curl --fail-with-body -sS \
--request POST \
--url 'https://api2.transloadit.com/token' \
--user "${TRANSLOADIT_KEY:?Set TRANSLOADIT_KEY}:${TRANSLOADIT_SECRET:?Set TRANSLOADIT_SECRET}" \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'grant_type=client_credentials' \
--data-urlencode 'aud=api2' \
--data-urlencode 'scope=assemblies:write')"; then
printf '%s\n' "$TOKEN_RESPONSE" >&2
exit 1
fi
TRANSLOADIT_TOKEN="$(printf '%s' "$TOKEN_RESPONSE" |
jq -er '.access_token | strings | select(length > 0)')" || exit 1
このシェルを開いたままにして、以下のリクエストを実行してください。トークンが有効な間は、そのトークンを再利用してください。
curl --fail-with-body -sS --request POST \
--url "https://api2.transloadit.com/assemblies/${ASSEMBLY_ID:?Set ASSEMBLY_ID}/replay" \
--header "Authorization: Bearer ${TRANSLOADIT_TOKEN:?Set TRANSLOADIT_TOKEN}" \
--data-urlencode 'params={}'
認証
このエンドポイントは、署名付きの params または Bearer トークンを受け付けます。設定手順については、認証を参照してください。
Auth Key または Bearer トークンに必要なスコープ: assemblies:write。
Signature 付きリクエストには、signature と、将来の時刻を示す params.auth.expires タイムスタンプの両方が必要です。Bearer トークンには、どちらも必要ありません。
パスパラメーター
assemblyId(パスセグメント)、必須。パターン:^[a-z0-9]{32}$
フォームフィールド
コンテンツタイプ: application/x-www-form-urlencoded
params(JSON 文字列)、必須。JSON エンコードされたオブジェクトで、サポートされるキーは以下のとおりです。signature(文字列)。署名付きリクエストでは必須です。Bearer トークンを使用する場合は、このフィールドを省略してください。
params フィールド内でサポートされるキー
この一覧の認証フィールドは、署名付きリクエストに適用されます。Bearer トークンを使用する場合は、params.auth と、それとは別の signature フィールドを省略できます。以下の認証方式ごとのリクエストパラメーターを比較してください。
完全な JSON スキーマ
params: このオブジェクトでは、一覧に記載されているフィールドのみが受け付けられます。
| フィールド | 型と説明 |
|---|---|
params.署名付きリクエストでは必須。Bearer トークンを使用する場合は任意 | Assembly Replay 用の Transloadit API キーと Signature Authentication のメタデータを含みます。
|
params.必須 | string将来の日時を示す ISO 8601 形式の有効期限タイムスタンプ。リクエストが署名されている場合、または Signature Authentication が必要な場合は必須です。Bearer 認証を使用するリクエストでは省略できます。 |
params.必須 | stringリクエストの認証に使用する Transloadit API キー |
params. | object元の Assembly フィールドに上書きマージされ、Assembly Replay で Assembly Variables として利用可能になる値。 追加プロパティのスキーマ任意の値 |
params. | string | integer各 Signature を一意にし、Signature の意図しない再利用を防ぐために、署名付きリクエストのパラメーターに含める一意のランダムな値。 |
params. | null | string再実行される Assembly の Notification URL を上書きします。値を省略した場合、または値が null または空の場合、継承された URL は上書きされません。デフォルトでは、または元の Assembly に Template がない場合、元のマージ済み Assembly Instructions の URL が、Assembly Replay のフィールドと Assembly Variables を使用して再評価されます。 |
params. | 0 | 1元の Assembly で使用された Template を取得して再解析するには、 |
params. | object | Array<参照先のスキーマ>リプレイ時の Step の上書き設定。オブジェクト形式の steps は、通常の Assembly の形式です。配列形式の steps は、従来のリプレイとの互換性のために受け付けられ、実行前に正規化されます。 次のいずれかのスキーマが適用される場合があります: objectobject追加プロパティのスキーマobject完全な Assembly Step、または Assembly Replay 用の Step の部分的なオーバーライド。Assembly Replay では、通常の Assembly の検証が実行される前に、認証情報や不足している Robot のプロパティを元の Template からマージして補えるよう、この制約を緩くしています。 Array<参照先のスキーマ>Array<参照先のスキーマ>配列要素のスキーマ完全な Assembly Step、または Assembly Replay 用の Step の部分的なオーバーライド。Assembly Replay では、通常の Assembly の検証が実行される前に、認証情報や不足している Robot のプロパティを元の Template からマージして補えるよう、この制約を緩くしています。
|
認証方式別のリクエストパラメーター
署名付き params
Auth Key を params.auth.key として含めてください。リクエストに署名する場合は、将来の時刻を示す params.auth.expires タイムスタンプを含め、Signature を別の signature フィールドで送信してください。以下のフィールド定義では、params 内のパスを使用しています。
完全な JSON スキーマ
params: このオブジェクトでは、一覧に記載されているフィールドのみが受け付けられます。
上記のフィールド定義を使用します: params.auth, params.fields, params.nonce, params.notify_url, params.reparse_template, params.steps
Bearer トークンを使用する場合
Bearer トークンを Authorization ヘッダーで送信してください。params.auth と、それとは別の signature フィールドは省略できます。他の必須パラメーターの要件は引き続き適用されます。以下のフィールド定義では、params 内のパスを使用します。
完全な JSON スキーマ
params: このオブジェクトでは、一覧に記載されているフィールドのみが受け付けられます。
上記のフィールド定義を使用します: params.fields, params.nonce, params.notify_url, params.reparse_template, params.steps
| フィールド | 型と説明 |
|---|---|
params. | Assembly Replay 用の Transloadit API キーと Signature Authentication のメタデータを含みます。
|
params. | string将来の日時を示す ISO 8601 形式の有効期限タイムスタンプ。リクエストが署名されている場合、または Signature Authentication が必要な場合は必須です。Bearer 認証を使用するリクエストでは省略できます。 |
params. | stringリクエストの認証に使用する Transloadit API キー |
レスポンス
レスポンスボディの例を以下に示します:
{
"assembly_id": "7828446e5acd4aa996dce3455ec914e9",
"assembly_ssl_url": "https://api2-example.transloadit.com/assemblies/7828446e5acd4aa996dce3455ec914e9",
"assembly_url": "http://api2.example.transloadit.com/assemblies/7828446e5acd4aa996dce3455ec914e9",
"message": "The Assembly is now in the process of being replayed.",
"notify_url": null,
"ok": "ASSEMBLY_REPLAYING",
"success": true
}2xx 成功
JSON レスポンスの本文。 application/json text/plain; charset=utf-8
レスポンスボディのスキーマ
完全な JSON スキーマ
レスポンスには追加のフィールドが含まれる場合があります。
| フィールド | 型と説明 |
|---|---|
assembly_id必須 | string |
assembly_ssl_url必須 | string |
assembly_url必須 | string |
message必須 | string |
notify_url必須 | null | string |
ok必須 | string (常に: "ASSEMBLY_REPLAYING") |
success必須 | boolean (常に: true) |
エラーレスポンス
JSON レスポンスの本文。 application/json text/plain; charset=utf-8
レスポンスボディのスキーマ
完全な JSON スキーマ
レスポンスには追加のフィールドが含まれる場合があります。
| フィールド | 型と説明 |
|---|---|
assembly_id | string |
error | string (最小長: 1) |
http_code | number | string
|
message | string人が読んで理解できる形式のエラー説明です。文言は変わる場合があるため、特定の失敗を処理する際は |
reason | null | string | number | boolean | Array<任意の値> | object次のいずれかのスキーマが適用される場合があります: nullstringnumberbooleanArray<任意の値>Array<任意の値>配列要素のスキーマ任意の値objectobject追加プロパティのスキーマ任意の値 |