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

أنت الآن بصدد الاطّلاع على مستندات 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 Gateway الذي ترتبط به مؤسسة Apigee Edge هذه.

التحقّق من الحالة المجمّعة

للحصول على حالة مجمّعة تتضمّن تفاصيل تقدّم عملية التحميل، أرسِل طلب GET إلى واجهة برمجة تطبيقات إدارة Edge:

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 إلى أنّه لم يتم تقديم المَعلمة.