التحقّق من حالة التكامل والإعدادات

أنت الآن بصدد الاطّلاع على مستندات Apigee Edge.
انتقِل إلى مستندات Apigee X. info

توضّح هذه الصفحة كيفية التحقّق من حالة إعدادات عملية دمج موصّل مركز واجهات برمجة التطبيقات في Apigee Edge في مؤسستك على Apigee Edge بعد تفعيلها.

التحقّق من إعدادات دمج موصّل مركز واجهات برمجة التطبيقات

لاسترداد إعدادات دمج موصّل مركز واجهات برمجة التطبيقات لمؤسسة، أرسِل طلب 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 هذه مرتبطة به.

التحقّق من الحالة الموحّدة

للحصول على حالة مجمّعة تتضمّن تفاصيل حول تقدّم عملية التحميل، أرسِل طلب 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.

ستبدو الاستجابة الموحّدة الناجحة مشابهة لما يلي، حيث تعرض تقدّم عملية تحميل الخوادم الوكيلة والبيئات. يعرض المثال أدناه مرحلة 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
      }
    }
  }
}

حقول الحالة المجمّعة

التحقّق من حالة التحميل التفصيلية

يمكنك التحقّق من الحالة التفصيلية لخادم وكيل فردي لواجهة برمجة التطبيقات أو بيئة أو مجموعة من العناصر التي تم فلترتها حسب الحالة، وذلك باستخدام نقطة النهاية /details ومَعلمات طلب البحث.

حالة سلعة معيّنة

للاطّلاع على الحالة التفصيلية لعنصر معيّن، استخدِم مَعلمتَي طلب البحث filter وname. بالنسبة إلى خادم وكيل لواجهة برمجة التطبيقات اسمه 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"

بالنسبة إلى بيئة باسم myenv في المؤسسة acme، يمكنك طلب واجهة برمجة التطبيقات الخاصة بالحالة على النحو التالي:

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"
  }
]

مَعلمات طلب البحث للحصول على حالة تفصيلية

توفّر واجهة برمجة التطبيقات ثلاث مَعلمات لطلبات البحث. القيم حسّاسة لحالة الأحرف.

مجموعات المَعلمات للحصول على حالة تفصيلية

يوضّح الجدول أدناه مجموعات المَعلمات المحتملة التي يمكن تمريرها إلى واجهة REST API للحصول على حالة تفصيلية. يشير NA إلى أنّه سيتم تجاهل المَعلمة. يشير NULL إلى أنّ المَعلمة غير متوفرة.