Memeriksa status dan setelan integrasi

Anda sedang melihat dokumentasi Apigee Edge.
Buka dokumentasi Apigee X. info

Halaman ini menjelaskan cara memeriksa status dan setelan integrasi konektor hub API Apigee Edge di organisasi Apigee Edge Anda setelah diaktifkan.

Memeriksa setelan integrasi konektor hub API

Untuk mengambil setelan integrasi hub connector API untuk organisasi, buat permintaan GET untuk mengirim permintaan berikut:

curl -X GET https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/uapim/settings -H "Authorization: Bearer OAUTH_TOKEN"

Dengan:

  • ORG_NAME adalah nama organisasi Apigee Edge Anda.
  • OAUTH_TOKENadalah token OAuth yang digunakan untuk mengautentikasi permintaan. Untuk mengetahui informasi selengkapnya tentang cara membuat token OAuth, lihat Mendapatkan token.

Respons yang berhasil akan terlihat mirip dengan berikut ini:

  {
    "enabled": true,
    "gatewayId": "my-gateway-id"
  }

"enabled": true mengonfirmasi bahwa integrasi konektor hub API diaktifkan untuk organisasi.

"gatewayId" menampilkan Nama Resource Instance yang terhubung dengan organisasi Apigee Edge ini.

Memeriksa status gabungan

Untuk status gabungan yang mencakup progres upload mendetail, buat permintaan GET ke Edge Management API:

curl -X GET https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/uapim/status
  -H "Authorization: Bearer OAUTH_TOKEN

Dengan:

  • ORG_NAME adalah nama organisasi Apigee Edge Anda.

Respons gabungan yang berhasil akan terlihat mirip dengan berikut ini, yang menunjukkan progres upload untuk proxy dan lingkungan. Contoh di bawah menunjukkan fase 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
      }
    }
  }
}

Kolom status gabungan

Kolom Deskripsi
phase Fase pemrosesan saat ini untuk organisasi. Nilai yang mungkin adalah:
  • Queued: Organisasi baru saja ditambahkan dan dimasukkan dalam antrean untuk pemrosesan awal.
  • Preparing: Organisasi berada dalam status transfer dingin di mana semua proxy yang ada diupload ke hub API. Status ini terjadi saat organisasi baru ditambahkan dan sedang disiapkan.
  • Processing: Organisasi berada dalam status update berkelanjutan di mana perubahan pada proxy dan lingkungan terus diupload ke API Hub.
lastUpdated Stempel waktu peristiwa terakhir yang diproses untuk organisasi ini.
components Peta yang memberikan informasi mendetail tentang proxy dan lingkungan yang diproses. Peta dapat berisi kunci berikut:
  • proxy: Memberikan jumlah mendetail proxy API dalam sistem Edge yang diproses dan diupload ke hub API.
  • environment: Memberikan jumlah detail lingkungan dalam sistem Edge yang diproses dan diupload ke API Hub.
progress Nilai dalam bagian proxy atau environment adalah:
  • totalItems: Jumlah total item.
  • pendingItems: Jumlah item yang menunggu diproses.
  • completedItems: Jumlah item yang telah berhasil diselesaikan.
  • failedItems: Jumlah item yang gagal selama upload.

Memeriksa status upload mendetail

Anda dapat memeriksa status mendetail dari setiap proxy API atau lingkungan, atau sekelompok item yang difilter menurut status, dengan menggunakan endpoint /details dan parameter kueri.

Status untuk item tertentu

Untuk memeriksa status mendetail item tertentu, gunakan parameter kueri filter dan name. Untuk proxy API bernama myproxy di organisasi acme, panggil API status sebagai berikut:

curl -X GET https://api.enterprise.apigee.com/v1/organizations/acme/uapim/status/details?filter=proxy&name=myproxy \
  -H "Authorization: Bearer OAUTH_TOKEN"

Untuk lingkungan bernama myenv di organisasi acme, panggil API status sebagai berikut:

GET http://enterprise.apigee.com/organizations/acme/uapim/status/details?filter=environment&name=myenv

Memanggil API di atas akan menghasilkan output JSON yang mirip dengan berikut untuk proxy yang baru saja diupload:

{
  "name": "myProxy",
  "status": "Pending Upload",
  "lastSuccessfulUploadTime": "2025-09-15T02:23:50.706Z",
}

Status mendetail dengan informasi revisi

Anda bisa mendapatkan informasi tentang revisi proxy individual untuk proxy tertentu dengan memberikan parameter kueri tambahan showRevisions=true. Output yang dihasilkan di sini akan memberikan detail tentang setiap revisi yang telah diupload untuk proxy tertentu.

GET http://enterprise.apigee.com/organizations/acme/uapim/status/details?filter=proxy&name=myproxy&showRevisions=true

Memanggil API di atas dengan parameter showrevisions akan menghasilkan output JSON yang mirip dengan berikut:

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

Status upload grup

Anda bisa mendapatkan status upload untuk sekelompok item menggunakan filter grup dengan parameter kueri state.

Untuk status semua proxy API yang dalam status gagal di organisasi acme, panggil API status sebagai berikut:

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

Demikian pula, untuk mendapatkan daftar mendetail semua lingkungan yang menunggu upload di organisasi acme, panggil status API sebagai berikut:

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

Hasil pemanggilan API ini akan berupa kumpulan JSON item status individual yang cocok dengan filter. Contoh:

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

Parameter kueri untuk status mendetail

API menyediakan tiga parameter kueri. Nilai ini peka huruf besar/kecil.

Parameter Kueri Nilai yang mungkin Deskripsi
filter proxy, environment Parameter kueri ini menunjukkan bahwa hasil perlu difilter menurut proxy atau lingkungan.
state failed, pending, all Parameter kueri ini menunjukkan bahwa hasil perlu difilter menurut negara bagian selain filter.
name Nama item tertentu Parameter kueri ini menunjukkan bahwa hasil perlu difilter menurut nama selain filter.
showrevisions true, false Parameter kueri ini, jika diberikan, akan menghasilkan status revisi dalam output (hanya valid jika filter=proxy).

Kombinasi parameter untuk status mendetail

Tabel di bawah menjelaskan kemungkinan kombinasi parameter yang dapat diteruskan ke REST API untuk mendapatkan status mendetail. NA menunjukkan bahwa parameter akan diabaikan. NULL menunjukkan bahwa parameter tidak diberikan.

filter dengan status tersembunyi akhir nama Hasil
proxy all NULL Melaporkan detail status untuk semua proxy.
proxy failed NULL Melaporkan detail status untuk semua proxy yang gagal diupload.
proxy pending NULL Melaporkan detail status untuk semua proxy yang menunggu upload atau upload ulang.
proxy NULL myproxy Laporkan detail status untuk proxy bernama myproxy.
proxy NON-NULL NON-NULL Melaporkan error.
environment all NULL Melaporkan detail status untuk semua lingkungan.
environment failed NULL Melaporkan detail status untuk semua lingkungan yang gagal diupload.
environment pending NULL Melaporkan detail status untuk semua lingkungan yang menunggu upload atau upload ulang.
environment NULL myenv Laporkan detail status untuk lingkungan bernama myenv.
environment NON-NULL NON-NULL Melaporkan error.