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

क्रॉन सेवा प्रबंधन

क्रॉन कॉन्फ़िगरेशन प्राप्त करें - /api/cron-config​

  • एंडपॉइंट: /api/cron-config

  • विधि: GET

  • विवरण: वर्तमान क्रॉन सेवा कॉन्फ़िगरेशन पुनः प्राप्त करता है।

  • प्रमाणीकरण: वैध सत्र और CSRF टोकन की आवश्यकता है

  • प्रतिक्रिया:

    {
      "cronExpression": "*/20 * * * *",
      "enabled": true
    }

  • त्रुटि प्रतिक्रियाएं:

    • 500: क्रॉन कॉन्फ़िगरेशन प्राप्त करने में विफल

  • नोट:

    • वर्तमान क्रॉन सेवा कॉन्फ़िगरेशन लौटाता है
    • क्रॉन एक्सप्रेशन और सक्षम स्थिति शामिल करता है
    • क्रॉन सेवा प्रबंधन के लिए उपयोग किया जाता है

क्रॉन कॉन्फ़िगरेशन अद्यतन करें - /api/cron-config​

  • एंडपॉइंट: /api/cron-config

  • विधि: POST

  • विवरण: क्रॉन सेवा कॉन्फ़िगरेशन अद्यतन करता है।

  • प्रमाणीकरण: मान्य सत्र और सीएसआरएफ टोकन की आवश्यकता है

  • अनुरोध निकाय:

    {
      "interval": "20min"
    }

  • प्रतिक्रिया:

    {
      "success": true
    }

  • उपलब्ध अंतराल: "disabled", "1min", "5min", "10min", "15min", "20min", "30min", "1hour", "2hours"

  • त्रुटि प्रतिक्रियाएं:

    • 400: अंतराल आवश्यक है
    • 500: क्रॉन कॉन्फ़िगरेशन अद्यतन करने में विफल

  • नोट:

    • क्रॉन सेवा कॉन्फ़िगरेशन अद्यतन करता है
    • अनुमत विकल्पों के खिलाफ अंतराल को मान्य करता है
    • अतिदेय बैकअप जांच आवृत्ति को प्रभावित करता है

क्रॉन सेवा प्रॉक्सी - /api/cron/*​

  • एंडपॉइंट: /api/cron/*

  • विधि: GET, POST

  • विवरण: क्रॉन सेवा पर अनुरोध प्रॉक्सी करता है। यह एंडपॉइंट एक अलग पोर्ट पर चल रही क्रॉन सेवा पर सभी अनुरोधों को अग्रेषित करता है।

  • प्रमाणीकरण: मान्य सत्र और CSRF टोकन की आवश्यकता है। प्रमाणित उपयोगकर्ताओं के लिए GET की अनुमति है; POST (प्रारंभ/रोकें/ट्रिगर/पुनः लोड) को व्यवस्थापक की आवश्यकता होती है।

  • पैरामीटर:

    • *: कोई भी पथ जिसे क्रॉन सेवा पर अग्रेषित किया जाएगा

  • प्रतिक्रिया: एक्सेस किए जा रहे क्रॉन सेवा एंडपॉइंट पर निर्भर करता है

  • त्रुटि प्रतिक्रिया (503):

    {
      "error": "Cron service is not running",
      "message": "The cron service is not available. Please start it with: npm run cron:start"
    }

  • नोट:

    • 127.0.0.1 पर क्रॉन सेवा पर अनुरोध प्रॉक्सी करता है
    • जब सेट हो तो CRON_SERVICE_SECRET को X-Cron-Service-Secret के रूप में अग्रेषित करता है
    • यदि क्रॉन सेवा उपलब्ध नहीं है तो 503 लौटाता है
    • GET और POST दोनों विधियों का समर्थन करता है
    • वेब इंटरफेस से क्रॉन सेवा प्रबंधन के लिए उपयोग किया जाता है
    • क्रॉन सेवा द्वारा POST /trigger/daily-summary-dispatch को अस्वीकार कर दिया जाता है; इसके बजाय /api/configuration/daily-summary/send का उपयोग करें
    • POST /trigger/database-compact साप्ताहिक कॉम्पैक्ट तुरंत चलाता है (अनाथ बैकअप/सर्वर और सूचना सेटिंग्स, साथ ही SQLite VACUUM)