Pular para o conteúdo

Detalhe da execução

GET
/connectors/{connectorId}/runs/{runId}
curl --request GET \
--url https://api-connect.zoppy.com.br/connectors/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/runs/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
--header 'Authorization: Bearer <token>'

Passos de cada fatia (chamadas, consultas ao banco local e logs) com dados pessoais mascarados, guardados 30 dias; o erro com o stack nas linhas do TypeScript; as requisições que um ensaio mandaria; as escritas feitas como leitura; os contadores.

connectorId
required

Id do conector

string format: uuid

Id do conector

runId
required

Id da execução

string format: uuid

Id da execução

A execução

Media typeapplication/json
object
id
required

Id da execução

string format: uuid
connectorId
required

Id do conector

string format: uuid
versionSeq
required

Versão do conector que rodou

integer
trigger
required

O que começou

string
Allowed values: cron manual rehearsal reprocess
mode
required

Live grava de verdade; dry_run é ensaio

string
Allowed values: live dry_run
rehearsalScope
required

Escopo do ensaio; null numa real

string
nullable
Allowed values: sample full
status
required

Situação da execução

string
Allowed values: running succeeded partial failed timed_out
failureReason
required

Por que falhou ou estourou o tempo (error, time, slices, calls, quarantine, crash…)

string
nullable
cut
required

Ensaio amostra que parou com mais a ler

boolean
slices
required

Fatias já fechadas

integer
counters
required

Contadores de ctx.count, por objeto

object
key
additional properties
object
read
required

Registros lidos da origem

integer
created
required

Registros criados no destino

integer
updated
required

Registros atualizados no destino

integer
skipped
required

Registros sem nada a mudar

integer
failed
required

Registros que falharam

integer
quarantined
required

Registros que a execução mandou para a quarentena

integer
externalWritesSent
required

Escritas que saíram de verdade para outro sistema

integer
writesHeldBack
required

Escritas de uma execução real que não saíram: guardadas para confirmação ou planejadas atrás dela

integer
cursorKept
required

Execução real com escrita que não saiu: o ponto de onde ela parou não vale, a próxima recomeça do último ponto bom

boolean
waitingWriteConfirmation
required

A primeira escrita num sistema ficou guardada e espera a confirmação de uma pessoa

boolean
writesAsReads
required

POST/PUT/PATCH/DELETE feitos como leitura (ctx.http.request)

Array<object>
object
method
required

Método HTTP da leitura que não foi GET

string
host
required

Host chamado

string
path
required

Caminho chamado, sem query

string
count
required

Quantas vezes a execução fez essa chamada

integer
blockingIssues
required

Problemas do ensaio que impedem publicar mesmo com status succeeded; connect.write_without_lookup: um POST criou registro sem consulta anterior na mesma coleção

Array<object>
object
code
required

Código estável do problema (connect.write_without_lookup)

string
message
required

O que está errado e como corrigir, em português

string
method
required

Método da chamada que causou o problema

string
host
required

Host da chamada

string
path
required

Caminho da chamada

string
count
required

Quantas vezes aconteceu na execução

integer
startedAt
required

Início

string format: date-time
finishedAt
required

Fim; null enquanto roda

string format: date-time
nullable
steps
required

Passos de todas as fatias guardadas, em ordem

Array<object>
object
at
required

Quando aconteceu

string
kind
required

Chamada HTTP, consulta ao banco local ou log

string
Allowed values: http sql log
method

Método da chamada

string
target

URL ou banco chamado, com os segredos como marcadores

string
status

Status da resposta

integer
durationMs

Duração da chamada

integer
errorCode

Código de recusa do gateway

string
nullable
request

Resumo do que foi enviado, dados pessoais mascarados

response

Resumo do que voltou, dados pessoais mascarados

message

Texto do log

string
data

Dados do log, mascarados

level

Nível do log (info, warn ou error); só nos passos de log

string
Allowed values: info warn error
agentId

