Obter estatísticas de vagas prioritárias de Job

Retorna estatísticas de vagas prioritárias de Job para uma região e um intervalo de tempo solicitados.

GEThttps://api2.transloadit.com/priority_job_slot_stats

Recupera o uso histórico de vagas prioritárias de Job para a região e o intervalo de tempo solicitados.

Para region: "all", os máximos regionais por minuto são somados para cada minuto e, em seguida, a maior soma por minuto é selecionada para cada bucket e para maxSlotCount. Os picos regionais podem ocorrer em instantes diferentes dentro do mesmo minuto, portanto esse valor pode exceder o pico simultâneo real entre regiões. O mesmo cálculo é usado por slot_count quando aggregation: "max".

Exemplo de requisição

Execute esta requisição em um shell no servidor com curl e um bearer token adequado em TRANSLOADIT_TOKEN. Se você precisar de um token, expanda a configuração abaixo.

Este exemplo também usa jq para codificar valores dinâmicos como JSON.

Precisa de um bearer token?

Em um shell confiável no servidor com curl e jq, defina TRANSLOADIT_KEY e TRANSLOADIT_SECRET com sua Auth Key e seu Auth Secret. Mantenha as duas credenciais e o token resultante em segredo; nunca execute esta configuração em código de navegador.

Primeiro, crie um token com os escopos exigidos por este endpoint. Sua Auth Key já deve conceder esses escopos.

if ! TOKEN_RESPONSE="$(curl --fail-with-body -sS \
  --request POST \
  --url 'https://api2.transloadit.com/token' \
  --user "${TRANSLOADIT_KEY:?Set TRANSLOADIT_KEY}:${TRANSLOADIT_SECRET:?Set TRANSLOADIT_SECRET}" \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data-urlencode 'grant_type=client_credentials' \
  --data-urlencode 'aud=api2' \
  --data-urlencode 'scope=queues:read')"; then
  printf '%s\n' "$TOKEN_RESPONSE" >&2
  exit 1
fi
TRANSLOADIT_TOKEN="$(printf '%s' "$TOKEN_RESPONSE" |
  jq -er '.access_token | strings | select(length > 0)')" || exit 1

Mantenha este shell aberto e execute a requisição abaixo. Reutilize o token enquanto ele continuar válido.

SINCE="$(date -u +%Y-%m-%dT00:00:00Z)"
PARAMS="$(jq -cn --arg since "${SINCE:?Set SINCE}" '{"region":"us-east-1","since":$since}')"

curl --fail-with-body -sS --request GET --get \
  --url "https://api2.transloadit.com/priority_job_slot_stats" \
  --header "Authorization: Bearer ${TRANSLOADIT_TOKEN:?Set TRANSLOADIT_TOKEN}" \
  --data-urlencode "params=$PARAMS"

Autenticação

Este endpoint aceita params assinados ou um token bearer. Consulte Autenticação para instruções de configuração.

Escopo necessário para a Auth Key ou o token bearer: queues:read.

Requisições assinadas exigem tanto uma signature quanto um timestamp params.auth.expires no futuro. Tokens Bearer não exigem nenhum dos dois.

Parâmetros de consulta

params (string JSON), obrigatório. Um objeto codificado em JSON cujas chaves suportadas estão listadas abaixo.
signature (string). Obrigatório para requisições assinadas. Omita este campo ao usar um bearer token.

Chaves compatíveis dentro do campo `params`

Os campos de autenticação desta lista se aplicam a requisições assinadas. Com um bearer token, você pode omitir params.auth e o campo signature separado. Compare os parâmetros de requisição específicos de autenticação abaixo.

Esquema JSON completo

Abrir JSON em uma nova aba

params: Somente os campos listados para este objeto são aceitos.

