Transloadit

Récupérer les statistiques des emplacements prioritaires pour les Jobs

Renvoie les statistiques des emplacements prioritaires de Jobs pour la région et la période demandées.

GEThttps://api2.transloadit.com/priority_job_slot_stats

Récupère l’historique d’utilisation des emplacements prioritaires de Jobs pour la région et la période demandées.

Pour region: "all", les maxima régionaux par minute sont additionnés pour chaque minute, puis la plus grande somme par minute est sélectionnée pour chaque intervalle et pour maxSlotCount. Les pics régionaux peuvent survenir à des instants différents au cours d’une même minute, cette valeur peut donc dépasser le pic simultané réel toutes régions confondues. Le même calcul est utilisé par slot_count lorsque aggregation: "max".

Exemple de requête

Exécutez cette requête dans un shell côté serveur avec curl et un jeton porteur approprié dans TRANSLOADIT_TOKEN. Si vous avez besoin d’un jeton, développez la section de configuration ci-dessous.

Cet exemple utilise également jq pour encoder les valeurs dynamiques en JSON.

Besoin d’un jeton porteur ?

Dans un shell de confiance côté serveur disposant de curl et de jq, définissez TRANSLOADIT_KEY et TRANSLOADIT_SECRET avec votre Auth Key et votre Auth Secret. Gardez ces deux informations d’identification ainsi que le jeton obtenu secrets ; n’exécutez jamais cette configuration dans du code exécuté dans un navigateur.

Créez d’abord un jeton avec les portées requises par ce point de terminaison. Votre Auth Key doit déjà accorder ces portées.

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

Gardez ce shell ouvert et exécutez la requête ci-dessous. Réutilisez le jeton tant qu’il reste valide.

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"

Authentification

Ce point de terminaison accepte des params signés ou un jeton porteur. Consultez la section Authentification pour les instructions de configuration.

Portée requise pour l’Auth Key ou le jeton porteur : queues:read.

Les requêtes signées nécessitent à la fois une signature et un horodatage params.auth.expires situé dans le futur. Les jetons porteurs ne nécessitent ni l’un ni l’autre.

Paramètres de requête

  • params (Chaîne JSON), obligatoire. Un objet encodé en JSON dont les clés prises en charge sont répertoriées ci-dessous.

  • signature (chaîne de caractères). Obligatoire pour les requêtes signées. Omettez ce champ lorsque vous utilisez un jeton porteur.

Clés prises en charge dans le champ params

Les champs d’authentification de cette liste s’appliquent aux requêtes signées. Avec un jeton porteur, vous pouvez omettre params.auth et le champ distinct signature. Comparez les paramètres de requête spécifiques à l’authentification ci-dessous.

Schéma JSON complet

Ouvrir le JSON dans un nouvel onglet

params: Seuls les champs répertoriés pour cet objet sont acceptés.

ChampType et description
params.aggregation
"avg" | "max" | null

Sélectionne l’utilisation moyenne ou maximale des emplacements de capacité. En cas d’omission ou de valeur null, l’utilisation moyenne est retenue par défaut.

params.auth

obligatoire pour les requêtes signées ; facultatif avec un jeton porteur

object

Contient la clé API Transloadit et les métadonnées de Signature Authentication pour une requête relative aux emplacements prioritaires pour les Jobs.

params.auth: Seuls les champs répertoriés pour cet objet sont acceptés.

params.auth.expires

obligatoire

string

Horodatage d’expiration au format ISO 8601 situé dans le futur. Obligatoire lorsqu’une requête est signée ou nécessite Signature Authentication ; les requêtes authentifiées par jeton porteur peuvent l’omettre.

params.auth.key

obligatoire

string

Clé API Transloadit utilisée pour authentifier les requêtes

params.nonce
string | integer

Valeur unique et aléatoire incluse dans les paramètres de la requête signée pour rendre chaque signature unique et empêcher la réutilisation accidentelle d’une signature.

params.region

obligatoire

string (longueur minimale : 1)

Région à inclure, ou all pour toutes les régions.

params.since

obligatoire

string (longueur minimale : 1)

Date et heure auxquelles commence la fenêtre de statistiques, au plus tôt il y a 91 jours. Le format ISO 8601 est recommandé ; API2 préserve également les chaînes de date acceptées par son analyseur existant. Une période rétrospective plus longue est rejetée avec l’erreur invalid-time du point de terminaison.

Paramètres de requête par méthode d’authentification

Avec des paramètres signés

Incluez votre Auth Key dans params.auth.key. Lors de la signature de la requête, incluez un horodatage futur dans params.auth.expires et envoyez la signature dans le champ distinct signature. Les définitions des champs ci-dessous utilisent des chemins à l’intérieur de params.

Schéma JSON complet

Ouvrir le JSON dans un nouvel onglet

params: Seuls les champs répertoriés pour cet objet sont acceptés.

Utilise les définitions des champs ci-dessus : params.aggregation, params.auth, params.nonce, params.region, params.since

Avec un jeton porteur

Envoyez le jeton porteur dans l’en-tête Authorization. Vous pouvez omettre params.auth et le champ distinct signature. Les autres paramètres obligatoires restent requis. Les définitions des champs ci-dessous utilisent des chemins à l’intérieur de params.

Schéma JSON complet

Ouvrir le JSON dans un nouvel onglet

params: Seuls les champs répertoriés pour cet objet sont acceptés.

Utilise les définitions des champs ci-dessus : params.aggregation, params.nonce, params.region, params.since

ChampType et description
params.auth
object

Contient la clé API Transloadit et les métadonnées de Signature Authentication pour une requête relative aux emplacements prioritaires pour les Jobs.

params.auth: Seuls les champs répertoriés pour cet objet sont acceptés.

