RemoteGymp · API v1

मर्यादा आणि त्रुटी

प्रत्येक पेज वाचा, रेट लिमिट्सचे पालन करा आणि त्रुटींमधून सुरक्षितपणे रिकव्हर करा.

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

    मर्यादा कॉन्फिगर करण्यायोग्य आहेत. GET /v1/operations/capabilities हे requestsPerMinute आणि authenticationRequestsPerMinutePerIp यांची माहिती देते. 429 नंतर, 'Retry-After' चे पालन करा आणि थ्रॉटलिंग सुरू राहिल्यास जास्त वेळ थांबा. बॅच रीड्स 100 आयडी पर्यंत स्वीकारतात; वैयक्तिक एंडपॉइंट्ससाठी लहान पेज किंवा पेलोड मर्यादा असू शकतात.

  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 आणि बॉडीचा पुन्हा वापर करा.

API संदर्भ →

सामग्री पुनरावलोकन 3f225a253 · OpenAPI SHA-256: b12c42306a89