Campo	Tipo e descrição
`params.aggregation`	`"avg" \| "max" \| null` Seleciona o uso médio ou máximo de vagas. A omissão ou o valor null assume por padrão o uso médio.
`params.auth` obrigatório para requisições assinadas; opcional com um bearer token	`object` Contém a chave de API da Transloadit e os metadados de autenticação por assinatura para uma requisição de vagas prioritárias de Job. `params.auth`: Somente os campos listados para este objeto são aceitos.
`params.auth.expires` obrigatório	`string` Timestamp de expiração no formato ISO 8601 situado no futuro. Obrigatório quando uma requisição é assinada ou exige autenticação por assinatura; requisições autenticadas por bearer podem omiti-lo.
`params.auth.key` obrigatório	`string` Chave de API da Transloadit usada para autenticar as requisições
`params.auth.nonce`	`string \| integer` Valor único e aleatório incluído nos parâmetros da requisição assinada para tornar cada assinatura única e evitar a reutilização acidental de assinaturas.
`params.nonce`	`string \| integer` Valor único e aleatório incluído nos parâmetros da requisição assinada para tornar cada assinatura única e evitar a reutilização acidental de assinaturas.
`params.region` obrigatório	`string` (comprimento mínimo: 1) Região a incluir, ou `all` para todas as regiões.
`params.since` obrigatório	`string` (comprimento mínimo: 1) Data e hora em que a janela de estatísticas começa, no máximo 91 dias atrás. Recomenda-se ISO 8601; a API2 também preserva strings de data aceitas pelo seu parser atual. Um período de consulta mais longo é rejeitado com o erro de horário inválido do endpoint.

Parâmetros de requisição por método de autenticação

Com parâmetros assinados

Inclua sua Auth Key como params.auth.key. Ao assinar a requisição, inclua um timestamp futuro em params.auth.expires e envie a assinatura no campo separado signature. As definições de campos abaixo usam caminhos dentro de params.

Esquema JSON completo

Abrir JSON em uma nova aba

params: Somente os campos listados para este objeto são aceitos.

Usa as definições de campo acima: params.aggregation, params.auth, params.nonce, params.region, params.since

Com um token bearer

Envie o token bearer no cabeçalho Authorization. Você pode omitir params.auth e o campo signature separado. Os demais parâmetros obrigatórios continuam se aplicando. As definições de campos abaixo usam caminhos dentro de params.

Esquema JSON completo

Abrir JSON em uma nova aba

params: Somente os campos listados para este objeto são aceitos.

Usa as definições de campo acima: params.aggregation, params.nonce, params.region, params.since

Campo	Tipo e descrição
`params.auth`	`object` Contém a chave de API da Transloadit e os metadados de autenticação por assinatura para uma requisição de vagas prioritárias de Job. `params.auth`: Somente os campos listados para este objeto são aceitos.
`params.auth.expires`	`string` Timestamp de expiração no formato ISO 8601 situado no futuro. Obrigatório quando uma requisição é assinada ou exige autenticação por assinatura; requisições autenticadas por bearer podem omiti-lo.
`params.auth.key`	`string` Chave de API da Transloadit usada para autenticar as requisições
`params.auth.nonce`	`string \| integer` Valor único e aleatório incluído nos parâmetros da requisição assinada para tornar cada assinatura única e evitar a reutilização acidental de assinaturas.

Resposta

Veja um exemplo de corpo de resposta:

{
  "aggregation": "avg",
  "avgSlotCount": 2,
  "granularity": 300,
  "maxSlotCount": 4,
  "ok": "PRIORITY_JOB_SLOT_STATS_FOUND",
  "stats": [
    {
      "avg_slot_count": 2,
      "data_from_ts": 1789200000,
      "max_slot_count": 4,
      "slot_count": 2
    }
  ]
}

sucesso 2xx

Corpo da resposta JSON. application/json text/plain; charset=utf-8

Esquema do corpo da resposta

Esquema JSON completo

Abrir JSON em uma nova aba

A resposta contém apenas os campos listados para este objeto.

Campo Tipo e descrição

aggregation

obrigatório

"avg" | "max"

avgSlotCount

obrigatório

number (mínimo: 0)

granularity

obrigatório

integer (mínimo exclusivo: 0)

Duração de cada bucket de estatísticas em segundos.

maxSlotCount

obrigatório

integer (mínimo: 0)

ok

obrigatório

string (sempre: "PRIORITY_JOB_SLOT_STATS_FOUND")

stats

obrigatório

Array<object>

Esquema do item do array

object

