בדיקת הסטטוס וההגדרות של השילוב

אתם צופים במסמכי התיעוד של Apigee Edge.
אפשר לעבור אל מסמכי התיעוד של Apigee X. מידע

בדף הזה מוסבר איך לבדוק את הסטטוס וההגדרות של השילוב של מחבר מרכז ה-API של Apigee Edge בארגון Apigee Edge אחרי שהוא מופעל.

בדיקת הגדרות השילוב של מחבר API Hub

כדי לאחזר את הגדרות השילוב של מחבר ה-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 מאשר שהשילוב של המחבר של מרכז ה-API מופעל בארגון.

‫"gatewayId" מציג את שם משאב המופע שאליו מחובר הארגון הזה ב-Apigee Edge.

בדיקת הסטטוס המאוחד

כדי לקבל סטטוס מאוחד שכולל את התקדמות ההעלאה, שולחים בקשת GET אל Edge Management API:

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

כאשר:

  • ‫ORG_NAME הוא השם של הארגון שלכם ב-Apigee Edge.

תגובה מאוחדת מוצלחת תיראה בערך כך, ותציג את התקדמות ההעלאה של שרתי proxy וסביבות. בדוגמה הבאה אפשר לראות שלב 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: הארגון נמצא במצב של העברה קרה, שבו כל ה-proxy הקיימים מועלים למרכז ה-API. הסטטוס הזה מוצג כשהארגון נוסף לאחרונה ונמצא בהכנה.
  • ‫Processing: הארגון נמצא במצב של עדכון מתמשך, שבו שינויים בשרתי proxy ובסביבות מועלים באופן רציף אל API Hub.
lastUpdated חותמת הזמן של האירוע האחרון שעובד עבור הארגון הזה.
components מפה שמספקת מידע מפורט על השרתים הפרוקסי והסביבות שעברו עיבוד. המפה יכולה להכיל את המפתחות הבאים:
  • ‫proxy: מספק ספירות מפורטות של שרתי proxy ל-API במערכת Edge שעברו עיבוד והועלו אל API Hub.
  • ‫environment: מספק ספירות מפורטות של סביבות במערכת Edge שעברו עיבוד והועלו אל API Hub.
progress הערכים בקטע proxy או environment הם:
  • ‫totalItems: המספר הכולל של הפריטים.
  • ‫pendingItems: מספר הפריטים שממתינים לעיבוד.
  • ‫completedItems: מספר הפריטים שהושלמו בהצלחה.
  • ‫failedItems: מספר הפריטים שההעלאה שלהם נכשלה.

בדיקת סטטוס ההעלאה המפורט

אפשר לבדוק את הסטטוס המפורט של סביבה או של שרת proxy ספציפי ל-API, או של קבוצת פריטים שסוננו לפי מצב, באמצעות נקודת הקצה /details ופרמטרים של שאילתות.

סטטוס של פריט ספציפי

כדי לבדוק את הסטטוס המפורט של פריט מסוים, משתמשים בפרמטרים של השאילתה filter ו-name. כדי להפעיל את API הסטטוס עבור פרוקסי API בשם myproxy בארגון acme, משתמשים בפקודה הבאה:

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

כדי להפעיל את API הסטטוס בסביבה בשם myenv בארגון acme, משתמשים בפקודה הבאה:

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

הפעלת ה-API שלמעלה תניב פלט JSON שדומה לזה של פרוקסי שהועלה לאחרונה:

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

סטטוס מפורט עם פרטי הגרסה

אפשר לקבל מידע על תיקון ספציפי של שרת proxy על ידי הוספת פרמטר שאילתה נוסף showRevisions=true. הפלט שנוצר כאן יספק פרטים על כל שינוי גרסה שהועלה לשרת proxy נתון.

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

קריאה ל-API שלמעלה עם הפרמטר 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.

כדי לקבל את הסטטוס של כל שרתי ה-proxy ל-API שנמצאים במצב failed בארגון acme, קוראים ל-API של הסטטוס באופן הבא:

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

באופן דומה, כדי לקבל רשימה מפורטת של כל הסביבות שנמצאות בסטטוס בהמתנה להעלאה בארגון acme, צריך לשלוח קריאה ל-API של הסטטוס באופן הבא:

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

התוצאה של קריאה ל-API הזה תהיה אוסף 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"
  }
]

פרמטרים של שאילתה לסטטוס מפורט

ה-API מספק שלושה פרמטרים של שאילתה. הערכים הם תלויי אותיות רישיות.

פרמטר שאילתה ערכים אפשריים תיאור
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 שממתינים להעלאה או להעלאה מחדש.
proxy NULL myproxy פרטי סטטוס הדוח עבור שרת proxy בשם myproxy.
proxy NON-NULL NON-NULL דיווח על שגיאה.
environment all NULL פרטי סטטוס הדוח לכל הסביבות.
environment failed NULL פרטים על סטטוס הדוח לגבי כל הסביבות שההעלאה שלהן נכשלה.
environment pending NULL פרטים על סטטוס הדיווח של כל הסביבות שממתינות להעלאה או להעלאה מחדש.
environment NULL myenv דיווח על פרטי הסטטוס של סביבה בשם myenv.
environment NON-NULL NON-NULL דיווח על שגיאה.