ขีดจำกัดอัตราการเรียก

อัตราคำขอ

ขีดจำกัดใช้กับ API key แต่ละคีย์ และแพ็กเกจของเวิร์กสเปซเป็นตัวกำหนดตัวเลข คีย์แต่ละคีย์มีขีดจำกัดต่อวินาที (หน้าต่างเลื่อนหนึ่งวินาที) และโควตารายวันที่รีเซ็ตตอนเที่ยงคืน UTC เซสชันของแดชบอร์ดไม่ถูกจำกัดอัตรา

คำขอที่ถูกปฏิเสธเพราะขาดสโคปหรือโมดูล (403) จะไม่ถูกนับ ส่วนคำขอใดก็ตามที่ผ่านการยืนยันตัวตนจะถูกนับ ไม่ว่าผลลัพธ์จะเป็นอย่างไร

Header

ทุกผลลัพธ์ที่ผ่านตัวจำกัดอัตราจะแนบยอดคงเหลือมาด้วย X-RateLimit-Limit และ X-RateLimit-Remaining อธิบายหน้าต่างต่อวินาที ส่วนคู่ Daily จะปรากฏเมื่อคีย์มีโควตารายวัน

HTTP/2 200X-RateLimit-Limit: 20X-RateLimit-Remaining: 19X-RateLimit-Daily-Limit: 100000X-RateLimit-Daily-Remaining: 98431

หน้าตาของ 429

คำขอที่ถูกจำกัดอัตราจะได้รับ 429 พร้อม code rate_limit_exceeded โครงสร้างข้อผิดพลาดมาตรฐาน และ header Retry-After เป็นจำนวนวินาทีเต็ม ให้รออย่างน้อยเท่านั้นก่อนลองใหม่ และถอยแบบ exponential backoff หากถูกจำกัดอีกครั้ง

HTTP/2 429Content-Type: application/jsonRetry-After: 1 {"code":"rate_limit_exceeded","message":"API key rate limit exceeded.","requestId":"3f2b6c1e-…","retryable":true}

เมื่อโควตารายวันหมด ระบบจะตอบ 429 พร้อม code daily_quota_exceeded และ Retry-After ที่นับถึงเที่ยงคืน UTC โดย header ของโควตาจะไม่ถูกส่งมากับ 429 นี้

เครดิต

นอกเหนือจากอัตราคำขอ ทุกการอ่านข้อมูลจะถูกคิดเป็นเครดิตจากกระเป๋าของเวิร์กสเปซ การอ่านข้อมูลแคชมีราคาถูก ส่วนคำขอที่ต้องเก็บข้อมูลใหม่จะใช้เครดิตมากกว่า (ดู เครดิต) เมื่อถึงเพดาน ทุกการเรียกที่คิดเครดิต รวมถึงการอ่านข้อมูลแคช จะได้รับ 402 พร้อม code credit_cap_exceeded