Agente local que rodou a consulta; só nos passos sql, null quando não se sabe

string
nullable
stepsExpired
required

Parte dos passos já saiu do lake (guardados 30 dias)

boolean
error
required

O erro da última fatia que falhou

object
name
required
string
message
required
string
stack
required

Stack trace nas linhas do TypeScript

string
nullable
frames
required

Frames do stack que apontam para arquivos TypeScript

Array<object>
object
function
required

Função do frame

string
nullable
file
required

Arquivo TypeScript do conector

string
line
required

Linha no TypeScript

integer
column
required

Coluna no TypeScript

integer
plannedRequests
required

A requisição que eu mandaria: escritas que não saíram

Array<object>
object
at
required

Quando o código pediu a escrita

string
method
required

Método

string
url
required

URL, com segredos como marcadores

string
query
required

Parâmetros da query string

object
key
additional properties
string
headers
required

Cabeçalhos, com segredos como marcadores

object
key
additional properties
string
body
required

Corpo (resumo)

string
nullable

Example

{
"trigger": "cron",
"mode": "live",
"rehearsalScope": "sample",
"status": "running",
"steps": [
{
"kind": "http",
"level": "info"
}
]
}

Parâmetros inválidos

Media typeapplication/json
object
type
required

Código estável do erro, para máquinas (ex.: connect.connector_not_found)

string
title
required

Nome da classe do erro

string
status
required

Status HTTP

integer
detail
required

Mensagem em pt-BR, segura para mostrar a quem usa a tela

string
requestId
required

Id de correlação: passe ao suporte para achar o rastro completo

string
nullable
meta

Detalhes estruturados seguros para a tela (erros de campo, ids)

object
key
additional properties

Example generated

{
"type": "example",
"title": "example",
"status": 1,
"detail": "example",
"requestId": "example",
"meta": {
"additionalProperty": "example"
}
}

Token ausente, inválido ou expirado (connect.unauthorized)

Media typeapplication/json
object
type
required

Código estável do erro, para máquinas (ex.: connect.connector_not_found)

string
title
required

Nome da classe do erro

string
status
required

Status HTTP

integer
detail
required

Mensagem em pt-BR, segura para mostrar a quem usa a tela

string
requestId
required

Id de correlação: passe ao suporte para achar o rastro completo

string
nullable
meta

Detalhes estruturados seguros para a tela (erros de campo, ids)

object
key
additional properties

Example generated

{
"type": "example",
"title": "example",
"status": 1,
"detail": "example",
"requestId": "example",
"meta": {
"additionalProperty": "example"
}
}

Papel sem acesso ou Connect não liberado (connect.forbidden_role, connect.feature_disabled)

Media typeapplication/json
object
type
required

Código estável do erro, para máquinas (ex.: connect.connector_not_found)

string
title
required

Nome da classe do erro

string
status
required

Status HTTP

integer
detail
required

Mensagem em pt-BR, segura para mostrar a quem usa a tela

string
requestId
required

Id de correlação: passe ao suporte para achar o rastro completo

string
nullable
meta

Detalhes estruturados seguros para a tela (erros de campo, ids)

object
key
additional properties

Example generated

{
"type": "example",
"title": "example",
"status": 1,
"detail": "example",
"requestId": "example",
"meta": {
"additionalProperty": "example"
}
}

Execução não existe neste conector

Media typeapplication/json
object
type
required

Código estável do erro, para máquinas (ex.: connect.connector_not_found)

string
title
required

Nome da classe do erro

string
status
required

Status HTTP

integer
detail
required

Mensagem em pt-BR, segura para mostrar a quem usa a tela

string
requestId
required

Id de correlação: passe ao suporte para achar o rastro completo

string
nullable
meta

Detalhes estruturados seguros para a tela (erros de campo, ids)

object
key
additional properties

Example

{
"type": "connect.run_not_found",
"title": "Não encontramos esta execução.",
"status": 404
}