मुख्य सामग्री पर जाएं

एपीआई अवलोकन

यह दस्तावेज़ duplistatus एप्लिकेशन के लिए सभी उपलब्ध एपीआई एंडपॉइंट का वर्णन करता है। एपीआई रेस्टफुल सिद्धांतों का पालन करता है और व्यापक बैकअप निगरानी, सूचना प्रबंधन और सिस्टम प्रशासन क्षमता प्रदान करता है।

एपीआई संरचना​

सभी एंडपॉइंट के त्वरित संदर्भ के लिए, एपीआई एंडपॉइंट सूची देखें।

एपीआई को तार्किक समूहों में व्यवस्थित किया गया है:

सभी एंडपॉइंट के त्वरित संदर्भ के लिए, एपीआई एंडपॉइंट सूची देखें।

प्रतिक्रिया प्रारूप​

सभी एपीआई प्रतिक्रियाएं जेसन प्रारूप में लौटाई जाती हैं जिसमें सुसंगत त्रुटि संभालने के पैटर्न होते हैं। सफल प्रतिक्रियाओं में आमतौर पर एक status फ़ील्ड शामिल होता है, जबकि त्रुटि प्रतिक्रियाओं में error और message फ़ील्ड शामिल होते हैं।

त्रुटि संभालना​

सभी एंडपॉइंट एक सुसंगत त्रुटि संभालने पैटर्न का पालन करते हैं:

  • 400 बुरा अनुरोध: अमान्य अनुरोध डेटा या आवश्यक फ़ील्ड गायब है
  • 401 अनधिकृत: अमान्य या गायब सत्र, समाप्त सत्र, या सीएसआरएफ टोकन सत्यापन विफल
  • 403 निषेधित: ऑपरेशन की अनुमति नहीं है (उदाहरण के लिए, उत्पादन में बैकअप हटाना) या सीएसआरएफ टोकन सत्यापन विफल
  • 404 नहीं मिला : संसाधन नहीं मिला
  • 409 संघर्ष: डुप्लिकेट डेटा (अपलोड एंडपॉइंट के लिए)
  • 413 पेलोड बहुत बड़ा: /api/upload शरीर कॉन्फ़िगर किए गए आकार सीमा से अधिक है
  • 429 बहुत अधिक अनुरोध: अपलोड, रीड-एपीआई, या प्रमाणीकरण-विफलता दर सीमा पार हो गई
  • 500 आंतरिक सर्वर त्रुटि: विस्तृत त्रुटि संदेश के साथ सर्वर-पक्ष त्रुटियां
  • 503 सेवा अनुपलब्ध: स्वास्थ्य जांच विफलताएं, डेटाबेस कनेक्शन समस्याएं, या क्रॉन सेवा अनुपलब्ध

त्रुटि प्रतिक्रियाएं शामिल करती हैं:

  • error: मानव-पठनीय त्रुटि संदेश
  • message: तकनीकी त्रुटि विवरण (विकास मोड में)
  • stack: त्रुटि स्टैक ट्रेस (विकास मोड में)
  • timestamp: जब त्रुटि हुई थी

डेटा प्रकार नोट्स​

संदेश सरणियाँ​

messages_array, warnings_array, और errors_array फ़ील्ड को डेटाबेस में जेसन स्ट्रिंग के रूप में संग्रहीत किया जाता है और एपीआई प्रतिक्रियाओं में सरणियों के रूप में लौटाया जाता है। इनमें डुप्लिकाटी बैकअप ऑपरेशन से वास्तविक लॉग संदेश, चेतावनियाँ और त्रुटियाँ शामिल हैं।

उपलब्ध बैकअप​

available_backups फ़ील्ड में बैकअप संस्करण टाइमस्टैम्प (आईएसओ प्रारूप में) की एक सरणी शामिल है जो पुनर्स्थापना के लिए उपलब्ध है। यह बैकअप लॉग संदेश से निकाला गया है।

अवधि क्षेत्र​

  • duration: मानव द्वारा पठनीय प्रारूप (जैसे, "00:38:31")
  • duration_seconds: सेकंड में कच्ची अवधि
  • durationInMinutes: चार्टिंग के उद्देश्यों के लिए मिनटों में परिवर्तित अवधि

फ़ाइल आकार क्षेत्र​

सभी फ़ाइल आकार क्षेत्रों को संख्याओं के रूप में बाइट्स में लौटाया जाता है, प्रारूपित स्ट्रिंग्स के बजाय। इन्हें मानव द्वारा पठनीय प्रारूपों (KB, MB, GB, आदि) में परिवर्तित करना फ्रंटएंड की जिम्मेदारी है।


सावधान

duplistatus सर्वर को सार्वजनिक इंटरनेट पर प्रकाशित न करें। इसका उपयोग एक सुरक्षित नेटवर्क में करें (जैसे, फ़ायरवॉल द्वारा सुरक्षित स्थानीय LAN)।

duplistatus इंटरफ़ेस को सार्वजनिक इंटरनेट पर उचित सुरक्षा उपायों के बिना प्रकाशित करने से अनधिकृत पहुंच हो सकती है।