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

אתם צופים במסמכי התיעוד של 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.

תגובה מאוחדת מוצלחת תיראה בערך כך, ותציג את התקדמות ההעלאה של ה-proxies והסביבות. בדוגמה הבאה אפשר לראות שלב 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
      }
    }
  }
}

שדות סטטוס מאוחדים

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

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

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

כדי לבדוק את הסטטוס המפורט של פריט מסוים, משתמשים בפרמטרים של השאילתה filter ו-name. כדי להפעיל את API הסטטוס עבור proxy ל-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 מספק שלושה פרמטרים של שאילתה. הערכים הם תלויי רישיות.

שילובים של פרמטרים לסטטוס מפורט

בטבלה הבאה מוסבר על השילובים האפשריים של פרמטרים שאפשר להעביר אל API בארכיטקטורת REST כדי לקבל סטטוס מפורט. ‫NA מציין שהמערכת תתעלם מהפרמטר. ‫NULL מציין שהפרמטר לא צוין.