Cancelar uma Assembly em execução
Cancela uma Assembly que ainda está em execução.
https://api2.transloadit.com/Cancela uma Assembly (e o upload, se ele ainda estiver em andamento). O campo
assembly_ssl_url contém a URL única retornada quando a Assembly foi criada.
O cancelamento enviado à origem da API é encaminhado ao uploader responsável quando é possível encontrá-lo.
Uma Assembly em execução retorna ASSEMBLY_CANCELED; uma Assembly já finalizada mantém seu
resultado anterior. ASSEMBLY_CANCEL_UNAVAILABLE (HTTP 503) significa que não foi possível confirmar
o resultado do cancelamento, e não que o cancelamento definitivamente não ocorreu. Verifique o
Assembly Status antes de decidir se deve tentar novamente.
O responsável confirma o cancelamento após iniciar a interrupção do Job. A persistência, as Notifications
e a contabilização podem continuar depois disso; a resposta não aguarda esse trabalho de registro.
Use o assembly_ssl_url retornado para consultar o status posteriormente. O status na origem da API pode
ficar defasado enquanto a persistência é concluída.
REQUEST_ABORTED encerra sem sucesso a espera normal do cliente, mas o trabalho ainda pode estar ativo.
Por isso, um cancelamento explícito ainda entra em contato com seu responsável. Uma resposta terminal não
garante que todos os workers tenham parado nem que toda a contabilização de uso tenha sido concluída.
Se o responsável não estiver mais disponível, um resultado que indique interrupção ou cancelamento exige um
snapshot final persistido. Um status comum em cache não é suficiente; um resultado REQUEST_ABORTED retido
não é reclassificado como cancelado.
Qualquer pessoa que conheça o assembly_id pode fazer esta solicitação. Trate Assembly IDs e
valores de assembly_ssl_url como segredos: não os publique nem os compartilhe com partes não confiáveis.
Consulte Os Assembly IDs são seguros?.
Exemplo de solicitação
Defina ASSEMBLY_ID com o valor do seu recurso, sem aplicar codificação percentual a ele.
curl --fail-with-body -sS --request DELETE \
--url "https://api2.transloadit.com/assemblies/${ASSEMBLY_ID:?Set ASSEMBLY_ID}"
Parâmetros de caminho
assemblyId(segmento de caminho), obrigatório. padrão:^[a-z0-9]{32}$
Parâmetros de consulta opcionais da resposta
callback(Nome do callback JavaScript). Envolve respostas JSON em um callback JSONP. O nome do callback deve corresponder a^(?:_jqjsp[0-9]*|jQuery[0-9]+_[0-9]+)$. Apenas a última ocorrência é usada; um valor vazio é ignorado. Nomes de callback inválidos retornam HTTP 403. A resposta transformada usa HTTP 200. O callback é aplicado após a serialização da resposta.
Requisição
Nenhum corpo de requisição ou campo adicional é necessário.
Resposta
Veja um exemplo de corpo de resposta:
{
"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"
}sucesso 2xx
Corpo da resposta JSON. application/json text/plain; charset=utf-8
Esquema do corpo da resposta
Esquema JSON completo
| Campo | Tipo e descrição | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
account_id | null | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
account_name | null | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
account_slug | null | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
api_auth_key_id | null | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
assemblyId | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
assembly_id | stringO ID único desta Assembly. Você pode armazená-lo em um banco de dados quando uma Assembly é criada e usá-lo para corresponder às Notifications recebidas. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
assembly_ssl_url | null | stringA URL única usada para consultar o status atual desta Assembly, porém pronta para ser
usada por SSL/HTTPS. Todas as requisições de API enviadas para a | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
assembly_url | null | stringA URL única usada para consultar o status atual desta Assembly. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
build_id | stringIdentificador de build opcional para a solução de problemas pelo suporte. Trate-o como opaco; ele pode mudar entre Assemblies. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bytes_expected | numberO número de bytes que esta Assembly espera que sejam enviados. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bytes_received | numberO número de bytes que foram enviados para esta Assembly até agora. Isso é usado principalmente por clientes para exibir o progresso do upload. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bytes_usage | number | nullO número total de bytes que esta Assembly processou e que contam para a sua fatura de uso. A soma de | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
client_agent | null | stringO user agent de quem fez o upload não é exposto; este campo obsoleto é sempre | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
client_ip | null | stringO endereço IP de quem faz o upload não é exposto; este campo obsoleto é sempre | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
client_referer | null | stringA URL de referrer de quem enviou o arquivo não é exposta; este campo obsoleto é sempre | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
companion_url | null | stringA URL do servidor Companion com o qual esta Assembly pode se comunicar. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
executing_jobs | Array<string>Esquema do item do arraystring | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
execution_duration | number | nullO tempo que a Transloadit levou para executar esta Assembly, em segundos. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
execution_start | null | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
expected_tus_uploads | number | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
fields | objectUm mapa de chave/valor com campos de formulário adicionais para integrações que não podem usar o encapsulamento de Esquema de propriedade adicionalqualquer valor | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
finished_tus_uploads | number | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
has_dupe_jobs | boolean | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ignored_error_count | number | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ignored_errors | Array<object>Esquema do item do array
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
info |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
info. | number | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
instance | null | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
is_infinite | boolean | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
jobs_queue_duration | number | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
last_job_completed | null | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
merged_params | null | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
message | stringUma mensagem legível por humanos que explica o estado desta Assembly. Nem sempre está presente. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
notify_duration | number | nullTempo decorrido de entrega em segundos, incluindo as tentativas automáticas de reenvio e os atrasos entre elas. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 | qualquer valor | nullQualquer um dos esquemas a seguir pode ser aplicado: qualquer valorqualquer valornull | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
parent_id | null | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
previousStep | stringNome do Step anterior associado ao erro, quando disponível. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
queue_duration | number | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
region | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
results | objectOs arquivos de resultado que a Transloadit produziu até agora. Cada chave é o nome do Step que produziu um arquivo. Os Robots de armazenamento não produzem arquivos, portanto os nomes dos seus Steps são omitidos. Quando ocorre um Esquema de propriedade adicionalArray<object>Detalhes adicionais do esquema estão disponíveis no JSON Schema completo. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
running_jobs | Array<string>Esquema do item do arraystring | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
start_date | stringA data e a hora em que o upload começou para esta Assembly. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
started_jobs | Array<string>Esquema do item do arraystring | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
started_tus_uploads | number | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
step | stringNome do Step associado ao erro, quando disponível. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
template | null | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
template_id | null | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
template_name | null | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
transloadit_client | null | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
tus_uploads | Array<object>Esquema do item do array
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
tus_url | stringA URL do servidor tus usado por esta Assembly para uploads resumíveis. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
update_stream_url | null | stringA URL de um stream de server-sent events do qual você pode obter atualizações de status em tempo real desta Assembly. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
upload_duration | numberO tempo que o uploader levou para enviar os arquivos, em segundos. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
upload_meta_data_extracted | boolean | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
uploads | Array<object>Um array de arquivos enviados para esta Assembly. Para mais informações, consulte a documentação de metadados. Esquema do item do array
Qualquer um dos esquemas a seguir pode ser aplicado: propriedades obrigatórias: 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>Esquema do item do array
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
websocket_url | null | stringA URL de um servidor Websocket (usa Socket.IO) a partir do qual você pode obter atualizações de status em tempo real desta Assembly. |
Qualquer um dos esquemas a seguir pode ser aplicado:
ok: "ASSEMBLY_EXECUTING" | "ASSEMBLY_REPLAYING" | "ASSEMBLY_UPLOADING"
A resposta pode conter campos adicionais.
| Campo | Tipo e descrição |
|---|---|
error | nuncaIndica um status de erro. Esta chave só está presente se a Assembly tiver falhado. Novos códigos de erro podem ser adicionados. Trate códigos não reconhecidos como falhas e preserve seus valores para inspeção programática. Este valor é proibido. |
okobrigatório | "ASSEMBLY_EXECUTING" | "ASSEMBLY_REPLAYING" | "ASSEMBLY_UPLOADING"Indica um status de ciclo de vida sem erro, incluindo os estados de upload, execução, abortado e cancelado. O processamento bem-sucedido é indicado por |
ok: string
A resposta pode conter campos adicionais.
| Campo | Tipo e descrição |
|---|---|
error | nuncaIndica um status de erro. Esta chave só está presente se a Assembly tiver falhado. Novos códigos de erro podem ser adicionados. Trate códigos não reconhecidos como falhas e preserve seus valores para inspeção programática. Este valor é proibido. |
okobrigatório | stringIndica um status de ciclo de vida sem erro, incluindo os estados de upload, execução, abortado e cancelado. O processamento bem-sucedido é indicado por Valores permitidos (6)
|
propriedades obrigatórias: error
A resposta pode conter campos adicionais.
| Campo | Tipo e descrição |
|---|---|
cmd | string | Array<string | number>Detalhes opcionais do comando de processamento para resolução de problemas. Os detalhes de diagnóstico podem variar; use o código Qualquer um dos esquemas a seguir pode ser aplicado: stringArray<string | number>Array<string | number>Esquema do item do arraystring | number |
errorobrigatório | string (comprimento mínimo: 1)Indica um status de erro. Esta chave só está presente se a Assembly tiver falhado. Novos códigos de erro podem ser adicionados. Trate códigos não reconhecidos como falhas e preserve seus valores para inspeção programática. Valores conhecidos (364); outros valores são possíveis
|
exitCode | number | nullStatus de saída opcional de um comando de processamento que falhou. Os detalhes de diagnóstico podem variar; use o código |
exitSignal | null | stringSinal opcional que encerrou um comando de processamento. Os detalhes de diagnóstico podem variar; use o código |
file | string |
headers | objectEsquema de propriedade adicionalqualquer valor |
is_private_address | boolean |
name | string |
numRetries | number |
ok | null |
playwright_error_code | string |
reason | null | string | number | boolean | Array<qualquer valor> | objectDetalhes de diagnóstico opcionais. Não presuma que este valor seja uma string nem o exiba diretamente; use Qualquer um dos esquemas a seguir pode ser aplicado: nullstringnumberbooleanArray<qualquer valor>Array<qualquer valor>Esquema do item do arrayqualquer valorobjectobjectEsquema de propriedade adicionalqualquer valor |
response_code | number | null |
retries | number |
retryable | boolean |
stderr | stringSaída de diagnóstico opcional de um comando de processamento, para solução de problemas. Os detalhes do diagnóstico podem variar; use o código |
stdout | stringSaída padrão opcional de um comando de processamento, para solução de problemas. Os detalhes de diagnóstico podem variar; use o código |
url | string |
url_host | null | string |
Resposta de erro
Corpo da resposta JSON. application/json text/plain; charset=utf-8
Esquema do corpo da resposta
Esquema JSON completo
A resposta pode conter campos adicionais.
| Campo | Tipo e descrição |
|---|---|
assembly_id | string |
error | string (comprimento mínimo: 1) |
http_code | number | string
|
message | stringExplicação do erro legível por humanos. A redação pode variar; use o código |
reason | null | string | number | boolean | Array<qualquer valor> | objectQualquer um dos esquemas a seguir pode ser aplicado: nullstringnumberbooleanArray<qualquer valor>Array<qualquer valor>Esquema do item do arrayqualquer valorobjectobjectEsquema de propriedade adicionalqualquer valor |
HTTP 503
Corpo da resposta JSON. application/json text/plain; charset=utf-8
Esquema do corpo da resposta
Esquema JSON completo
Erros nomeados e o formato geral de erro
error: "ASSEMBLY_CANCEL_UNAVAILABLE"
Não foi possível confirmar o resultado do cancelamento da Assembly. Verifique o status dela antes de decidir se deve tentar novamente.
A resposta pode conter campos adicionais.
Formato geral de erro
Para mais informações sobre a resposta, consulte nossa documentação da resposta do Assembly Status.