وضعیت ادغام و تنظیمات را بررسی کنید

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

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

بررسی تنظیمات ادغام کانکتور هاب API

برای بازیابی تنظیمات ادغام رابط هاب 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 به API مدیریت 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
      }
    }
  }
}

فیلدهای وضعیت تجمیع‌شده

میدان توضیحات
phase مرحله پردازش فعلی برای سازمان. مقادیر ممکن عبارتند از:
  • Queued : این سازمان اخیراً اضافه شده و برای پردازش اولیه در صف انتظار قرار دارد.
  • Preparing : سازمان در حالت انتقال سرد قرار دارد که در آن تمام پروکسی‌های موجود در حال آپلود شدن به مرکز API هستند. این حالت زمانی رخ می‌دهد که سازمان اخیراً اضافه شده و در حال آماده‌سازی است.
  • Processing : سازمان در وضعیت به‌روزرسانی مداوم قرار دارد که در آن تغییرات در پروکسی‌ها و محیط‌ها به‌طور مداوم در مرکز API بارگذاری می‌شوند.
lastUpdated مهر زمانی آخرین رویدادی که برای این سازمان پردازش شده است.
components نقشه‌ای که اطلاعات دقیقی در مورد پروکسی‌ها و محیط‌های پردازش‌شده ارائه می‌دهد. این نقشه می‌تواند شامل کلیدهای زیر باشد:
  • proxy : تعداد دقیقی از پروکسی‌های API در سیستم Edge که پردازش و در API hub آپلود شده‌اند را ارائه می‌دهد.
  • environment : تعداد دقیقی از محیط‌های موجود در سیستم Edge که پردازش و در API hub آپلود شده‌اند را ارائه می‌دهد.
progress مقادیر درون بخش‌های proxy یا environment عبارتند از:
  • totalItems : تعداد کل اقلام.
  • pendingItems : تعداد اقلامی که در انتظار پردازش هستند.
  • completedItems : تعداد مواردی که با موفقیت تکمیل شده‌اند.
  • failedItems : تعداد مواردی که در طول آپلود با شکست مواجه شده‌اند.

بررسی وضعیت دقیق آپلود

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

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

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

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 ، API وضعیت را به صورت زیر فراخوانی کنید:

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

وضعیت دقیق با اطلاعات ویرایش

با ارائه یک پارامتر پرس و جوی اضافی showRevisions=true می‌توان اطلاعاتی در مورد نسخه‌های پروکسی جداگانه برای یک پروکسی مشخص دریافت کرد. خروجی تولید شده در اینجا جزئیاتی در مورد هر نسخه‌ای که برای یک پروکسی مشخص آپلود شده است، ارائه می‌دهد.

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 دریافت کنید.

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

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

به طور مشابه، برای دریافت لیست دقیقی از تمام محیط‌هایی که در انتظار آپلود در organization 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 ، باید بر اساس وضعیت (state) نیز فیلتر شوند.
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 خطا گزارش می‌دهد.