Assembly の統計情報を取得する
指定されたリージョンと期間の Assembly 数を返します。
https://api2.transloadit.com/ assembly_statsこの例には、指定されたリージョンと期間内の、Template を使用した Assemblies と使用していない Assemblies が含まれます。template_id を省略すると、Template を使用せずに作成された Assemblies のみが選択されます。
リクエスト例
適切な Bearer トークンを TRANSLOADIT_TOKEN に設定したサーバー側のシェルで、curl を使ってこのリクエストを実行してください。トークンが必要な場合は、以下の設定手順を展開してください。
この例では、動的な値を JSON としてエンコードするために jq も使用します。
Bearer トークンが必要ですか?
curl と jq を使用できる信頼できるサーバー側のシェルで、TRANSLOADIT_KEY と TRANSLOADIT_SECRET にそれぞれ Auth Key と Auth Secret を設定してください。両方の認証情報と生成されたトークンを秘密に保ち、この設定手順をブラウザーのコードで決して実行しないでください。
まず、このエンドポイントで必要なスコープを持つトークンを作成します。Auth Key には、それらのスコープがすでに付与されている必要があります。
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
このシェルを開いたまま、以下のリクエストを実行してください。トークンが有効な間は再利用してください。
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"
認証
このエンドポイントは、署名付きの params または Bearer トークンを受け付けます。設定手順については、認証を参照してください。
Auth Key または Bearer トークンに必要なスコープ: assemblies:read。
Signature 付きリクエストには、signature と、将来の時刻を示す params.auth.expires タイムスタンプの両方が必要です。Bearer トークンには、どちらも必要ありません。
クエリパラメーター
params(JSON 文字列)、必須。JSON エンコードされたオブジェクトで、サポートされるキーは以下のとおりです。signature(文字列)。署名付きリクエストでは必須です。Bearer トークンを使用する場合は、このフィールドを省略してください。
params フィールド内でサポートされるキー
この一覧の認証フィールドは、署名付きリクエストに適用されます。Bearer トークンを使用する場合は、params.auth と、それとは別の signature フィールドを省略できます。以下の認証方式ごとのリクエストパラメーターを比較してください。
完全な JSON スキーマ
params: このオブジェクトでは、一覧に記載されているフィールドのみが受け付けられます。
| フィールド | 型と説明 |
|---|---|
params.署名付きリクエストでは必須。Bearer トークンを使用する場合は任意 | Assembly の統計情報リクエストに使用する Transloadit の API キーと Signature Authentication のメタデータを含みます。
|
params.必須 | string将来の日時を示す ISO 8601 形式の有効期限タイムスタンプ。リクエストが署名されている場合、または Signature Authentication が必要な場合は必須です。Bearer 認証を使用するリクエストでは省略できます。 |
params.必須 | stringリクエストの認証に使用する Transloadit API キー |
params. | string | integer各 Signature を一意にし、Signature の意図しない再利用を防ぐために、署名付きリクエストのパラメーターに含める一意のランダムな値。 |
params.必須 | string (最小長: 1)対象に含めるリージョン。すべてのリージョンを含める場合は |
params.必須 | string (最小長: 1)統計対象期間の開始日時。最大で 91 日前まで指定できます。ISO 8601 を推奨します。API2 は、既存のパーサーが受け付ける日付文字列も保持します。それより長く遡る指定は、このエンドポイントの時刻無効エラーで拒否されます。 |
params. | null | string含める Template ID を指定します。Templates 全体の事前集計済み合計を対象とする場合は |
認証方式別のリクエストパラメーター
署名付き params
Auth Key を params.auth.key として含めてください。リクエストに署名する場合は、将来の時刻を示す params.auth.expires タイムスタンプを含め、Signature を別の signature フィールドで送信してください。以下のフィールド定義では、params 内のパスを使用しています。
完全な JSON スキーマ
params: このオブジェクトでは、一覧に記載されているフィールドのみが受け付けられます。
上記のフィールド定義を使用します: params.auth, params.nonce, params.region, params.since, params.template_id
Bearer トークンを使用する場合
Bearer トークンを Authorization ヘッダーで送信してください。params.auth と、それとは別の signature フィールドは省略できます。他の必須パラメーターの要件は引き続き適用されます。以下のフィールド定義では、params 内のパスを使用します。
完全な JSON スキーマ
params: このオブジェクトでは、一覧に記載されているフィールドのみが受け付けられます。
上記のフィールド定義を使用します: params.nonce, params.region, params.since, params.template_id
| フィールド | 型と説明 |
|---|---|
params. | Assembly の統計情報リクエストに使用する Transloadit の API キーと Signature Authentication のメタデータを含みます。
|
params. | string将来の日時を示す ISO 8601 形式の有効期限タイムスタンプ。リクエストが署名されている場合、または Signature Authentication が必要な場合は必須です。Bearer 認証を使用するリクエストでは省略できます。 |
params. | stringリクエストの認証に使用する Transloadit API キー |
レスポンス
レスポンスボディの例を以下に示します:
{
"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 成功
JSON レスポンスの本文。 application/json text/plain; charset=utf-8
レスポンスボディのスキーマ
完全な JSON スキーマ
レスポンスには、このオブジェクトについて記載されているフィールドのみが含まれます。
| フィールド | 型と説明 | ||||||||
|---|---|---|---|---|---|---|---|---|---|
errorStats必須 | Array<object>配列要素のスキーマ
| ||||||||
errorStatsGranularity必須 | integer (最小値(境界値を含まない): 0) | ||||||||
errorStatsTotals必須 | Array<object>配列要素のスキーマ
| ||||||||
granularity必須 | integer (最小値(境界値を含まない): 0)各統計バケットの時間幅(秒単位)。 | ||||||||
ok必須 | string (常に: "ASSEMBLY_STATS_FOUND") | ||||||||
stats必須 | Array<object>配列要素のスキーマ
| ||||||||
totalAssemblies必須 | integer (最小値: 0) | ||||||||
totalBytesProcessed必須 | integer (最小値: 0) | ||||||||
totalBytesUploaded必須 | integer (最小値: 0) | ||||||||
totalExecutionDuration必須 | number (最小値: 0) | ||||||||
totalFilesProcessed必須 | integer (最小値: 0) | ||||||||
totalLiveQueueDuration必須 | number (最小値: 0) | ||||||||
totalOutputBytesProcessed必須 | integer (最小値: 0) | ||||||||
totalOutputFilesProcessed必須 | integer (最小値: 0) | ||||||||
totalUploadDuration必須 | number (最小値: 0) | ||||||||
totalUsage必須 | integer (最小値: 0) |
HTTP 400
JSON レスポンスの本文。 application/json text/plain; charset=utf-8
レスポンスボディのスキーマ
完全な JSON スキーマ
名前付きエラーと一般的なエラー形式
error: "ASSEMBLY_STATS_INVALID_TIME"
since の時刻が指定されていないか、正しくありません。
レスポンスには追加のフィールドが含まれる場合があります。
error: "ASSEMBLY_STATS_MISSING_REGION"
特定の region または "all" を指定する必要があります。
レスポンスには追加のフィールドが含まれる場合があります。
一般的なエラー形式
HTTP 500
JSON レスポンスの本文。 application/json text/plain; charset=utf-8
レスポンスボディのスキーマ
完全な JSON スキーマ
名前付きエラーと一般的なエラー形式
error: "ASSEMBLY_STATS_ERROR"
Assembly の統計情報を読み込めませんでした。
レスポンスには追加のフィールドが含まれる場合があります。
一般的なエラー形式
エラーレスポンス
JSON レスポンスの本文。 application/json text/plain; charset=utf-8
レスポンスボディのスキーマ
完全な JSON スキーマ
レスポンスには追加のフィールドが含まれる場合があります。
| フィールド | 型と説明 |
|---|---|
assembly_id | string |
error | string (最小長: 1) |
http_code | number | string
|
message | string人が読んで理解できる形式のエラー説明です。文言は変わる場合があるため、特定の失敗を処理する際は |
reason | null | string | number | boolean | Array<任意の値> | object次のいずれかのスキーマが適用される場合があります: nullstringnumberbooleanArray<任意の値>Array<任意の値>配列要素のスキーマ任意の値objectobject追加プロパティのスキーマ任意の値 |