params.auth.expires
string

Horodatage d’expiration au format ISO 8601 situé dans le futur. Obligatoire lorsqu’une requête est signée ou nécessite Signature Authentication ; les requêtes authentifiées par jeton porteur peuvent l’omettre.

params.auth.key
string

Clé API Transloadit utilisée pour authentifier les requêtes

Réponse

Voici un exemple de corps de réponse :

{
  "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
    }
  ]
}

Succès 2xx

Corps de la réponse JSON. application/json text/plain; charset=utf-8

Schéma du corps de la réponse
Schéma JSON complet

Ouvrir le JSON dans un nouvel onglet

La réponse contient uniquement les champs répertoriés pour cet objet.

ChampType et description
aggregation

obligatoire

"avg" | "max"
avgSlotCount

obligatoire

number (minimum : 0)
granularity

obligatoire

integer (minimum exclusif : 0)

Durée de chaque intervalle de statistiques, en secondes.

maxSlotCount

obligatoire

integer (minimum : 0)
ok

obligatoire

string (toujours : "PRIORITY_JOB_SLOT_STATS_FOUND")
stats

obligatoire

Array<object>
Schéma d’un élément de tableau
object

stats[]: La réponse contient uniquement les champs répertoriés pour cet objet.

ChampType et description
stats[].avg_slot_count

obligatoire

number (minimum : 0)

Nombre moyen d’emplacements occupés pendant l’intervalle.

stats[].data_from_ts

obligatoire

integer (minimum : 0)

Début de l’intervalle de statistiques sous forme d’un horodatage Unix en secondes.

stats[].max_slot_count

obligatoire

integer (minimum : 0)

Utilisation maximale des emplacements de capacité observée au cours de l’intervalle d’agrégation. Pour region: "all", il s’agit de la plus grande somme des maxima régionaux par minute, les maxima pouvant survenir à des instants différents au cours d’une même minute et leur somme pouvant dépasser le pic réel d’utilisation simultanée toutes régions confondues.

stats[].slot_count

obligatoire

number (minimum : 0)

Utilisation des emplacements de capacité sélectionnée selon l’agrégation demandée : moyenne ou maximum.

HTTP 400

Corps de la réponse JSON. application/json text/plain; charset=utf-8

Schéma du corps de la réponse
Schéma JSON complet

Ouvrir le JSON dans un nouvel onglet

Erreurs nommées et format général des erreurs

error: "PRIORITY_JOB_SLOT_STATS_INVALID_AGGREGATION"

aggregation doit être « avg » ou « max ».

La réponse peut contenir des champs supplémentaires.

ChampType et description
error

obligatoire

string (toujours : "PRIORITY_JOB_SLOT_STATS_INVALID_AGGREGATION")
http_code
number (toujours : 400)
message
string

Explication de l’erreur destinée à être lue par un humain. Sa formulation peut varier ; utilisez le code error pour gérer un échec spécifique.

error: "PRIORITY_JOB_SLOT_STATS_INVALID_TIME"

L’heure since est manquante ou incorrecte.

La réponse peut contenir des champs supplémentaires.

ChampType et description
error

obligatoire

string (toujours : "PRIORITY_JOB_SLOT_STATS_INVALID_TIME")
http_code
number (toujours : 400)
message
string

Explication de l’erreur destinée à être lue par un humain. Sa formulation peut varier ; utilisez le code error pour gérer un échec spécifique.

error: "PRIORITY_JOB_SLOT_STATS_MISSING_REGION"

Vous devez fournir une region spécifique, ou « all ».

La réponse peut contenir des champs supplémentaires.

ChampType et description
error

obligatoire

string (toujours : "PRIORITY_JOB_SLOT_STATS_MISSING_REGION")
http_code
number (toujours : 400)
message
string

Explication de l’erreur destinée à être lue par un humain. Sa formulation peut varier ; utilisez le code error pour gérer un échec spécifique.

Format général des erreurs

Consultez les champs généraux des réponses d’erreur.

HTTP 500

Corps de la réponse JSON. application/json text/plain; charset=utf-8

Schéma du corps de la réponse
Schéma JSON complet

Ouvrir le JSON dans un nouvel onglet

Erreurs nommées et format général des erreurs

error: "PRIORITY_JOB_SLOT_STATS_ERROR"

Impossible de charger les statistiques des emplacements prioritaires pour les Jobs.

La réponse peut contenir des champs supplémentaires.

ChampType et description
error

obligatoire

string (toujours : "PRIORITY_JOB_SLOT_STATS_ERROR")
http_code
number (toujours : 500)
message
string

Explication de l’erreur destinée à être lue par un humain. Sa formulation peut varier ; utilisez le code error pour gérer un échec spécifique.

Format général des erreurs

Consultez les champs généraux des réponses d’erreur.

Réponse d’erreur

Corps de la réponse JSON. application/json text/plain; charset=utf-8

Schéma du corps de la réponse
Schéma JSON complet

Ouvrir le JSON dans un nouvel onglet

Au moins une de ces propriétés est requise : error, message, reason

La réponse peut contenir des champs supplémentaires.

ChampType et description
assembly_id
string
error
string (longueur minimale : 1)
http_code
number | string
  • number
  • string
    Motif de validation (expression régulière)^[\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

Explication de l’erreur destinée à être lue par un humain. Sa formulation peut varier ; utilisez le code error pour gérer un échec spécifique.

reason
null | string | number | boolean | Array<n’importe quelle valeur> | object

N’importe lequel des schémas suivants peut s’appliquer :

null
string
number
boolean
Array<n’importe quelle valeur>
Array<n’importe quelle valeur>
Schéma d’un élément de tableau
n’importe quelle valeur
object
object
Schéma de la propriété supplémentaire
n’importe quelle valeur