RemoteGymp · API v1

लिमिट्स और एरर्स

हर पेज पढ़ें, रेट लिमिट्स का सम्मान करें और एरर्स से सुरक्षित रूप से रिकवर करें।

  1. रेट लिमिट्स

    लिमिट्स कॉन्फ़िगर करने लायक हैं। GET /v1/operations/capabilities, requestsPerMinute और authenticationRequestsPerMinutePerIp की रिपोर्ट करता है। 429 के बाद, Retry-After को ऑनर ​​करें और अगर थ्रॉटलिंग जारी रहती है तो ज़्यादा इंतज़ार करें। बैच रीड्स 100 IDs तक एक्सेप्ट करते हैं; अलग-अलग एंडपॉइंट्स में पेज या पेलोड लिमिट्स छोटी हो सकती हैं।

  2. हर पेज पढ़ें

    आपने जिस एंडपॉइंट को कॉल किया है, उसके लिए कंटिन्यूएशन रूल का इस्तेमाल करें, वही फिल्टर रखें। लिस्ट पढ़ते समय वे बदल सकती हैं; जब आपको एक जैसी कॉपी चाहिए तो स्नैपशॉट का इस्तेमाल करें।

    पेजिनेशनइसके साथ जारी रखेंतब रुकें जब
    कर्सरnext को after के तौर पर पास करें।अगला null है।
    nextOffset के साथ ऑफसेट करेंnextOffset को offset के तौर पर पास करें।nextOffset, null है।
    hasMore के साथ ऑफ़सेटवापस किए गए आइटम की संख्या से ऑफ़सेट बढ़ाएँ।hasMore गलत है।
    सॉफ़्टवेयरन्यूमेरिक next वैल्यू को after के रूप में पास करें; अगर updatedAtUtc बदलता है तो रीस्टार्ट करें।अगला null है।
    इवेंट फ़ीडnext को after के तौर पर पास करें।hasMore गलत है।
  3. गलतियाँ हैंडल करें

    एरर कोड के साथ-साथ HTTP स्टेटस भी पढ़ें। अगर जवाब में requestId है, तो सपोर्ट से संपर्क करते समय इसे बताएं।

    HTTP स्टेटसक्या करें
    400रिक्वेस्ट ठीक करें।
    401क्रेडेंशियल चेक करें या नया एक्सेस टोकन लें।
    403स्कोप, परमिशन और एक्सेस चालू है या नहीं, यह चेक करें।
    404हो सकता है कि रिसोर्स गायब हो या आपके स्कोप से बाहर हो।
    409फैसला करने से पहले एरर कोड और करंट स्टेट पढ़ें।
    410स्नैपशॉट या इवेंट कर्सर एक्सपायर हो गया है। एक नई बेसलाइन शुरू करें।
  4. अगर कोई राइट टाइम आउट हो जाता है

    टाइमआउट या 503 यह साबित नहीं करता कि एक्शन फेल हो गया है। ऐसे राइट के लिए जो ऑपरेशन रसीदें लौटाते हैं, दोबारा कोशिश करने से पहले GET /v1/operations/by-key?idempotencyKey={key} देखें। मेंटेनेंस क्रिएशन के लिए, ओरिजिनल Idempotency-Key और बॉडी का दोबारा इस्तेमाल करें।

एपीआई संदर्भ →

सामग्री संशोधन 3f225a253 · OpenAPI SHA-256: b12c42306a89