इंटिग्रेशन की स्थिति और सेटिंग देखना

आपको Apigee Edge का दस्तावेज़ दिख रहा है.
Apigee X के दस्तावेज़ पर जाएं. जानकारी

इस पेज पर, Apigee Edge संगठन में Apigee Edge API हब कनेक्टर इंटिग्रेशन की स्थिति और सेटिंग देखने का तरीका बताया गया है. ऐसा तब किया जाता है, जब इसे चालू कर दिया जाता है.

एपीआई हब कनेक्टर इंटिग्रेशन की सेटिंग की जांच की जा रही है

किसी संगठन के लिए, एपीआई हब कनेक्टर इंटिग्रेशन की सेटिंग वापस पाने के लिए, GET अनुरोध करें. इसके लिए, यह अनुरोध भेजें:

curl -X GET https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/uapim/settings -H "Authorization: Bearer OAUTH_TOKEN"

कहां:

  • ORG_NAME आपके Apigee Edge संगठन का नाम है.
  • OAUTH_TOKENवह OAuth टोकन है जिसका इस्तेमाल अनुरोध की पुष्टि करने के लिए किया जाता है. OAuth टोकन बनाने के बारे में ज़्यादा जानने के लिए, टोकन पाना लेख पढ़ें.

सफल रिस्पॉन्स कुछ इस तरह दिखेगा:

  {
    "enabled": true,
    "gatewayId": "my-gateway-id"
  }

"enabled": true पुष्टि करता है कि संगठन के लिए, एपीआई हब कनेक्टर इंटिग्रेशन चालू है.

"gatewayId" उस इंस्टेंस का संसाधन नाम दिखाता है जिससे यह Apigee Edge संगठन कनेक्ट है.

सभी संगठनों को मिलाकर बनाए गए संगठन की स्थिति की जांच की जा रही है

अपलोड की पूरी जानकारी के साथ एक साथ कई स्टेटस पाने के लिए, Edge Management API को GET अनुरोध करें:

curl -X GET https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/uapim/status
  -H "Authorization: Bearer OAUTH_TOKEN

कहां:

  • ORG_NAME आपके Apigee Edge संगठन का नाम है.

समेकित जवाब मिलने पर, आपको कुछ ऐसा दिखेगा. इसमें प्रॉक्सी और एनवायरमेंट के लिए अपलोड करने की प्रोसेस दिखेगी. नीचे दिए गए उदाहरण में, Queued फ़ेज़ दिखाया गया है:

{
  "phase": "Preparing",
  "lastUpdated": "2025-09-15T02:23:50.706Z",
  "components": {
    "proxy": {
      "lastUpdated": "2025-09-15T02:23:50.706Z",
      "progress": {
        "totalItems": 10,
        "pendingItems": 1,
        "completedItems": 9,
        "failedItems": 0
      }
    },
    "environment": {
      "lastUpdated": "2025-09-15T02:23:50.706Z",
      "progress": {
        "totalItems": 5,
        "pendingItems": 0,
        "completedItems": 4,
        "failedItems": 1
      }
    }
  }
}

स्टेटस फ़ील्ड को एक साथ दिखाने की सुविधा

फ़ील्ड ब्यौरा
phase संगठन के लिए, डेटा प्रोसेसिंग का मौजूदा फ़ेज़. इन वैल्यू का इस्तेमाल किया जा सकता है:
  • Queued: संगठन को हाल ही में जोड़ा गया है और शुरुआती प्रोसेसिंग के लिए इसे लाइन में रखा गया है.
  • Preparing: संगठन, कोल्ड ट्रांसफ़र की स्थिति में है. इसमें सभी मौजूदा प्रॉक्सी को एपीआई हब पर अपलोड किया जा रहा है. यह स्थिति तब दिखती है, जब संगठन को हाल ही में जोड़ा गया हो और उसे तैयार किया जा रहा हो.
  • Processing: संगठन लगातार अपडेट हो रहा है. इसमें प्रॉक्सी और एनवायरमेंट में किए गए बदलावों को लगातार API हब पर अपलोड किया जा रहा है.
