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

फ़िलहाल, Apigee Edge के दस्तावेज़ देखे जा रहे हैं.
पर जाएं Apigee X दस्तावेज़. info

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

API हब कनेक्टर इंटिग्रेशन की सेटिंग देखना

किसी संगठन के लिए, 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_TOKENOAuth टोकन है. इसका इस्तेमाल, अनुरोध की पुष्टि करने के लिए किया जाता है. OAuth टोकन बनाने के बारे में ज़्यादा जानने के लिए, टोकन पाना लेख पढ़ें.

अनुरोध के पूरा होने पर, आपको ऐसा जवाब मिलेगा:

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

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

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

एक साथ कई चीज़ों की स्थिति देखना

एक साथ कई चीज़ों की स्थिति देखने के लिए, Edge मैनेजमेंट एपीआई को 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: संगठन, कोल्ड ट्रांसफ़र की स्थिति में है. इस स्थिति में, मौजूदा सभी प्रॉक्सी को API हब पर अपलोड किया जा रहा है. यह स्थिति तब दिखती है, जब संगठन को हाल ही में जोड़ा गया हो और उसे तैयार किया जा रहा हो.
  • Processing: संगठन, लगातार अपडेट होने की स्थिति में है. इस स्थिति में, प्रॉक्सी और एनवायरमेंट में किए गए बदलावों को लगातार API हब पर अपलोड किया जा रहा है.
lastUpdated इस संगठन के लिए, प्रोसेस किए गए आखिरी इवेंट का टाइमस्टैंप.
components एक मैप, जिसमें प्रोसेस की गई प्रॉक्सी और एनवायरमेंट के बारे में पूरी जानकारी दी गई है. इस मैप में ये कुंजियां शामिल हो सकती हैं:
  • proxy: Edge सिस्टम में मौजूद उन एपीआई प्रॉक्सी की संख्या के बारे में पूरी जानकारी देता है जिन्हें प्रोसेस किया गया है और API हब पर अपलोड किया गया है.
  • environment: Edge सिस्टम में मौजूद उन एनवायरमेंट की संख्या के बारे में पूरी जानकारी देता है जिन्हें प्रोसेस किया गया है और API हब पर अपलोड किया गया है.
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 गड़बड़ी की रिपोर्ट.