stats[]: A resposta contém apenas os campos listados para este objeto.

Campo	Tipo e descrição
`stats[].avg_slot_count` obrigatório	`number` (mínimo: 0) Número médio de vagas ocupadas durante o intervalo.
`stats[].data_from_ts` obrigatório	`integer` (mínimo: 0) Início do bucket de estatísticas como um timestamp Unix em segundos.
`stats[].max_slot_count` obrigatório	`integer` (mínimo: 0) Uso máximo de vagas observado durante o bucket. Para `region: "all"`, esse é o maior somatório dos máximos regionais por minuto, que podem ocorrer em instantes diferentes dentro de um minuto e exceder o pico simultâneo real entre regiões.
`stats[].slot_count` obrigatório	`number` (mínimo: 0) Uso de vagas selecionado pela agregação solicitada: média ou máximo.

HTTP 400

Corpo da resposta JSON. application/json text/plain; charset=utf-8

Esquema do corpo da resposta

Esquema JSON completo

Abrir JSON em uma nova aba

Erros nomeados e o formato geral de erro

error: "PRIORITY_JOB_SLOT_STATS_INVALID_AGGREGATION"

aggregation deve ser "avg" ou "max".

A resposta pode conter campos adicionais.

Campo	Tipo e descrição
`error` obrigatório	`string` (sempre: "PRIORITY_JOB_SLOT_STATS_INVALID_AGGREGATION")
`http_code`	`number` (sempre: 400)
`message`	`string` Explicação do erro legível por humanos. A redação pode variar; use o código `error` ao tratar uma falha específica.

error: "PRIORITY_JOB_SLOT_STATS_INVALID_TIME"

O horário since está ausente ou incorreto.

A resposta pode conter campos adicionais.

Campo	Tipo e descrição
`error` obrigatório	`string` (sempre: "PRIORITY_JOB_SLOT_STATS_INVALID_TIME")
`http_code`	`number` (sempre: 400)
`message`	`string` Explicação do erro legível por humanos. A redação pode variar; use o código `error` ao tratar uma falha específica.

error: "PRIORITY_JOB_SLOT_STATS_MISSING_REGION"

É necessário informar uma region específica ou "all".

A resposta pode conter campos adicionais.

Campo	Tipo e descrição
`error` obrigatório	`string` (sempre: "PRIORITY_JOB_SLOT_STATS_MISSING_REGION")
`http_code`	`number` (sempre: 400)
`message`	`string` Explicação do erro legível por humanos. A redação pode variar; use o código `error` ao tratar uma falha específica.

Formato geral de erro

Consulte os campos gerais de resposta de erro.

HTTP 500

Corpo da resposta JSON. application/json text/plain; charset=utf-8

Esquema do corpo da resposta

Esquema JSON completo

Abrir JSON em uma nova aba

Erros nomeados e o formato geral de erro

error: "PRIORITY_JOB_SLOT_STATS_ERROR"

Não foi possível carregar as estatísticas de vagas prioritárias de Job.

A resposta pode conter campos adicionais.

Campo	Tipo e descrição
`error` obrigatório	`string` (sempre: "PRIORITY_JOB_SLOT_STATS_ERROR")
`http_code`	`number` (sempre: 500)
`message`	`string` Explicação do erro legível por humanos. A redação pode variar; use o código `error` ao tratar uma falha específica.

Formato geral de erro

Consulte os campos gerais de resposta de erro.

Resposta de erro

Corpo da resposta JSON. application/json text/plain; charset=utf-8

Esquema do corpo da resposta

Esquema JSON completo

Abrir JSON em uma nova aba

Pelo menos uma destas propriedades é obrigatória: error, message, reason

A resposta pode conter campos adicionais.

