Memeriksa status deployment proxy API Anda menggunakan API

Bagian ini menjelaskan cara memeriksa status deployment proxy API menggunakan Apigee API.

  1. Deploy proxy API pengujian seperti yang dijelaskan dalam Membuat dan men-deploy proxy API baru.
  2. Cari file JSON dengan kunci akun layanan Admin Organisasi Apigee. Akun layanan dan kunci ini dibuat di Aktifkan akses sinkronisasi.
  3. Jalankan dua perintah berikut untuk mendapatkan token: 
    export GOOGLE_APPLICATION_CREDENTIALS=org-admin-service-account-file
export TOKEN=$(gcloud auth application-default print-access-token)

    Dengan org-admin-service-account-file adalah jalur di sistem Anda ke layanan kunci akun yang didownload dengan peran Apigee Organization Admin.

  4. Panggil revisi API, dengan bagian-bagian berikut:
    • URL Dasar: https://apigee.googleapis.com/v1
    • URL endpoint: /organizations/my-organization/environments/test/apis/myproxy/revisions/1/deployments
    • Protocol: HTTPS
    • Metode: GET
    • Header: "Authorization: Bearer $TOKEN"

    Contoh berikut memanggil API revisi deployment dengan setelan ini menggunakan curl:

    curl "https://apigee.googleapis.com/v1/organizations/my-organization/environments/test/apis/myproxy/revisions/1/deployments" \
-X GET -H "Authorization: Bearer $TOKEN"

    Anda akan melihat respons seperti berikut:

    {
  "environment": "test",
  "apiProxy": "myproxy",
  "revision": "1",
  "deployStartTime": "1616787712821",
  "state": "READY",
  "instances": [
    {
      "instance": "hybrid-docs-id",
      "deployedRevisions": [
        {
          "revision": "2",
          "percentage": 100
        }
      ],
      "deployedRoutes": [
        {
          "basepath": "/myproxy",
          "envgroup": "test-group",
          "environment": "test",
          "percentage": 100
        }
      ]
    }
  ]
}

    Contoh respons ini menunjukkan status proxy API adalah READY, yang menunjukkan keberhasilan deployment.

    Jika Anda mendapatkan respons kosong atau error, pastikan:

    • Anda menggunakan URL dasar yang benar. Perlu diperhatikan bahwa URL dasar campuran tidak sama dengan URL dasar Edge API. Menggunakan https://apigee.googleapis.com/v1.
    • Anda menggunakan URL endpoint yang benar. Perhatikan bahwa revisinya adalah "1" dan endpoint-nya adalah /organizations/my_organization/environments/test/apis/myproxy/revisions/1/deployments. Jika Anda menetapkan revisi yang tidak ada, permintaan akan menghasilkan respons kosong seperti berikut ini: 
      { }
    • Anda memiliki izin untuk mengakses organisasi yang ditentukan dalam permintaan.
    • Masa berlaku token Anda belum berakhir. Jika sudah, buat ulang yang baru seperti yang dijelaskan di Dapatkan token akses OAuth 2.0.
    • Anda menggabungkan header "Authorization: Bearer $TOKEN" dalam tanda kutip.