Assembly-Statistiken abrufen
Gibt die Anzahl der Assemblies für eine angegebene Region und einen Zeitraum zurück.
https://api2.transloadit.com/Das Beispiel enthält Assemblies mit und ohne Template in der angeforderten Region und im angeforderten Zeitraum.
Wenn Sie template_id weglassen, werden nur Assemblies ausgewählt, die ohne ein Template erstellt wurden.
Anfragebeispiel
Führen Sie diese Anfrage in einer serverseitigen Shell mit curl und einem geeigneten Bearer-Token in TRANSLOADIT_TOKEN aus. Wenn Sie ein Token benötigen, klappen Sie die folgende Einrichtungsanleitung auf.
Dieses Beispiel verwendet außerdem jq, um dynamische Werte als JSON zu kodieren.
Benötigen Sie ein Bearer-Token?
Setzen Sie in einer vertrauenswürdigen serverseitigen Shell mit curl und jq die Variablen TRANSLOADIT_KEY und TRANSLOADIT_SECRET auf Ihren Auth Key bzw. Ihr Auth Secret. Halten Sie beide Zugangsdaten und das daraus resultierende Token geheim; führen Sie diese Einrichtung niemals in Browsercode aus.
Erstellen Sie zunächst ein Token mit den für diesen Endpunkt erforderlichen Scopes. Ihr Auth Key muss diese Scopes bereits gewähren.
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=assemblies: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
Lassen Sie diese Shell geöffnet und führen Sie die folgende Anfrage aus. Verwenden Sie das Token erneut, solange es gültig ist.
SINCE="$(date -u +%Y-%m-%dT00:00:00Z)"
PARAMS="$(jq -cn --arg since "${SINCE:?Set SINCE}" '{"region":"us-east-1","since":$since,"template_id":"all"}')"
curl --fail-with-body -sS --request GET --get \
--url "https://api2.transloadit.com/assembly_stats" \
--header "Authorization: Bearer ${TRANSLOADIT_TOKEN:?Set TRANSLOADIT_TOKEN}" \
--data-urlencode "params=$PARAMS"
Authentifizierung
Dieser Endpunkt akzeptiert signierte params oder ein Bearer-Token. Anweisungen zur Einrichtung finden Sie unter Authentifizierung.
Erforderlicher Berechtigungsumfang für Auth Key oder Bearer-Token: assemblies:read.
Signierte Anfragen erfordern sowohl eine signature als auch einen in der Zukunft liegenden Zeitstempel für params.auth.expires. Bearer-Tokens erfordern keines von beiden.
Query-Parameter
params(JSON-Zeichenfolge), erforderlich. Ein JSON-codiertes Objekt, dessen unterstützte Schlüssel unten aufgeführt sind.signature(Zeichenfolge). Für signierte Anfragen erforderlich. Lassen Sie dieses Feld weg, wenn Sie ein Bearer-Token verwenden.
Unterstützte Schlüssel im Feld params
Die Authentifizierungsfelder in dieser Liste gelten für signierte Anfragen. Mit einem Bearer-Token können Sie params.auth und das separate Feld signature weglassen. Vergleichen Sie unten die Anfrageparameter der einzelnen Authentifizierungsmethoden.
Vollständiges JSON Schema
params: Es werden nur die für dieses Objekt aufgeführten Felder akzeptiert.
| Feld | Typ und Beschreibung |
|---|---|
params.für signierte Anfragen erforderlich; mit einem Bearer-Token optional | Enthält den Transloadit-API-Schlüssel und Metadaten für die Signature Authentication einer Anfrage zu Assembly-Statistiken.
|
params.erforderlich | stringISO-8601-Ablaufzeitstempel in der Zukunft. Erforderlich, wenn eine Anfrage signiert ist oder Signaturauthentifizierung erfordert; mit Bearer authentifizierte Anfragen können ihn weglassen. |
params.erforderlich | stringTransloadit API-Schlüssel zur Authentifizierung von Anfragen |
params. | string | integerEindeutiger Zufallswert, der in die Parameter signierter Anfragen aufgenommen wird, damit jede Signatur eindeutig ist und nicht versehentlich wiederverwendet werden kann. |
params. | string | integerEindeutiger Zufallswert, der in die Parameter signierter Anfragen aufgenommen wird, damit jede Signatur eindeutig ist und nicht versehentlich wiederverwendet werden kann. |
params.erforderlich | string (minimale Länge: 1)Einzubeziehende Region oder |
params.erforderlich | string (minimale Länge: 1)Datum und Uhrzeit des Beginns des Statistikzeitraums, höchstens 91 Tage in der Vergangenheit. ISO 8601 wird empfohlen; API2 unterstützt weiterhin Datumszeichenfolgen, die sein bestehender Parser akzeptiert. Ein längerer Rückblick wird mit dem Fehler des Endpunkts für einen ungültigen Zeitraum abgelehnt. |
params. | null | stringEinzubeziehende Template-ID oder |
Anfrageparameter nach Authentifizierungsmethode
Mit signierten Parametern
Geben Sie Ihren Auth Key als params.auth.key an. Wenn Sie die Anfrage signieren, geben Sie einen in der Zukunft liegenden Zeitstempel für params.auth.expires an und senden Sie die Signature im separaten Feld signature. Die folgenden Felddefinitionen verwenden Pfade innerhalb von params.
Vollständiges JSON Schema
params: Es werden nur die für dieses Objekt aufgeführten Felder akzeptiert.
Verwendet die oben angegebenen Felddefinitionen: params.auth, params.nonce, params.region, params.since, params.template_id
Mit einem Bearer-Token
Senden Sie das Bearer-Token im Authorization-Header. Sie können params.auth und das separate Feld signature weglassen. Die übrigen erforderlichen Parameter müssen weiterhin angegeben werden. Die folgenden Felddefinitionen verwenden Pfade innerhalb von params.
Vollständiges JSON Schema
params: Es werden nur die für dieses Objekt aufgeführten Felder akzeptiert.
Verwendet die oben angegebenen Felddefinitionen: params.nonce, params.region, params.since, params.template_id
| Feld | Typ und Beschreibung |
|---|---|
params. | Enthält den Transloadit-API-Schlüssel und Metadaten für die Signature Authentication einer Anfrage zu Assembly-Statistiken.
|
params. | stringISO-8601-Ablaufzeitstempel in der Zukunft. Erforderlich, wenn eine Anfrage signiert ist oder Signaturauthentifizierung erfordert; mit Bearer authentifizierte Anfragen können ihn weglassen. |
params. | stringTransloadit API-Schlüssel zur Authentifizierung von Anfragen |
params. | string | integerEindeutiger Zufallswert, der in die Parameter signierter Anfragen aufgenommen wird, damit jede Signatur eindeutig ist und nicht versehentlich wiederverwendet werden kann. |
Antwort
Hier sehen Sie ein Beispiel für einen Antworttext:
{
"errorStats": [
{
"data_from_ts": 1789200000,
"error": "FILE_IMPORT_FAILED",
"num_erroneous_assemblies": 1
}
],
"errorStatsGranularity": 60,
"errorStatsTotals": [
{
"error": "FILE_IMPORT_FAILED",
"num_erroneous_assemblies": 1
}
],
"granularity": 60,
"ok": "ASSEMBLY_STATS_FOUND",
"stats": [
{
"avg_execution_duration": 2,
"avg_input_file_sizes": 100000,
"avg_live_queue_duration": 0.5,
"avg_output_file_sizes": 90000,
"avg_processing_speed": 0.4,
"avg_upload_duration": 1,
"avg_upload_speed": 0.8,
"data_from_ts": 1789200000,
"num_assemblies": 10,
"num_bytes": 1000000,
"num_cancelled_assemblies": 0,
"num_erroneous_assemblies": 1,
"num_files": 10,
"num_request_aborted_assemblies": 0,
"num_successful_assemblies": 9,
"total_bytes_usage": 1000000,
"total_execution_duration": 20,
"total_live_queue_duration": 5,
"total_num_output_files": 9,
"total_num_uploaded_bytes": 1000000,
"total_output_file_sizes": 900000,
"total_upload_duration": 10
}
],
"totalAssemblies": 10,
"totalBytesProcessed": 1000000,
"totalBytesUploaded": 1000000,
"totalExecutionDuration": 20,
"totalFilesProcessed": 10,
"totalLiveQueueDuration": 5,
"totalOutputBytesProcessed": 900000,
"totalOutputFilesProcessed": 9,
"totalUploadDuration": 10,
"totalUsage": 1000000
}2xx-Erfolg
JSON-Response-Body. application/json text/plain; charset=utf-8
Schema des Response-Bodys
Vollständiges JSON Schema
Die Antwort enthält nur die für dieses Objekt aufgeführten Felder.
| Feld | Typ und Beschreibung | ||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errorStatserforderlich | Array<object>Schema eines Array-Elements
| ||||||||||||||||||||||||||||||||||||||||||||||
errorStatsGranularityerforderlich | integer (exklusives Minimum: 0) | ||||||||||||||||||||||||||||||||||||||||||||||
errorStatsTotalserforderlich | Array<object>Schema eines Array-Elements
| ||||||||||||||||||||||||||||||||||||||||||||||
granularityerforderlich | integer (exklusives Minimum: 0)Dauer jedes Statistikintervalls in Sekunden. | ||||||||||||||||||||||||||||||||||||||||||||||
okerforderlich | string (immer: "ASSEMBLY_STATS_FOUND") | ||||||||||||||||||||||||||||||||||||||||||||||
statserforderlich | Array<object>Schema eines Array-Elements
| ||||||||||||||||||||||||||||||||||||||||||||||
totalAssemblieserforderlich | integer (Minimum: 0) | ||||||||||||||||||||||||||||||||||||||||||||||
totalBytesProcessederforderlich | integer (Minimum: 0) | ||||||||||||||||||||||||||||||||||||||||||||||
totalBytesUploadederforderlich | integer (Minimum: 0) | ||||||||||||||||||||||||||||||||||||||||||||||
totalExecutionDurationerforderlich | number (Minimum: 0) | ||||||||||||||||||||||||||||||||||||||||||||||
totalFilesProcessederforderlich | integer (Minimum: 0) | ||||||||||||||||||||||||||||||||||||||||||||||
totalLiveQueueDurationerforderlich | number (Minimum: 0) | ||||||||||||||||||||||||||||||||||||||||||||||
totalOutputBytesProcessederforderlich | integer (Minimum: 0) | ||||||||||||||||||||||||||||||||||||||||||||||
totalOutputFilesProcessederforderlich | integer (Minimum: 0) | ||||||||||||||||||||||||||||||||||||||||||||||
totalUploadDurationerforderlich | number (Minimum: 0) | ||||||||||||||||||||||||||||||||||||||||||||||
totalUsageerforderlich | integer (Minimum: 0) |
HTTP 400
JSON-Response-Body. application/json text/plain; charset=utf-8
Schema des Response-Bodys
Vollständiges JSON Schema
Benannte Fehler und das allgemeine Fehlerformat
error: "ASSEMBLY_STATS_INVALID_TIME"
Die Zeitangabe since fehlt oder ist falsch.
Die Antwort kann zusätzliche Felder enthalten.
error: "ASSEMBLY_STATS_MISSING_REGION"
Sie müssen eine bestimmte region angeben oder "all".
Die Antwort kann zusätzliche Felder enthalten.
Allgemeines Fehlerformat
HTTP 500
JSON-Response-Body. application/json text/plain; charset=utf-8
Schema des Response-Bodys
Vollständiges JSON Schema
Benannte Fehler und das allgemeine Fehlerformat
error: "ASSEMBLY_STATS_ERROR"
Assembly-Statistiken konnten nicht geladen werden.
Die Antwort kann zusätzliche Felder enthalten.
Allgemeines Fehlerformat
Fehlerantwort
JSON-Response-Body. application/json text/plain; charset=utf-8
Schema des Response-Bodys
Vollständiges JSON Schema
Die Antwort kann zusätzliche Felder enthalten.
| Feld | Typ und Beschreibung |
|---|---|
assembly_id | string |
error | string (minimale Länge: 1) |
http_code | number | string
|
message | stringMenschenlesbare Erklärung des Fehlers. Die Formulierung kann variieren; verwenden Sie den Code |
reason | null | string | number | boolean | Array<beliebiger Wert> | objectEines der folgenden Schemas kann gelten: nullnullstringstringnumbernumberbooleanbooleanArray<beliebiger Wert>Array<beliebiger Wert>Schema eines Array-Elementsbeliebiger WertobjectobjectSchema für zusätzliche Eigenschaftenbeliebiger Wert |