Campo	Tipo e descrição
`assembly_id`	`string`
`error`	`string` (comprimento mínimo: 1)
`http_code`	`number \| string` `number` `string` Padrão de validação (expressão regular) ^[\x09-\x0D\x20\xA0\u1680\u2000\u2001\u2002\u2003\u2004\u2005\u2006\u2007\u2008\u2009\u200a\u2028\u2029\u202f\u205f\u3000\ufeff][+-]?0(?:0(?:[^0-9]\|$)\|(?:[1-9][0-9]{0,307}\|1(?:(?:[0-6][0-9]{7}\|7[0-8][0-9]{6}\|79[0-6][0-9]{5}\|797[0-5][0-9]{4}\|7976[0-8][0-9]{3}\|79769[0-2][0-9]{2}\|7976930[0-9]{1}\|7976931[0-2])[0-9]{300}\|79769313(?:(?:[0-3][0-9]{7}\|4[0-7][0-9]{6}\|48[0-5][0-9]{5}\|486[0-1][0-9]{4}\|4862[0-2][0-9]{3}\|486230[0-9]{2}\|486231[0-4][0-9]{1}\|4862315[0-7])[0-9]{292}\|48623158(?:(?:0[0-6][0-9]{6}\|07[0-8][0-9]{5}\|079[0-2][0-9]{4}\|0793[0-6][0-9]{3}\|07937[0-1][0-9]{2}\|079372[0-7][0-9]{1}\|0793728[0-8])[0-9]{284}\|07937289(?:(?:[0-6][0-9]{7}\|70[0-9]{6}\|71[0-3][0-9]{5}\|7140[0-4][0-9]{3}\|71405[0-2][0-9]{2}\|7140530[0-2])[0-9]{276}\|71405303(?:(?:[0-3][0-9]{7}\|40[0-9]{6}\|41[0-4][0-9]{5}\|4150[0-6][0-9]{3}\|41507[0-8][0-9]{2}\|415079[0-8][0-9]{1}\|4150799[0-2])[0-9]{268}\|41507993(?:(?:[0-3][0-9]{7}\|40[0-9]{6}\|41[0-2][0-9]{5}\|413[0-1][0-9]{4}\|4132[0-6][0-9]{3}\|413270[0-9]{2})[0-9]{260}\|41327100(?:(?:[0-2][0-9]{7}\|3[0-6][0-9]{6}\|37[0-7][0-9]{5}\|378[0-1][0-9]{4}\|3782[0-5][0-9]{3}\|37826[0-8][0-9]{2}\|378269[0-2][0-9]{1}\|3782693[0-5])[0-9]{252}\|37826936(?:(?:0[0-9]{7}\|1[0-6][0-9]{6}\|17[0-2][0-9]{5}\|173[0-6][0-9]{4}\|1737[0-6][0-9]{3}\|17377[0-7][0-9]{2}\|173778[0-8][0-9]{1}\|1737789[0-7])[0-9]{244}\|17377898(?:(?:0[0-3][0-9]{6}\|04[0-3][0-9]{5}\|044[0-3][0-9]{4}\|0444[0-8][0-9]{3}\|04449[0-5][0-9]{2}\|044496[0-7][0-9]{1}\|0444968[0-1])[0-9]{236}\|04449682(?:(?:[0-8][0-9]{7}\|9[0-1][0-9]{6}\|92[0-6][0-9]{5}\|927[0-5][0-9]{4}\|9276[0-3][0-9]{3}\|92764[0-6][0-9]{2}\|927647[0-4][0-9]{1})[0-9]{228}\|92764750(?:(?:[0-8][0-9]{7}\|9[0-3][0-9]{6}\|94[0-5][0-9]{5}\|946[0-5][0-9]{4}\|9466[0-3][0-9]{3}\|94664[0-8][0-9]{2}\|94664900)[0-9]{220}\|94664901(?:(?:[0-6][0-9]{7}\|7[0-8][0-9]{6}\|79[0-6][0-9]{5}\|797[0-6][0-9]{4}\|7977[0-4][0-9]{3}\|79775[0-7][0-9]{2}\|797758[0-6][0-9]{1}\|7977587[0-1])[0-9]{212}\|79775872(?:(?:0[0-6][0-9]{6}\|070[0-8][0-9]{4}\|0709[0-5][0-9]{3}\|07096[0-2][0-9]{2}\|070963[0-2][0-9]{1})[0-9]{204}\|07096330(?:(?:[0-1][0-9]{7}\|2[0-7][0-9]{6}\|28[0-5][0-9]{5}\|286[0-3][0-9]{4}\|28640[0-9]{3}\|28641[0-5][0-9]{2}\|286416[0-5][0-9]{1}\|2864166[0-8])[0-9]{196}\|28641669(?:(?:[0-1][0-9]{7}\|2[0-7][0-9]{6}\|28[0-7][0-9]{5}\|288[0-6][0-9]{4}\|2887[0-8][0-9]{3}\|288790[0-9]{2}\|2887910[0-8])[0-9]{188}\|28879109(?:(?:[0-3][0-9]{7}\|4[0-5][0-9]{6}\|46[0-4][0-9]{5}\|465[0-4][0-9]{4}\|4655[0-4][0-9]{3}\|46555[0-4][0-9]{2}\|465555[0-3][0-9]{1}\|4655554[0-6])[0-9]{180}\|46555547(?:(?:[0-7][0-9]{7}\|8[0-4][0-9]{6}\|850[0-9]{5}\|851[0-8][0-9]{4}\|8519[0-3][0-9]{3}\|851940[0-3][0-9]{1})[0-9]{172}\|85194040(?:(?:[0-1][0-9]{7}\|2[0-5][0-9]{6}\|26[0-2][0-9]{5}\|2630[0-5][0-9]{3}\|26306[0-4][0-9]{2}\|263065[0-6][0-9]{1}\|2630657[0-3])[0-9]{164}\|26306574(?:(?:[0-7][0-9]{7}\|8[0-7][0-9]{6}\|88[0-5][0-9]{5}\|886[0-6][0-9]{4}\|88670[0-9]{3}\|88671[0-4][0-9]{2}\|8867150[0-4])[0-9]{156}\|88671505(?:(?:[0-7][0-9]{7}\|8[0-1][0-9]{6}\|820[0-5][0-9]{4}\|8206[0-7][0-9]{3}\|820680[0-9]{2}\|820681[0-8][0-9]{1})[0-9]{148}\|82068190(?:(?:[0-7][0-9]{7}\|8[0-8][0-9]{6}\|890[0-1][0-9]{4}\|8902000[0-6])[0-9]{140}\|89020007(?:(?:0[0-7][0-9]{6}\|08[0-2][0-9]{5}\|083[0-7][0-9]{4}\|0838[0-2][0-9]{3}\|08383[0-5][0-9]{2}\|083836[0-6][0-9]{1}\|0838367[0-5])[0-9]{132}\|08383676(?:(?:[0-1][0-9]{7}\|2[0-6][0-9]{6}\|27[0-2][0-9]{5}\|273[0-7][0-9]{4}\|2738[0-4][0-9]{3}\|27385[0-3][0-9]{2}\|273854[0-7][0-9]{1}\|2738548[0-3])[0-9]{124}\|27385484(?:(?:[0-4][0-9]{7}\|5[0-7][0-9]{6}\|580[0-9]{5}\|581[0-6][0-9]{4}\|5817[0-6][0-9]{3}\|581770[0-9]{2}\|5817710[0-9]{1}\|5817711[0-4])[0-9]{116}\|58177115(?:(?:[0-2][0-9]{7}\|30[0-9]{6}\|31[0-6][0-9]{5}\|317[0-5][0-9]{4}\|3176[0-3][0-9]{3}\|31764[0-3][0-9]{2}\|317644[0-6][0-9]{1}\|3176447[0-4])[0-9]{108}\|31764475(?:(?:[0-6][0-9]{7}\|7[0-2][0-9]{6}\|730[0-1][0-9]{4}\|7302[0-6][0-9]{3}\|7302700[0-5])[0-9]{100}\|73027006(?:(?:[0-8][0-9]{7}\|9[0-7][0-9]{6}\|98[0-4][0-9]{5}\|985[0-4][0-9]{4}\|9855[0-4][0-9]{3}\|98555[0-6][0-9]{2}\|9855570[0-9]{1}\|9855571[0-2])[0-9]{92}\|98555713(?:(?:[0-5][0-9]{7}\|6[0-5][0-9]{6}\|66[0-8][0-9]{5}\|669[0-4][0-9]{4}\|6695[0-8][0-9]{3}\|66959[0-5][0-9]{2}\|669596[0-1][0-9]{1}\|6695962[0-1])[0-9]{84}\|66959622(?:(?:[0-7][0-9]{7}\|8[0-3][0-9]{6}\|84[0-1][0-9]{5}\|842[0-8][0-9]{4}\|84290[0-9]{3}\|84291[0-3][0-9]{2}\|842914[0-7][0-9]{1}\|84291480)[0-9]{76}\|84291481(?:(?:[0-8][0-9]{7}\|9[0-7][0-9]{6}\|98[0-5][0-9]{5}\|9860[0-7][0-9]{3}\|98608[0-2][0-9]{2}\|986083[0-3][0-9]{1}\|9860834[0-8])[0-9]{68}\|98608349(?:(?:[0-2][0-9]{7}\|3[0-5][0-9]{6}\|36[0-3][0-9]{5}\|364[0-6][0-9]{4}\|3647[0-4][0-9]{3}\|36475[0-1][0-9]{2}\|364752[0-8][0-9]{1}\|3647529[0-1])[0-9]{60}\|36475292(?:(?:[0-6][0-9]{7}\|70[0-9]{6}\|71[0-8][0-9]{5}\|7190[0-6][0-9]{3}\|71907[0-3][0-9]{2}\|7190740[0-9]{1}\|7190741[0-5])[0-9]{52}\|71907416(?:(?:[0-7][0-9]{7}\|8[0-3][0-9]{6}\|84[0-3][0-9]{5}\|844[0-3][0-9]{4}\|8444[0-2][0-9]{3}\|84443[0-5][0-9]{2}\|844436[0-4][0-9]{1}\|8444365[0-4])[0-9]{44}\|84443655(?:(?:0[0-9]{7}\|10[0-6][0-9]{5}\|1070[0-3][0-9]{3}\|10704[0-2][0-9]{2}\|107043[0-3][0-9]{1}\|1070434[0-1])[0-9]{36}\|10704342(?:(?:[0-6][0-9]{7}\|70[0-9]{6}\|710[0-9]{5}\|711[0-4][0-9]{4}\|7115[0-4][0-9]{3}\|71155[0-8][0-9]{2}\|711559[0-5][0-9]{1}\|7115596[0-8])[0-9]{28}\|71155969(?:(?:[0-8][0-9]{7}\|9[0-4][0-9]{6}\|950[0-7][0-9]{4}\|95080[0-8][0-9]{2}\|950809[0-2][0-9]{1})[0-9]{20}\|95080930(?:(?:[0-3][0-9]{7}\|4[0-1][0-9]{6}\|42[0-7][0-9]{5}\|428[0-7][0-9]{4}\|428800[0-9]{2}\|428801[0-6][0-9]{1}\|4288017[0-6])[0-9]{12}\|42880177(?:(?:[0-8][0-9]{7}\|90[0-3][0-9]{5}\|9040[0-9]{4}\|9041[0-6][0-9]{3}\|90417[0-3][0-9]{2}\|904174[0-3][0-9]{1}\|9041744[0-8])[0-9]{4}\|90417449(?:(?:[0-6][0-9]{3}\|7[0-6][0-9]{2}\|77[0-8][0-9]{1}\|7790)\|7791))))))))))))))))))))))))))))))))))))))))(?:[^0-9]\|$))
`message`	`string` Explicação do erro legível por humanos. A redação pode variar; use o código `error` ao tratar uma falha específica.
`reason`	`null \| string \| number \| boolean \| Array<qualquer valor> \| object` Qualquer um dos esquemas a seguir pode ser aplicado: null `null` string `string` number `number` boolean `boolean` Array<qualquer valor> `Array<qualquer valor>` Esquema do item do array `qualquer valor` object `object` Esquema de propriedade adicional `qualquer valor`

Obter estatísticas de vagas prioritárias de Job

Exemplo de requisição

Autenticação

Parâmetros de consulta

Chaves compatíveis dentro do campo params

Parâmetros de requisição por método de autenticação

Resposta

sucesso 2xx

HTTP 400

HTTP 500

Resposta de erro

Chaves compatíveis dentro do campo `params`