lastUpdated इस संगठन के लिए प्रोसेस किए गए आखिरी इवेंट का टाइमस्टैंप.
components इस मैप में, प्रोसेस किए गए प्रॉक्सी और एनवायरमेंट के बारे में पूरी जानकारी दी गई है. मैप में ये कुंजियां शामिल हो सकती हैं:
  • proxy: इससे Edge सिस्टम में मौजूद उन एपीआई प्रॉक्सी की पूरी जानकारी मिलती है जिन्हें प्रोसेस किया गया है और एपीआई हब पर अपलोड किया गया है.
  • environment: इससे Edge सिस्टम में मौजूद उन एनवायरमेंट की पूरी जानकारी मिलती है जिन्हें प्रोसेस किया गया है और एपीआई हब पर अपलोड किया गया है.
progress proxy या environment सेक्शन में मौजूद वैल्यू ये हैं:
  • totalItems: आइटम की कुल संख्या.
  • pendingItems: प्रोसेस किए जाने वाले आइटम की संख्या.
  • completedItems: उन आइटम की संख्या जिन्हें प्रोसेस किया जा चुका है.
  • failedItems: अपलोड के दौरान फ़ेल हुए आइटम की संख्या.

अपलोड की गई फ़ाइल की स्थिति की ज़्यादा जानकारी देखना

/details एंडपॉइंट और क्वेरी पैरामीटर का इस्तेमाल करके, किसी एपीआई प्रॉक्सी या एनवायरमेंट या स्थिति के हिसाब से फ़िल्टर किए गए आइटम के ग्रुप का स्टेटस देखा जा सकता है.

किसी सामान का स्टेटस

किसी आइटम की स्थिति के बारे में ज़्यादा जानकारी देखने के लिए, filter और name क्वेरी पैरामीटर का इस्तेमाल करें. संगठन acme में मौजूद myproxy नाम की एपीआई प्रॉक्सी के लिए, स्टेटस एपीआई को इस तरह कॉल करें:

curl -X GET https://api.enterprise.apigee.com/v1/organizations/acme/uapim/status/details?filter=proxy&name=myproxy \
  -H "Authorization: Bearer OAUTH_TOKEN"

संगठन acme में मौजूद myenv नाम के एनवायरमेंट के लिए, स्टेटस एपीआई को इस तरह कॉल करें:

GET http://enterprise.apigee.com/organizations/acme/uapim/status/details?filter=environment&name=myenv

ऊपर दिए गए एपीआई को कॉल करने पर, हाल ही में अपलोड की गई किसी प्रॉक्सी के लिए, JSON आउटपुट इस तरह दिखेगा:

{
  "name": "myProxy",
  "status": "Pending Upload",
  "lastSuccessfulUploadTime": "2025-09-15T02:23:50.706Z",
}

बदलाव की जानकारी के साथ स्टेटस की पूरी जानकारी

किसी प्रॉक्सी के लिए, प्रॉक्सी में किए गए अलग-अलग बदलावों के बारे में जानकारी पाने के लिए, showRevisions=true नाम का एक और क्वेरी पैरामीटर दिया जा सकता है. यहां जनरेट किए गए आउटपुट से, किसी प्रॉक्सी के लिए अपलोड किए गए हर बदलाव के बारे में जानकारी मिलेगी.

GET http://enterprise.apigee.com/organizations/acme/uapim/status/details?filter=proxy&name=myproxy&showRevisions=true

showrevisions पैरामीटर के साथ ऊपर दिए गए एपीआई को कॉल करने पर, JSON आउटपुट इस तरह का होगा:

{
  "name": "myProxy",
  "status": "Pending Upload",
  "lastSuccessfulUploadTime": "2025-09-15T02:23:50.706Z",
  "revisions": [
    {
      "name": "1",
      "status": "Up to date",
      "lastSuccessfulUploadTime": "2025-09-15T02:23:50.706Z",
    },  
    {
      "name": "2",
      "status": "Pending upload",
      "lastSuccessfulUploadTime": "2025-09-15T02:23:55.000Z",
    }  
  ]
}

ग्रुप के अपलोड होने की स्थिति

state क्वेरी पैरामीटर के साथ ग्रुप फ़िल्टर का इस्तेमाल करके, आइटम के ग्रुप के लिए अपलोड की स्थिति की जानकारी पाई जा सकती है.

संगठन acme में मौजूद सभी एपीआई प्रॉक्सी के स्टेटस के लिए, स्टेटस एपीआई को इस तरह कॉल करें. इन एपीआई प्रॉक्सी का स्टेटस फ़ेल हो गया है:

GET http://enterprise.apigee.com/organizations/acme/uapim/status/details?filter=proxy&state=failed

इसी तरह, संगठन acme में अपलोड किए जाने के लिए लंबित सभी एनवायरमेंट की पूरी सूची पाने के लिए, स्टेटस एपीआई को इस तरह कॉल करें:

GET http://enterprise.apigee.com/organizations/acme/uapim/status/details?filter=environment&state=pending

इस एपीआई को कॉल करने पर, फ़िल्टर से मेल खाने वाले स्टेटस आइटम का JSON कलेक्शन मिलेगा. उदाहरण:

[
  {
    "name": "myProxy",
    "status": "last upload failed",
    "lastSuccessfulUploadTime": "2025-09-12T02:23:50.706Z",
    "lastFailedUploadTime": "2025-09-13T02:23:50.706Z",
    "lastUploadError": "Errors connecting to API Hub"
  },
  {
    "name": "secondProxy",
    "status": "last upload failed",
    "lastSuccessfulUploadTime": "2025-09-12T02:23:51.706Z",
    "lastFailedUploadTime": "2025-09-13T02:23:51.706Z",
    "lastUploadError": "Errors connecting to API Hub"
  }
]

स्टेटस की ज़्यादा जानकारी के लिए क्वेरी पैरामीटर

एपीआई, तीन क्वेरी पैरामीटर उपलब्ध कराता है. वैल्यू, केस-सेंसिटिव होती हैं.

क्वेरी पैरामीटर संभावित वैल्यू ब्यौरा
filter proxy, environment इस क्वेरी पैरामीटर से पता चलता है कि नतीजों को किसी प्रॉक्सी या एनवायरमेंट के हिसाब से फ़िल्टर करना है.
state failed, pending, all इस क्वेरी पैरामीटर से पता चलता है कि नतीजों को filter के साथ-साथ राज्य के हिसाब से भी फ़िल्टर करना है.
name किसी आइटम का नाम इस क्वेरी पैरामीटर से पता चलता है कि नतीजों को filter के साथ-साथ नाम के हिसाब से भी फ़िल्टर करना होगा.
showrevisions true, false यह क्वेरी पैरामीटर, दिए जाने पर आउटपुट में संशोधन की स्थिति जनरेट करेगा. यह सिर्फ़ तब मान्य होता है, जब filter=proxy.

स्टेटस की पूरी जानकारी के लिए पैरामीटर के कॉम्बिनेशन

यहां दी गई टेबल में, पैरामीटर के उन संभावित कॉम्बिनेशन के बारे में बताया गया है जिन्हें REST API को पास किया जा सकता है, ताकि स्टेटस के बारे में ज़्यादा जानकारी मिल सके. NA से पता चलता है कि पैरामीटर को अनदेखा किया जाएगा. NULL से पता चलता है कि पैरामीटर नहीं दिया गया है.

फ़िल्टर करें राज्य नाम नतीजे
proxy all NULL सभी प्रॉक्सी के लिए रिपोर्ट की स्थिति की जानकारी.
proxy failed NULL अपलोड नहीं की जा सकीं, उन सभी प्रॉक्सी के लिए रिपोर्ट स्टेटस की जानकारी.
proxy pending NULL उन सभी प्रॉक्सी के लिए रिपोर्ट स्टेटस की जानकारी जो अपलोड या फिर से अपलोड होने के लिए बाकी हैं.
proxy NULL myproxy myproxy नाम के प्रॉक्सी के लिए, रिपोर्ट की स्थिति के बारे में जानकारी दिखाएं.
proxy NON-NULL NON-NULL गड़बड़ी की रिपोर्ट करता है.
environment all NULL सभी एनवायरमेंट के लिए रिपोर्ट की स्थिति की जानकारी.
environment failed NULL उन सभी एनवायरमेंट के लिए रिपोर्ट की स्थिति की जानकारी दें जिनमें अपलोड नहीं हो सका.
environment pending NULL उन सभी एनवायरमेंट के लिए रिपोर्ट स्टेटस की जानकारी जो अपलोड या फिर से अपलोड होने के लिए बाकी हैं.
environment NULL myenv myenv नाम के एनवायरमेंट के लिए, रिपोर्ट की स्थिति के बारे में जानकारी दो.
environment NON-NULL NON-NULL गड़बड़ी की रिपोर्ट करता है.