Execuções do conector

GET

/connectors/{connectorId}/runs

const url = 'https://api-connect.zoppy.com.br/connectors/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/runs?limit=20&status=running&mode=live';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://api-connect.zoppy.com.br/connectors/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/runs?limit=20&status=running&mode=live' \
  --header 'Authorization: Bearer <token>'

Lista as execuções do conector, da mais nova para a mais antiga, com status, motivo da falha e contadores; filtra por status e mode e diz o total.

Authorizations

bearer

Parameters

Path Parameters

connectorId

required

Id do conector

string format: uuid

Id do conector

Query Parameters

before

Só execuções iniciadas antes deste instante (o next da página anterior)

string format: date-time

Só execuções iniciadas antes deste instante (o next da página anterior)

limit

Execuções por página

integer

default: 20 >= 1 <= 100

Execuções por página

status

Só execuções nesta situação

string

Allowed values: running succeeded partial failed timed_out

Só execuções nesta situação

mode

Só execuções reais (live) ou só ensaios (dry_run)

string

Allowed values: live dry_run

Só execuções reais (live) ou só ensaios (dry_run)

Responses

200

Uma página de execuções

application/json

object

runs

required

Execuções, da mais nova para a mais antiga

Array<object>

object

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

next

required

Valor de before para a próxima página; null quando acabou

string format: date-time

nullable

total

required

Quantas execuções o conector tem com os filtros de status e mode, sem contar before

integer

Example

{
  "runs": [
    {
      "trigger": "cron",
      "mode": "live",
      "rehearsalScope": "sample",
      "status": "running"
    }
  ]
}

400

Parâmetros inválidos

application/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"
  }
}

401

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

application/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"
  }
}

403

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

application/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"
  }
}

404

Conector não existe nesta loja

application/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.connector_not_found",
  "title": "Não encontramos este conector.",
  "status": 404
}

Execuções do conector

Authorizations

Parameters

Path Parameters

Query Parameters

Responses

200

Example

400

Example generated

401

Example generated

403

Example generated

404

Example

Example ^generated

Example ^generated

Example ^generated