実行中の Assembly をキャンセルする
まだ実行中の Assembly をキャンセルします。
https://api2.transloadit.com/ assemblies/ {assemblyId}Assembly をキャンセルします(アップロードがまだ進行中の場合は、アップロードもキャンセルします)。assembly_ssl_url
フィールドには、Assembly の作成時に返された一意の URL が含まれます。
API オリジンに送信されたキャンセルは、所有元のアップローダーが見つかった場合、そのアップローダーに転送されます。実行中の Assembly は ASSEMBLY_CANCELED を返し、すでに完了している Assembly はそれまでの結果を維持します。ASSEMBLY_CANCEL_UNAVAILABLE(HTTP 503)は、キャンセルの結果を確認できなかったことを意味し、キャンセルが確実に行われなかったという意味ではありません。再試行するかどうかを決める前に、Assembly のステータスを確認してください。
所有元は、Job の中止を開始した後にキャンセルの確認応答を返します。永続化、Notifications、計上処理はその後も続く場合があり、レスポンスはこれらの管理処理を待ちません。その後のステータス取得には、返された assembly_ssl_url を使用してください。永続化が完了するまでの間、API オリジンのステータスには反映の遅れが生じる場合があります。
REQUEST_ABORTED により、クライアントの通常の待機は失敗として終了しますが、処理はまだ実行中の可能性があります。そのため、明示的なキャンセルでは引き続き所有元に連絡します。終端状態のレスポンスは、すべてのワーカーが停止したことや、利用量の計上がすべて完了したことを保証するものではありません。所有元がすでに利用できない場合、中止またはキャンセルという結果には、永続化された最終スナップショットが必要です。通常のキャッシュ済みステータスでは不十分です。保持されている REQUEST_ABORTED の結果がキャンセル済みに変更されることはありません。
assembly_id を知っている人なら誰でも、このリクエストを実行できます。Assembly IDs と
assembly_ssl_url の値は機密情報として扱い、公開したり、信頼できない相手と共有したりしないでください。Assembly IDs は安全ですか? を参照してください。
リクエスト例
ASSEMBLY_ID には、パーセントエンコードせずにリソースの値を設定してください。
curl --fail-with-body -sS --request DELETE \
--url "https://api2.transloadit.com/assemblies/${ASSEMBLY_ID:?Set ASSEMBLY_ID}"
パスパラメーター
assemblyId(パスセグメント)、必須。パターン:^[a-z0-9]{32}$
任意のレスポンスクエリパラメーター
callback(JavaScript コールバック名)。JSON レスポンスを JSONP コールバックでラップします。コールバック名は^(?:_jqjsp[0-9]*|jQuery[0-9]+_[0-9]+)$に一致する必要があります。最後に指定されたものだけが使用され、空の値は無視されます。コールバック名が無効な場合は HTTP 403 が返されます。変換後のレスポンスは HTTP 200 を使用します。コールバックはレスポンスのシリアライズ後に適用されます。
リクエスト
追加のリクエストボディやフィールドは必要ありません。
レスポンス
レスポンスボディの例を以下に示します:
{
"account_id": "4ce4fb3d9d1842b6ba5d6f3ccee4b066",
"assembly_id": "7828446e5acd4aa996dce3455ec914e9",
"assembly_ssl_url": "https://api2-morven.transloadit.com/assemblies/7828446e5acd4aa996dce3455ec914e9",
"assembly_url": "http://api2-morven.transloadit.com/assemblies/7828446e5acd4aa996dce3455ec914e9",
"build_id": "339",
"bytes_expected": 486608,
"bytes_received": 486608,
"bytes_usage": 1097155,
"client_agent": null,
"client_ip": null,
"client_referer": null,
"companion_url": "https://api2-morven.transloadit.com/companion/",
"executing_jobs": [],
"execution_duration": 5.281,
"execution_start": "2020/01/09 12:02:08 GMT",
"expected_tus_uploads": 1,
"fields": {},
"finished_tus_uploads": 1,
"has_dupe_jobs": false,
"instance": "morven.transloadit.com",
"is_infinite": false,
"jobs_queue_duration": 0.01,
"last_job_completed": "2020/01/09 12:02:14 GMT",
"merged_params": "{\"steps\":{\":original\":{\"robot\":\"/upload/handle\"},\"faces_detected\":{\"use\":\":original\",\"robot\":\"/image/facedetect\",\"crop\":true,\"faces\":\"max-confidence\",\"format\":\"preserve\",\"crop_padding\":\"10%\"},\"exported\":{\"use\":[\"faces_detected\",\":original\"],\"robot\":\"/s3/store\",\"credentials\":\"demo_s3_credentials\"}},\"auth\":{\"key\":\"****\",\"expires\":\"2020-01-10T12:02:05.826Z\"}}",
"message": "The Assembly was canceled.",
"notify_duration": null,
"notify_response_code": null,
"notify_start": null,
"notify_status": null,
"notify_url": null,
"ok": "ASSEMBLY_CANCELED",
"params": "{\"steps\":{\":original\":{\"robot\":\"/upload/handle\"},\"faces_detected\":{\"use\":\":original\",\"robot\":\"/image/facedetect\",\"crop\":true,\"faces\":\"max-confidence\",\"format\":\"preserve\",\"crop_padding\":\"10%\"},\"exported\":{\"use\":[\"faces_detected\",\":original\"],\"robot\":\"/s3/store\",\"credentials\":\"demo_s3_credentials\"}},\"auth\":{\"key\":\"****\",\"expires\":\"2020-01-10T12:02:05.826Z\"}}",
"parent_assembly_status": null,
"parent_id": null,
"queue_duration": 0.184,
"results": {
":original": [
{
"basename": "joe-gardner-149699",
"cost": 97157,
"execTime": 0.81,
"ext": "jpg",
"field": "file",
"from_batch_import": false,
"id": "a30bd0776e7f4ac3817b056d102e8219",
"is_tus_file": false,
"md5hash": "fb205cb04b6998fe7ba364f70227cfa1",
"meta": {
"aspect_ratio": "1.500",
"average_color": "#b09d96",
"colorspace": "RGB",
"date_file_modified": "2020/01/09 12:02:08 GMT",
"frame_count": 1,
"has_clipping_path": false,
"has_transparency": false,
"height": 1667,
"width": 2500
},
"mime": "image/jpeg",
"name": "joe-gardner-149699.jpg",
"original_basename": "joe-gardner-149699",
"original_id": "a30bd0776e7f4ac3817b056d102e8219",
"original_md5hash": "fb205cb04b6998fe7ba364f70227cfa1",
"original_name": "joe-gardner-149699.jpg",
"original_path": "/",
"queue": "live",
"queueTime": 0.01,
"size": 485784,
"ssl_url": "https://s3.amazonaws.com/demos.transloadit.com/a3/0bd0776e7f4ac3817b056d102e8219/joe-gardner-149699.jpg",
"tus_upload_url": null,
"type": "image",
"url": "http://demos.transloadit.com.s3.amazonaws.com/a3/0bd0776e7f4ac3817b056d102e8219/joe-gardner-149699.jpg"
}
],
"faces_detected": [
{
"basename": "joe-gardner-149699",
"cost": 627606,
"execTime": 0.83,
"ext": "jpg",
"field": "file",
"from_batch_import": false,
"id": "b8d12f6c517541ca86bf50c537cedb27",
"is_tus_file": false,
"md5hash": "2a5cd917f4281b9438956e489c63dfd2",
"meta": {
"aspect_ratio": "0.739",
"average_color": "#8d654d",
"colorspace": "RGB",
"date_file_created": "2020/01/09 12:02:09 GMT",
"date_file_modified": "2020/01/09 12:02:12 GMT",
"faces": [
{
"confidence": 99.99,
"height": 840,
"width": 621,
"x1": 981,
"x2": 1550,
"y1": 121,
"y2": 891
}
],
"frame_count": 1,
"has_clipping_path": false,
"has_transparency": false,
"height": 840,
"width": 621
},
"mime": "image/jpeg",
"name": "joe-gardner-149699.jpg",
"original_basename": "joe-gardner-149699",
"original_id": "a30bd0776e7f4ac3817b056d102e8219",
"original_md5hash": "fb205cb04b6998fe7ba364f70227cfa1",
"original_name": "joe-gardner-149699.jpg",
"original_path": "/",
"queue": "live",
"queueTime": 0,
"size": 141822,
"ssl_url": "https://s3.amazonaws.com/demos.transloadit.com/b8/d12f6c517541ca86bf50c537cedb27/joe-gardner-149699.jpg",
"tus_upload_url": null,
"type": "image",
"url": "http://demos.transloadit.com.s3.amazonaws.com/b8/d12f6c517541ca86bf50c537cedb27/joe-gardner-149699.jpg"
}
]
},
"running_jobs": [],
"start_date": "2020/01/09 12:02:06 GMT",
"started_jobs": [
":original:::original",
"faces_detected:::original",
"exported:::original",
"exported::faces_detected"
],
"started_tus_uploads": 1,
"template": null,
"template_id": null,
"transloadit_client": "node-sdk:2.0.8",
"tus_url": "https://api2-morven.transloadit.com/resumable/files/",
"update_stream_url": "https://api2-morven.transloadit.com/ws20074?assembly=7828446e5acd4aa996dce3455ec914e9",
"upload_duration": 2.814,
"upload_meta_data_extracted": true,
"uploads": [
{
"basename": "joe-gardner-149699",
"ext": "jpg",
"field": "file",
"from_batch_import": false,
"id": "a30bd0776e7f4ac3817b056d102e8219",
"is_tus_file": true,
"md5hash": "fb205cb04b6998fe7ba364f70227cfa1",
"meta": {
"aspect_ratio": "1.500",
"average_color": "#b09d96",
"colorspace": "RGB",
"date_file_modified": "2020/01/09 12:02:08 GMT",
"frame_count": 1,
"has_clipping_path": false,
"has_transparency": false,
"height": 1667,
"width": 2500
},
"mime": "image/jpeg",
"name": "joe-gardner-149699.jpg",
"original_basename": "joe-gardner-149699",
"original_id": "a30bd0776e7f4ac3817b056d102e8219",
"original_md5hash": "fb205cb04b6998fe7ba364f70227cfa1",
"original_name": "joe-gardner-149699.jpg",
"original_path": "/",
"size": 485784,
"ssl_url": "https://s3.amazonaws.com/demos.transloadit.com/a3/0bd0776e7f4ac3817b056d102e8219/joe-gardner-149699.jpg",
"tus_upload_url": "https://api2-morven.transloadit.com/resumable/files/UPLOAD_ID+CAPABILITY_TOKEN",
"type": "image",
"url": "http://demos.transloadit.com.s3.amazonaws.com/a3/0bd0776e7f4ac3817b056d102e8219/joe-gardner-149699.jpg"
}
],
"uppyserver_url": "https://api2-morven.transloadit.com/companion/",
"warnings": [],
"websocket_url": "https://api2-morven.transloadit.com/ws20074"
}2xx 成功
JSON レスポンスの本文。 application/json text/plain; charset=utf-8
レスポンスボディのスキーマ
完全な JSON スキーマ
| フィールド | 型と説明 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
account_id | null | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
account_name | null | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
account_slug | null | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
api_auth_key_id | null | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
assemblyId | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
assembly_id | stringこの Assembly の一意の ID です。Assembly が作成されたときにこの ID をデータベースに保存し、受信する Notifications との照合に使用できます。 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
assembly_ssl_url | null | stringこの Assembly の現在のステータスを照会するための一意の URL で、SSL/HTTPS 経由で使用できます。 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
assembly_url | null | stringこの Assembly の現在のステータスを照会するために使用する一意の URL。 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
build_id | stringサポートによるトラブルシューティング用の、省略可能なビルド識別子です。不透明な値として扱ってください。Assemblies 間で変わる場合があります。 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bytes_expected | numberこの Assembly でアップロードされると見込まれるバイト数。 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bytes_received | numberこれまでにこの Assembly にアップロードされたバイト数です。これは主に、クライアントがアップロードの進行状況を表示するために使用します。 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bytes_usage | number | nullこの Assembly が処理したバイトのうち、利用料金の請求対象となるバイトの総数です。すべての Assemblies の | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
client_agent | null | stringアップローダーのユーザーエージェントは公開されません。この非推奨フィールドは常に | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
client_ip | null | stringアップロード元の IP アドレスは公開されません。この非推奨フィールドは常に | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
client_referer | null | stringアップローダーのリファラー URL は公開されません。この非推奨のフィールドは常に | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
companion_url | null | stringこの Assembly が通信できる Companion サーバーの URL。 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
cron_input_file_limit | integer (最小値: 1, 最大値: 1000)スケジュールされた Assembly の入力ファイル数に対する実効上限。クラッシュからの自動復旧では、保存済みの Instructions が無効になっている場合も、この上限が維持されます。通常の Assemblies では、このフィールドは省略されます。 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
executing_jobs | Array<string>配列要素のスキーマstring | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
execution_duration | number | nullTransloadit がこの Assembly の実行に要した時間(秒)。 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
execution_start | null | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
expected_tus_uploads | number | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
fields | objectUppy など、 追加プロパティのスキーマ任意の値 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
finished_tus_uploads | number | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
has_dupe_jobs | boolean | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ignored_error_count | number | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ignored_errors | Array<object>配列要素のスキーマ
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
info |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
info. | number | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
instance | null | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
is_infinite | boolean | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
jobs_queue_duration | number | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
last_job_completed | null | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
merged_params | null | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
message | stringこの Assembly の状態を説明する、人が読んで理解できるメッセージです。必ずしも含まれるとは限りません。 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
notify_duration | number | null自動再試行とその間の待機時間を含む、配信にかかった時間(秒)。 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
notify_error | null | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
notify_response_code | number | null | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
notify_response_data | null | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
notify_start | null | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
notify_status | null | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
notify_url | null | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
num_input_files | number | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
params | null | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
parent_assembly_status | 任意の値 | null次のいずれかのスキーマが適用される場合があります: 任意の値任意の値null | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
parent_id | null | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
previousStep | stringエラーに関連する前の Step の名前(取得可能な場合)。 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
queue_duration | number | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
region | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
results | objectTransloadit がこれまでに生成した結果ファイルです。各キーは、ファイルを生成した Step の名前です。ストレージ Robots はファイルを生成しないため、それらの Step 名は省略されます。 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
running_jobs | Array<string>配列要素のスキーマstring | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
start_date | stringこの Assembly のアップロードが開始された日時。 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
started_jobs | Array<string>配列要素のスキーマstring | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
started_tus_uploads | number | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
step | stringエラーに関連付けられた Step の名前(取得可能な場合)。 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
template | null | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
template_id | null | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
template_name | null | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
transloadit_client | null | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
tus_uploads | Array<object>配列要素のスキーマ
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
tus_url | stringこの Assembly が再開可能なアップロードに使用する tus サーバーの URL。 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
update_stream_url | null | stringこの Assembly のステータス更新をリアルタイムで取得できる、サーバー送信イベントストリームの URL。 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
upload_duration | numberアップローダーがファイルのアップロードに要した時間(秒)。 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
upload_meta_data_extracted | boolean | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
uploads | Array<object>この Assembly 用にアップロードされたファイルの配列です。詳細については、メタデータのドキュメントを参照してください。 配列要素のスキーマ
次のいずれかのスキーマが適用される場合があります: 必須プロパティ: basename, ext, field, id, meta, mime, name, size, type, url: object
バリアント 2: object
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
uppyserver_url | null | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
usage_tags | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
virusname | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
warnings | Array<object>配列要素のスキーマ
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
websocket_url | null | stringこの Assembly のステータス更新をリアルタイムで取得できる Websocket(Socket.IO を使用)サーバーの URL。 |
次のいずれかのスキーマが適用される場合があります:
ok: "ASSEMBLY_EXECUTING" | "ASSEMBLY_REPLAYING" | "ASSEMBLY_UPLOADING"
レスポンスには追加のフィールドが含まれる場合があります。
| フィールド | 型と説明 |
|---|---|
error | なしエラーステータスを示します。このキーは、Assembly が失敗した場合にのみ存在します。新しいエラーコードが追加されることがあります。認識できないコードは失敗として処理し、プログラムで検査できるようにその値を保持してください。 この値は禁止されています。 |
ok必須 | "ASSEMBLY_EXECUTING" | "ASSEMBLY_REPLAYING" | "ASSEMBLY_UPLOADING"エラーではないライフサイクルのステータスを示し、アップロード中、実行中、中止済み、キャンセル済みの状態が含まれます。処理の成功は |
ok: string
レスポンスには追加のフィールドが含まれる場合があります。
| フィールド | 型と説明 |
|---|---|
error | なしエラーステータスを示します。このキーは、Assembly が失敗した場合にのみ存在します。新しいエラーコードが追加されることがあります。認識できないコードは失敗として処理し、プログラムで検査できるようにその値を保持してください。 この値は禁止されています。 |
ok必須 | stringエラーではないライフサイクルのステータスを示し、アップロード中、実行中、中止済み、キャンセル済みの状態が含まれます。処理の成功は 指定可能な値 (6)
|
必須プロパティ: error
レスポンスには追加のフィールドが含まれる場合があります。
| フィールド | 型と説明 |
|---|---|
cmd | string | Array<string | number>トラブルシューティング用の処理コマンドの詳細情報です(省略可能)。診断情報の詳細は異なる場合があります。プログラムによるエラー処理には 次のいずれかのスキーマが適用される場合があります: stringArray<string | number>Array<string | number>配列要素のスキーマstring | number |
error必須 | string (最小長: 1)エラーステータスを示します。このキーは、Assembly が失敗した場合にのみ存在します。新しいエラーコードが追加されることがあります。認識できないコードは失敗として処理し、プログラムで検査できるようにその値を保持してください。 既知の値(370)。その他の値もあり得ます
|
exitCode | number | null失敗した処理コマンドの終了ステータス(省略可能)。診断の詳細は異なる場合があります。プログラムによるエラー処理には |
exitSignal | null | string処理コマンドを終了させたシグナル(省略可能)。診断の詳細は異なる場合があります。プログラムによるエラー処理には |
file | string |
headers | object追加プロパティのスキーマ任意の値 |
is_private_address | boolean |
name | string |
numRetries | number |
ok | null |
playwright_error_code | string |
reason | null | string | number | boolean | Array<任意の値> | object省略可能な診断の詳細情報です。この値が文字列であると仮定したり、そのまま表示したりしないでください。人が読めるテキストには 次のいずれかのスキーマが適用される場合があります: nullstringnumberbooleanArray<任意の値>Array<任意の値>配列要素のスキーマ任意の値objectobject追加プロパティのスキーマ任意の値 |
response_code | number | null |
retries | number |
retryable | boolean |
stderr | stringトラブルシューティング用の、処理コマンドからの診断出力です(省略可能)。診断の詳細は変わる場合があります。プログラムによるエラー処理には |
stdout | stringトラブルシューティング用の、処理コマンドからの標準出力です(省略可能)。診断情報の詳細は異なる場合があります。プログラムによるエラー処理には |
url | string |
url_host | null | string |
エラーレスポンス
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追加プロパティのスキーマ任意の値 |
HTTP 503
JSON レスポンスの本文。 application/json text/plain; charset=utf-8
レスポンスボディのスキーマ
完全な JSON スキーマ
名前付きエラーと一般的なエラー形式
error: "ASSEMBLY_CANCEL_UNAVAILABLE"
Assembly のキャンセル結果を確認できませんでした。再試行するかどうかを判断する前に、そのステータスを確認してください。
レスポンスには追加のフィールドが含まれる場合があります。
一般的なエラー形式
レスポンスの詳細については、Assembly Status レスポンスのドキュメントを参照してください。