Laufende Assembly abbrechen
Bricht eine noch laufende Assembly ab.
https://api2.transloadit.com/ assemblies/ {assemblyId}Bricht eine Assembly ab (und den Upload, falls dieser noch läuft). Das Feld assembly_ssl_url
enthält die eindeutige URL, die beim Erstellen der Assembly zurückgegeben wurde.
Eine an den API-Origin gesendete Abbruchanforderung wird an den zuständigen Uploader weitergeleitet, sofern dieser gefunden werden kann.
Eine laufende Assembly gibt ASSEMBLY_CANCELED zurück; eine bereits abgeschlossene Assembly behält ihr
bisheriges Ergebnis bei. ASSEMBLY_CANCEL_UNAVAILABLE (HTTP 503) bedeutet, dass das Ergebnis der Abbruchanforderung
nicht bestätigt werden konnte, nicht jedoch, dass der Abbruch definitiv nicht stattgefunden hat. Prüfen Sie den Assembly Status,
bevor Sie entscheiden, ob Sie es erneut versuchen.
Der zuständige Uploader bestätigt den Abbruch, nachdem er den Abbruch von Jobs eingeleitet hat. Persistierung, Notifications
und Abrechnung können danach weiterlaufen; die Antwort wartet nicht auf diese Verwaltungsarbeiten.
Verwenden Sie die zurückgegebene assembly_ssl_url für eine anschließende Statusabfrage. Der Status am API-Origin kann
hinterherhinken, während die Persistierung abgeschlossen wird.
REQUEST_ABORTED beendet das reguläre Warten des Clients ohne Erfolg, die Verarbeitung kann jedoch noch aktiv sein.
Eine explizite Abbruchanforderung kontaktiert daher weiterhin den zuständigen Uploader. Eine Antwort mit einem Endstatus
garantiert nicht, dass jeder Worker angehalten wurde oder dass die gesamte Nutzungsabrechnung abgeschlossen ist.
Wenn der zuständige Uploader nicht mehr verfügbar ist, erfordert ein Ergebnis, das eine vorzeitige Beendigung oder einen Abbruch angibt, einen endgültigen persistierten
Snapshot. Ein gewöhnlicher zwischengespeicherter Status reicht nicht aus; ein beibehaltenes REQUEST_ABORTED-Ergebnis
wird nicht nachträglich als abgebrochen gekennzeichnet.
Jeder, der die assembly_id kennt, kann diese Anfrage stellen. Behandeln Sie Assembly IDs und
assembly_ssl_url-Werte als Geheimnisse: Veröffentlichen Sie sie nicht und geben Sie sie nicht an nicht vertrauenswürdige Dritte weiter.
Siehe Sind Assembly IDs sicher?.
Anfragebeispiel
Setzen Sie ASSEMBLY_ID auf den Wert Ihrer Ressource, ohne ihn prozentzukodieren.
curl --fail-with-body -sS --request DELETE \
--url "https://api2.transloadit.com/assemblies/${ASSEMBLY_ID:?Set ASSEMBLY_ID}"
Pfadparameter
assemblyId(Pfadsegment), erforderlich. Muster:^[a-z0-9]{32}$
Optionale Query-Parameter für die Antwort
callback(JavaScript-Callback-Name). Umschließt JSON-Antworten mit einem JSONP-Callback. Der Callback-Name muss^(?:_jqjsp[0-9]*|jQuery[0-9]+_[0-9]+)$entsprechen. Nur das letzte Vorkommen wird verwendet; ein leerer Wert wird ignoriert. Ungültige Callback-Namen geben HTTP 403 zurück. Die transformierte Antwort verwendet HTTP 200. Der Callback wird nach der Serialisierung der Antwort angewendet.
Anfrage
Es sind weder ein zusätzlicher Request-Body noch weitere Felder erforderlich.
Antwort
Hier sehen Sie ein Beispiel für einen Antworttext:
{
"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-Erfolg
JSON-Response-Body. application/json text/plain; charset=utf-8
Schema des Response-Bodys
Vollständiges JSON Schema
| Feld | Typ und Beschreibung | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
account_id | null | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
account_name | null | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
account_slug | null | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
api_auth_key_id | null | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
assemblyId | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
assembly_id | stringDie eindeutige ID dieser Assembly. Sie können sie beim Erstellen einer Assembly in einer Datenbank speichern und damit eingehende Notifications zuordnen. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
assembly_ssl_url | null | stringDie eindeutige URL, über die Sie den aktuellen Status dieser Assembly abfragen können und die für die Verwendung über SSL/HTTPS vorgesehen ist. Alle API-Anfragen, die an | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
assembly_url | null | stringDie eindeutige URL, über die Sie den aktuellen Status dieser Assembly abfragen können. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
build_id | stringOptionale Build-Kennung zur Fehleranalyse durch den Support. Leiten Sie daraus keine Bedeutung ab; sie kann sich zwischen Assemblies ändern. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bytes_expected | numberDie Anzahl der Bytes, deren Upload diese Assembly erwartet. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bytes_received | numberDie Anzahl der Bytes, die bisher zu dieser Assembly hochgeladen wurden. Dieser Wert wird hauptsächlich von Clients verwendet, um den Upload-Fortschritt anzuzeigen. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bytes_usage | number | nullDie Gesamtzahl der von dieser Assembly verarbeiteten Bytes, die auf Ihre Nutzungskosten angerechnet werden. Die Summe von | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
client_agent | null | stringDer User-Agent des Uploaders wird nicht offengelegt; dieses veraltete Feld ist immer | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
client_ip | null | stringDie IP-Adresse des Uploaders wird nicht offengelegt; dieses veraltete Feld ist immer | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
client_referer | null | stringDie Referrer-URL des Uploaders wird nicht offengelegt; dieses veraltete Feld ist immer | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
companion_url | null | stringDie URL des Companion-Servers, mit dem diese Assembly gegebenenfalls kommuniziert. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
executing_jobs | Array<string>Schema eines Array-Elementsstring | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
execution_duration | number | nullDie Zeit in Sekunden, die Transloadit zum Ausführen dieser Assembly benötigt hat. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
execution_start | null | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
expected_tus_uploads | number | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
fields | objectEine Schlüssel-Wert-Zuordnung aller zusätzlichen Felder in Ihrem Formular für Integrationen, die keine Kapselung mit Schema für zusätzliche Eigenschaftenbeliebiger Wert | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
finished_tus_uploads | number | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
has_dupe_jobs | boolean | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ignored_error_count | number | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ignored_errors | Array<object>Schema eines Array-Elements
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
info |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
info. | number | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
instance | null | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
is_infinite | boolean | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
jobs_queue_duration | number | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
last_job_completed | null | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
merged_params | null | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
message | stringEine für Menschen verständliche Meldung, die den Status dieser Assembly erläutert. Sie ist nicht immer vorhanden. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
notify_duration | number | nullVerstrichene Zustellzeit in Sekunden, einschließlich automatischer Wiederholungsversuche und der Verzögerungen dazwischen. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 | beliebiger Wert | nullEines der folgenden Schemas kann gelten: beliebiger Wertbeliebiger Wertnull | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
parent_id | null | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
previousStep | stringName des vorhergehenden Steps, der mit dem Fehler zusammenhängt, sofern verfügbar. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
queue_duration | number | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
region | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
results | objectDie Ergebnisdateien, die Transloadit bisher erstellt hat. Jeder Schlüssel dieses Objekts ist der Name des Steps, der eine bestimmte Datei erstellt hat. Da Storage-Robots keine Dateien erstellen, sind die Namen ihrer Steps hier nicht enthalten. Im Fall eines Schema für zusätzliche EigenschaftenArray<object>Weitere Schemadetails finden Sie im vollständigen JSON Schema. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
running_jobs | Array<string>Schema eines Array-Elementsstring | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
start_date | stringDatum und Uhrzeit, zu denen der Upload für diese Assembly gestartet wurde. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
started_jobs | Array<string>Schema eines Array-Elementsstring | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
started_tus_uploads | number | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
step | stringName des Steps, der mit dem Fehler zusammenhängt, sofern verfügbar. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
template | null | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
template_id | null | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
template_name | null | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
transloadit_client | null | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
tus_uploads | Array<object>Schema eines Array-Elements
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
tus_url | stringDie URL des tus-Servers, den diese Assembly für fortsetzbare Uploads verwendet. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
update_stream_url | null | stringDie URL eines Server-Sent-Events-Streams, über den Sie Echtzeit-Statusaktualisierungen zu dieser Assembly erhalten können. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
upload_duration | numberDie Zeit in Sekunden, die der Uploader zum Hochladen der Dateien benötigt hat. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
upload_meta_data_extracted | boolean | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
uploads | Array<object>Ein Array der für diese Assembly hochgeladenen Dateien. Weitere Informationen finden Sie in der Metadaten-Dokumentation. Schema eines Array-Elements
Eines der folgenden Schemas kann gelten: erforderliche Eigenschaften: basename, ext, field, id, meta, mime, name, size, type, url: object
Variante 2: object
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
uppyserver_url | null | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
usage_tags | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
virusname | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
warnings | Array<object>Schema eines Array-Elements
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
websocket_url | null | stringDie URL eines Websocket-Servers (verwendet Socket.IO), von dem Sie Echtzeit-Statusaktualisierungen zu dieser Assembly erhalten können. |
Eines der folgenden Schemas kann gelten:
ok: "ASSEMBLY_EXECUTING" | "ASSEMBLY_REPLAYING" | "ASSEMBLY_UPLOADING"
Die Antwort kann zusätzliche Felder enthalten.
| Feld | Typ und Beschreibung |
|---|---|
error | nieZeigt einen Fehlerstatus an. Dieser Schlüssel ist nur vorhanden, wenn die Assembly fehlgeschlagen ist. Neue Fehlercodes können hinzugefügt werden. Behandeln Sie nicht erkannte Codes als Fehler und bewahren Sie ihre Werte für die programmgesteuerte Prüfung auf. Dieser Wert ist unzulässig. |
okerforderlich | "ASSEMBLY_EXECUTING" | "ASSEMBLY_REPLAYING" | "ASSEMBLY_UPLOADING"Zeigt einen Lebenszyklusstatus ohne Fehler an, einschließlich Hochladen, Ausführen, abgebrochener Anfragen und stornierter Assemblies. Erfolgreiche Verarbeitung wird durch |
ok: string
Die Antwort kann zusätzliche Felder enthalten.
| Feld | Typ und Beschreibung |
|---|---|
error | nieZeigt einen Fehlerstatus an. Dieser Schlüssel ist nur vorhanden, wenn die Assembly fehlgeschlagen ist. Neue Fehlercodes können hinzugefügt werden. Behandeln Sie nicht erkannte Codes als Fehler und bewahren Sie ihre Werte für die programmgesteuerte Prüfung auf. Dieser Wert ist unzulässig. |
okerforderlich | stringZeigt einen Lebenszyklusstatus ohne Fehler an, einschließlich Hochladen, Ausführen, abgebrochener Anfragen und stornierter Assemblies. Erfolgreiche Verarbeitung wird durch Zulässige Werte (6)
|
erforderliche Eigenschaften: error
Die Antwort kann zusätzliche Felder enthalten.
| Feld | Typ und Beschreibung |
|---|---|
cmd | string | Array<string | number>Optionale Details zum Verarbeitungsbefehl für die Fehlerbehebung. Diagnosedetails können variieren; verwenden Sie für die programmgesteuerte Fehlerbehandlung den Eines der folgenden Schemas kann gelten: stringArray<string | number>Array<string | number>Schema eines Array-Elementsstring | number |
errorerforderlich | string (minimale Länge: 1)Zeigt einen Fehlerstatus an. Dieser Schlüssel ist nur vorhanden, wenn die Assembly fehlgeschlagen ist. Neue Fehlercodes können hinzugefügt werden. Behandeln Sie nicht erkannte Codes als Fehler und bewahren Sie ihre Werte für die programmgesteuerte Prüfung auf. Bekannte Werte (363); andere Werte sind möglich
|
exitCode | number | nullOptionaler Exit-Status eines fehlgeschlagenen Verarbeitungsbefehls. Diagnosedetails können variieren; verwenden Sie für die programmgesteuerte Fehlerbehandlung den |
exitSignal | null | stringOptionales Signal, das einen Verarbeitungsbefehl beendet hat. Diagnosedetails können variieren; verwenden Sie für die programmgesteuerte Fehlerbehandlung den |
file | string |
headers | objectSchema für zusätzliche Eigenschaftenbeliebiger Wert |
is_private_address | boolean |
name | string |
numRetries | number |
ok | null |
playwright_error_code | string |
reason | null | string | number | boolean | Array<beliebiger Wert> | objectOptionale Diagnosedetails. Gehen Sie nicht davon aus, dass dieser Wert ein String ist, und zeigen Sie ihn nicht direkt an. Verwenden Sie für menschenlesbaren Text Eines der folgenden Schemas kann gelten: nullstringnumberbooleanArray<beliebiger Wert>Array<beliebiger Wert>Schema eines Array-Elementsbeliebiger WertobjectobjectSchema für zusätzliche Eigenschaftenbeliebiger Wert |
response_code | number | null |
retries | number |
retryable | boolean |
stderr | stringOptionale Diagnoseausgabe eines Verarbeitungsbefehls zur Fehlerbehebung. Diagnosedetails können variieren; verwenden Sie für die programmgesteuerte Fehlerbehandlung den |
stdout | stringOptionale Standardausgabe eines Verarbeitungsbefehls zur Fehlerbehebung. Diagnosedetails können variieren; verwenden Sie für die programmgesteuerte Fehlerbehandlung den |
url | string |
url_host | null | string |
Fehlerantwort
JSON-Response-Body. application/json text/plain; charset=utf-8
Schema des Response-Bodys
Vollständiges JSON Schema
Die Antwort kann zusätzliche Felder enthalten.
| Feld | Typ und Beschreibung |
|---|---|
assembly_id | string |
error | string (minimale Länge: 1) |
http_code | number | string
|
message | stringMenschenlesbare Erklärung des Fehlers. Die Formulierung kann variieren; verwenden Sie den Code |
reason | null | string | number | boolean | Array<beliebiger Wert> | objectEines der folgenden Schemas kann gelten: nullstringnumberbooleanArray<beliebiger Wert>Array<beliebiger Wert>Schema eines Array-Elementsbeliebiger WertobjectobjectSchema für zusätzliche Eigenschaftenbeliebiger Wert |
HTTP 503
JSON-Response-Body. application/json text/plain; charset=utf-8
Schema des Response-Bodys
Vollständiges JSON Schema
Benannte Fehler und das allgemeine Fehlerformat
error: "ASSEMBLY_CANCEL_UNAVAILABLE"
Das Ergebnis des Abbruchs der Assembly konnte nicht bestätigt werden. Prüfen Sie ihren Status, bevor Sie entscheiden, ob Sie es erneut versuchen.
Die Antwort kann zusätzliche Felder enthalten.
Allgemeines Fehlerformat
Weitere Informationen zur Antwort finden Sie in unserer Dokumentation zur Assembly-Status-Antwort.