錯誤目錄
每個錯誤都是 RFC 9457 問題文件,其 type 指向本頁的某個條目,code 就是該條目的名稱。instance 帶有請求 id;聯絡支援時請附上。
- 400
invalid_request - 請求格式錯誤:未知的查詢參數、無法讀取的主體、端點不接受的參數,或格式錯誤的
Idempotency-Key。請修正請求;不要原樣重試。 - 400
invalid_cursor cursor格式錯誤、超過 24 小時,或是針對不同篩選條件發出的;比對結果饋送的since_cursor只有在超過 30 天的比對結果保留期限後才會失效。請從第一頁重新列出(不帶游標的饋送)。- 401
unauthenticated - 這個端點需要金鑰,但請求沒有帶。會設定
WWW-Authenticate: Bearer realm="api.tuneping.com"。 - 401
invalid_api_key - 金鑰格式不對或無法辨識。請檢查是否被截斷,以及
tp_live_/tp_test_前綴。 - 401
key_revoked - 金鑰已輪替或撤銷;
revoked_at說明時間。請使用目前的金鑰。 - 401
token_invalid - 使用權權杖(合作夥伴應用程式):權杖格式錯誤或簽章無法辨識。
- 401
token_expired - 使用權權杖:權杖已過期,超出允許的時間誤差。請重新整理一次。
- 401
token_audience - 使用權權杖:權杖的對象(audience)或簽發者不是這個 API。
- 403
forbidden_tier - 端點或參數值需要更高的方案,例如播放紀錄的
from早於方案的保留深度,或批次 id 數超過方案允許的上限。required_tier指出所需方案,upgrade_url連到價格頁面。 - 403
forbidden_scope - 金鑰存在,但簽發時沒有這項操作所需的權限範圍(
wishlists或webhooks;採用webhook傳送的願望清單也需要webhooks,且會在檢查方案之前先檢查);required_scope指出所需範圍,WWW-Authenticate帶有error="insufficient_scope"。請使用具備該範圍的金鑰;除非簽發時指定了較窄的清單(例如唯讀),金鑰都帶有所有權限範圍,GET /v1/me會列出金鑰的權限範圍。 - 403
entitlement_revoked - 使用權權杖驗證通過,但其授權已被撤銷。使用權已經失效;重新整理也沒有用。
- 403
livemode_mismatch tp_test_金鑰被用於僅限正式環境的操作,例如指向測試主機(webhook.site)以外的 webhook 端點。- 404
not_found - 找不到該電臺、曲目、藝人或資源,或該電臺尚未觀察到任何即時標題。
- 404
station_opted_out - 該電臺存在於目錄中,但要求不被索引。Tuneping 不會說明原因。請視為永久無法使用。
- 406
not_acceptable Accept標頭中沒有任何支援的媒體類型。回應主體仍是application/problem+json。- 409
conflict - 資源重複,例如第二個 URL 相同的 webhook 端點。
- 409
idempotency_in_progress - 帶有相同
Idempotency-Key的請求仍在執行中。請在Retry-After秒後重試,以取得它的回應。 - 410
endpoint_sunset - 該端點已在預告的
Sunset日期之後停用;Link標頭指向變更紀錄中的對應條目。 - 413
payload_too_large - 請求主體上限為 64 KiB;
PUT /v1/wishlists最多可到 1 MiB。 - 422
validation_failed - 一個或多個參數的值無效。
errors[]會逐一列出field、code與人類可讀的message。 - 422
idempotency_key_reused - 這個
Idempotency-Key在過去 24 小時內已被用於另一個不同的請求(方法、路徑、查詢或主體不同)。新的請求請送出新的鍵值。 - 429
rate_limited - 每秒權杖桶已空。請等待
Retry-After秒;RateLimit標頭會指出已用盡的政策。 - 429
too_many_connections - 這把金鑰開啟的事件串流數已達方案上限(Developer 1、Pro 5、Business 20、Tapelark 每部裝置 1)。請先關閉一條。
- 429
quota_exceeded - 每日或每月配額已用完。
Retry-After與quota_resets_at說明何時重設;upgrade_url連到價格頁面。 - 500
internal_error - 我們這邊出了問題。請以退避方式重試;若持續發生,請把請求 id 寄給我們。
- 資料庫無法使用或服務正在維護,或帶有
Idempotency-Key的請求在 20 秒後仍在執行,已取消且未做任何變更。請在Retry-After秒後重試,此值也會以retry_after_seconds提供(被取消的請求為 1;請用同一個鍵值重試)。