Ringkasan Advanced API Operations

Halaman ini berlaku untuk Apigee dan Apigee hybrid.

Lihat Dokumentasi Apigee Edge.

Advanced API Operations (Operasi API) Apigee menyediakan alat untuk membantu Anda memastikan API Anda tetap aktif dan berjalan sebagaimana mestinya. Operasi AAPI secara otomatis mendeteksi pola yang tidak biasa dalam traffic API—yang disebut anomali—seperti mengalami lonjakan latensi atau tingkat error. Anomali dapat menandakan adanya masalah pada performa API Anda. Ketika Operasi AAPI mendeteksi anomali, Anda dapat melihat detailnya di dasbor Peristiwa Anomali dan mengambil tindakan yang sesuai untuk memulihkan perilaku API normal.

Operasi AAPI memungkinkan Anda untuk:

  • Mendeteksi anomali: Laporan Operasi AAPI peristiwa API yang tidak biasa (anomali) di dasbor Peristiwa Anomali.
  • Menyelidiki anomali: Saat Operasi AAPI mendeteksi anomali, Anda dapat melihat perincian untuk mencari tahu di mana dan kapan insiden itu terjadi, dan apa yang memicunya, sehingga Anda dapat memperbaiki situasi dengan cepat.
  • Membuat notifikasi anomali dan siapkan notifikasi agar Apigee mengirimkan pesan kepada Anda saat terjadi insiden. Anda dapat menerima notifikasi melalui beberapa saluran, termasuk email, Slack, PagerDuty, atau webhook.

Untuk mempelajari lebih lanjut tentang anomali, lihat Tentang deteksi anomali.

Peran yang diperlukan untuk AAPI Ops

Untuk menggunakan Operasi AAPI, Anda perlu diberi peran berikut:

  • roles/apigee.readOnlyAdmin
  • roles/logging.viewer
  • roles/monitoring.viewer

Lihat Peran Apigee untuk mempelajari lebih lanjut.

Mengaktifkan Operasi AAPI di organisasi

Untuk menggunakan Operasi AAPI, Anda harus mengaktifkannya di organisasi Anda. Sebelum melakukannya, pertama-tama mendapatkan OAuth 2.0 token akses. Anda kemudian dapat mengaktifkan AAPI Ops menggunakan panggilan API yang meneruskan token akses.

Melihat konfigurasi add-on saat ini

Sebelum mengaktifkan AAPI Ops, periksa untuk melihat apakah sudah diaktifkan dengan membuat panggilan API berikut:

curl "https://apigee.googleapis.com/v1/organizations/YOUR_ORG" \
  -X GET \
  -H "Content-type: application/json" \
  -H "Authorization: Bearer $TOKEN"

dengan YOUR_ORG adalah nama organisasi Anda dan $TOKEN adalah nama organisasi variabel lingkungan untuk Token akses OAuth. Ini akan mengembalikan informasi dasar organisasi Anda, yang mencakup bagian untuk add-on Apigee yang dimulai dengan baris:

"addonsConfig": {

Periksa apakah bagian ini berisi entri yang dimulai dengan "advancedApiOpsConfig", seperti contoh berikut:

"advancedApiOpsConfig": {
          "enabled": "true"
      }

Jika entri ini ada, berarti Operasi AAPI sudah diaktifkan di organisasi. Jika tidak, Anda harus mengaktifkannya seperti yang dijelaskan selanjutnya.

Mengaktifkan Operasi AAPI

Untuk mengaktifkan Operasi AAPI di organisasi dengan konfigurasi default, keluarkan Permintaan POST seperti yang ditunjukkan di bawah ini.

curl "https://apigee.googleapis.com/v1/organizations/ORG:setAddons" \
  -X POST \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-type: application/json" \
  -d '{
    "addonsConfig": {
      "advancedApiOpsConfig": {
          "enabled": "true"
      }
      <Current add-ons configuration>
    }
  }'

dengan <Current add-ons configuration> adalah add-on saat ini konfigurasi Anda. Anda dapat menemukan konfigurasi add-on saat ini sebagai respons terhadap panggilan untuk melihat konfigurasi add-on saat ini. Misalnya, jika konfigurasi add-on saat ini sesuai dengan

"addonsConfig": {
    "integrationConfig": {
        "enabled":"true"
     },
    "monetizationConfig": {
        "enabled":"true"
     }
  },

perintah untuk mengaktifkan AAPI Ops akan 

curl "https://apigee.googleapis.com/v1/organizations/YOUR_ORG:setAddons" \
  -X POST \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-type: application/json" \
  -d '{
    "addonsConfig": {
      "advancedApiOpsConfig": {
          "enabled": "true"
      },
    "integrationConfig": {
          "enabled": "true"
      },
    "monetizationConfig": {
          "enabled": "true"
      }
    }
  }'

Setelah mengirim permintaan, Anda akan melihat respons seperti berikut:

{
  "name": "organizations/apigee-docs-d/operations/0718a945-76e0-4393-a456-f9929603b32c",
  "metadata": {
    "@type": "type.googleapis.com/google.cloud.apigee.v1.OperationMetadata",
    "operationType": "UPDATE",
    "targetResourceName": "organizations/apigee-docs-d",
    "state": "IN_PROGRESS"
  }
}

Menonaktifkan Operasi AAPI di organisasi Anda

Jika karena suatu alasan Anda perlu menonaktifkan Operasi AAPI di organisasi Anda, Anda dapat melakukannya dengan mengeluarkan permintaan POST, dengan meneruskan add-on dalam isi permintaan Anda, seperti yang ditunjukkan di bawah ini.

curl "https://apigee.googleapis.com/v1/organizations/$ORG:setAddons" \
  -X POST \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-type: application/json" \
  -d '{
    "addonsConfig": {
      "advancedApiOpsConfig`": {
          "enabled": "false"
      }
     <Include current add-ons configuration>
    }
  }'

Berikut ini contoh respons yang menunjukkan bahwa operasi sedang berlangsung: 

{
  "name": "organizations/$ORG/operations/06274ffb-8940-41da-836d-781cba190437",
  "metadata": {
    "@type": "type.googleapis.com/google.cloud.apigee.v1.OperationMetadata",
    "operationType": "UPDATE",
    "targetResourceName": "organizations/$ORG",
    "state": "IN_PROGRESS"
  }
}

Untuk mengetahui informasi selengkapnya, lihat Mengonfigurasi add-on API organisasi.