بررسی وضعیت و تنظیمات یکپارچه‌سازی

درحال مشاهده اسناد Apigee Edge هستید.
به اسناد Apigee X بروید. اطلاعات

این صفحه نحوه بررسی وضعیت و تنظیمات یکپارچه‌سازی اتصال‌دهنده مرکز Apigee Edge API در سازمان Apigee Edge شما را پس‌از فعال شدن آن شرح می‌دهد.

درحال بررسی تنظیمات یکپارچه‌سازی اتصال‌دهنده مرکز میانای برنامه‌سازی کاربردی

برای بازیابی تنظیمات ادغام اتصال‌دهنده مرکز 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 شما است.

پاسخ موفقیت‌آمیز ادغام‌شده شبیه به پاسخ زیر خواهد بود و پیشرفت بارگذاری را برای پراکسی‌ها و محیط‌ها نشان می‌دهد. مثال زیر یک مرحله 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 را که پردازش و در مرکز میانای برنامه‌سازی کاربردی بارگذاری شده‌اند ارائه می‌دهد.
  • environment: تعداد دقیق محیط‌های سیستم Edge را که پردازش و در مرکز API بارگذاری شده‌اند ارائه می‌دهد.
progress مقادیر درون بخش‌های proxy یا environment عبارت‌اند از:
  • ‫totalItems: تعداد کل موارد.
  • ‫pendingItems: تعداد مواردی که در انتظار پردازش هستند.
  • ‫completedItems: تعداد مواردی که با موفقیت تکمیل شده است.
  • ‫failedItems: تعداد مواردی که درطول بارگذاری ناموفق بودند.

درحال بررسی وضعیت دقیق بارگذاری

بااستفاده از نقطه پایانی /details و پارامترهای پُرسمان، می‌توانید وضعیت دقیق هریک از پراکسی‌های API یا محیط‌ها، یا گروهی از موارد فیلترشده براساس وضعیت را بررسی کنید.

وضعیت برای یک مورد خاص

برای بررسی وضعیت دقیق یک مورد خاص، از پارامترهای پُرسمان 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، می‌توانید وضعیت‌های بارگذاری را برای گروهی از عناصر دریافت کنید.

برای وضعیت همه پراکسی‌های API که در سازمان acme در وضعیت ناموفق هستند، API وضعیت را به‌صورت زیر فراخوانی کنید:

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

نتیجه فراخوانی این 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 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 خطایی را گزارش می‌کند.