Priority Job Slots の統計を取得する
指定されたリージョンと期間の Priority Job Slots の統計を返します。
https://api2.transloadit.com/ priority_job_slot_stats指定されたリージョンと期間の過去の Priority Job Slot 使用状況を取得します。
region: "all" の場合、各リージョンの 1 分ごとの最大値を分ごとに合計し、その 1 分ごとの合計の最大値を各バケットおよび maxSlotCount に選択します。各リージョンのピークは、同じ 1 分間の中でも異なる瞬間に発生することがあるため、この値は全リージョンを通じた実際の同時使用数のピークを上回る場合があります。aggregation: "max" の場合、slot_count でも同じ計算を使用します。
リクエスト例
curl を使用できるサーバー側のシェルで、適切な Bearer トークンを TRANSLOADIT_TOKEN に設定して、このリクエストを実行してください。トークンが必要な場合は、以下の設定手順を展開してください。
この例では、動的な値を 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=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
このシェルを開いたままにして、以下のリクエストを実行してください。トークンが有効な間は再利用してください。
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"
認証
このエンドポイントは、署名付きの params または Bearer トークンを受け付けます。設定手順については、認証を参照してください。
Auth Key または Bearer トークンに必要なスコープ: queues:read。
Signature 付きリクエストには、signature と、将来の時刻を示す params.auth.expires タイムスタンプの両方が必要です。Bearer トークンには、どちらも必要ありません。
クエリパラメーター
params(JSON 文字列)、必須。JSON エンコードされたオブジェクトで、サポートされるキーは以下のとおりです。signature(文字列)。署名付きリクエストでは必須です。Bearer トークンを使用する場合は、このフィールドを省略してください。
params フィールド内でサポートされるキー
この一覧の認証フィールドは、署名付きリクエストに適用されます。Bearer トークンを使用する場合は、params.auth と、それとは別の signature フィールドを省略できます。以下の認証方式ごとのリクエストパラメーターを比較してください。
完全な JSON スキーマ
params: このオブジェクトでは、一覧に記載されているフィールドのみが受け付けられます。
| フィールド | 型と説明 |
|---|---|
params. | "avg" | "max" | nullスロット使用量の平均値または最大値を選択します。省略した場合、または null の場合は、デフォルトで平均使用量になります。 |
params.署名付きリクエストでは必須。Bearer トークンを使用する場合は任意 | Priority Job Slots リクエスト用の 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
Auth Key を params.auth.key として含めてください。リクエストに署名する場合は、将来の時刻を示す params.auth.expires タイムスタンプを含め、Signature を別の signature フィールドで送信してください。以下のフィールド定義では、params 内のパスを使用しています。
完全な JSON スキーマ
params: このオブジェクトでは、一覧に記載されているフィールドのみが受け付けられます。
上記のフィールド定義を使用します: params.aggregation, params.auth, params.nonce, params.region, params.since
Bearer トークンを使用する場合
Bearer トークンを Authorization ヘッダーで送信してください。params.auth と、それとは別の signature フィールドは省略できます。他の必須パラメーターの要件は引き続き適用されます。以下のフィールド定義では、params 内のパスを使用します。
完全な JSON スキーマ
params: このオブジェクトでは、一覧に記載されているフィールドのみが受け付けられます。
上記のフィールド定義を使用します: params.aggregation, params.nonce, params.region, params.since
| フィールド | 型と説明 |
|---|---|
params. | Priority Job Slots リクエスト用の Transloadit API キーと Signature Authentication のメタデータを含みます。
|
params. | string将来の日時を示す ISO 8601 形式の有効期限タイムスタンプ。リクエストが署名されている場合、または Signature Authentication が必要な場合は必須です。Bearer 認証を使用するリクエストでは省略できます。 |
params. | stringリクエストの認証に使用する Transloadit API キー |
レスポンス
レスポンスボディの例を以下に示します:
{
"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
}
]
}2xx 成功
JSON レスポンスの本文。 application/json text/plain; charset=utf-8
レスポンスボディのスキーマ
完全な JSON スキーマ
レスポンスには、このオブジェクトについて記載されているフィールドのみが含まれます。
| フィールド | 型と説明 | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
aggregation必須 | "avg" | "max" | ||||||||||
avgSlotCount必須 | number (最小値: 0) | ||||||||||
granularity必須 | integer (最小値(境界値を含まない): 0)各統計バケットの時間幅(秒単位)。 | ||||||||||
maxSlotCount必須 | integer (最小値: 0) | ||||||||||
ok必須 | string (常に: "PRIORITY_JOB_SLOT_STATS_FOUND") | ||||||||||
stats必須 | Array<object>配列要素のスキーマ
|
HTTP 400
JSON レスポンスの本文。 application/json text/plain; charset=utf-8
レスポンスボディのスキーマ
完全な JSON スキーマ
名前付きエラーと一般的なエラー形式
error: "PRIORITY_JOB_SLOT_STATS_INVALID_AGGREGATION"
aggregation は "avg" または "max" のいずれかでなければなりません。
レスポンスには追加のフィールドが含まれる場合があります。
error: "PRIORITY_JOB_SLOT_STATS_INVALID_TIME"
since の時刻が指定されていないか、正しくありません。
レスポンスには追加のフィールドが含まれる場合があります。
error: "PRIORITY_JOB_SLOT_STATS_MISSING_REGION"
特定の region または "all" を指定する必要があります。
レスポンスには追加のフィールドが含まれる場合があります。
一般的なエラー形式
HTTP 500
JSON レスポンスの本文。 application/json text/plain; charset=utf-8
レスポンスボディのスキーマ
完全な JSON スキーマ
名前付きエラーと一般的なエラー形式
error: "PRIORITY_JOB_SLOT_STATS_ERROR"
Priority Job Slot の統計情報を読み込めませんでした。
レスポンスには追加のフィールドが含まれる場合があります。
一般的なエラー形式
エラーレスポンス
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追加プロパティのスキーマ任意の値 |