Ringkasan Advanced API Operations

Halaman ini berlaku untuk Apigee dan Apigee Hybrid.

Baca dokumentasi Apigee Edge.

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

AAPI Ops memungkinkan Anda:

  • Mendeteksi anomali: Operasi AAPI melaporkan 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 tersebut terjadi, serta apa yang memicunya, sehingga Anda dapat memperbaiki situasinya dengan cepat.
  • Buat pemberitahuan anomali dan siapkan notifikasi agar Apigee mengirimi Anda pesan saat terjadi insiden. Anda dapat menerima notifikasi melalui beberapa saluran, termasuk email, Slack, PagerDuty, atau webhook.

Untuk mempelajari anomali lebih lanjut, lihat Tentang deteksi anomali.

Peran yang diperlukan untuk Operasi AAPI

Untuk menggunakan Operasi AAPI, Anda harus diberi peran berikut:

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

Lihat Peran Apigee untuk mempelajari lebih lanjut.

Mengaktifkan AAPI Ops di organisasi

Untuk menggunakan Operasi AAPI, Anda harus mengaktifkannya di organisasi Anda. Sebelum melakukannya, dapatkan token akses OAuth 2.0 terlebih dahulu. Kemudian, Anda dapat mengaktifkan AAPI Ops menggunakan panggilan API yang meneruskan token akses.

Melihat konfigurasi add-on saat ini

Sebelum mengaktifkan Operasi AAPI, periksa apakah sudah diaktifkan dengan melakukan 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 sebagai nama organisasi Anda dan $TOKEN adalah variabel lingkungan untuk token akses OAuth. Tindakan ini akan menampilkan informasi dasar tentang organisasi Anda, yang mencakup bagian untuk add-on Apigee yang dimulai dengan baris:

"addonsConfig": {

Periksa apakah bagian ini berisi entri yang diawali 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 berikutnya.

Aktifkan Operasi AAPI

Untuk mengaktifkan Operasi AAPI di organisasi dengan konfigurasi default, berikan 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 konfigurasi add-on saat ini. 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 adalah

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

perintah untuk mengaktifkan AAPI Ops adalah 

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 alasan tertentu Anda perlu menonaktifkan Operasi AAPI di organisasi, Anda dapat melakukannya dengan mengajukan permintaan POST, dengan meneruskan konfigurasi add-on dalam isi permintaan, 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 adalah 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 informasi selengkapnya, lihat Mengonfigurasi API add-on organisasi.