Ringkasan Operasi API Lanjutan

Halaman ini berlaku untuk Apigee dan Apigee Hybrid.

Lihat dokumentasi Apigee Edge.

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

AAPI Ops memungkinkan Anda untuk:

• Mendeteksi anomali: Operasi AAPI melaporkan peristiwa API yang tidak biasa (anomali) di dasbor Peristiwa Anomali.
• Menyelidiki anomali: Saat AAPI Ops mendeteksi anomali, Anda dapat melihat perincian untuk mengetahui di mana dan kapan insiden terjadi, serta apa yang memicunya, sehingga Anda dapat dengan cepat mengatasi situasi tersebut.
• Buat pemberitahuan 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 anomali lebih lanjut, lihat Tentang deteksi anomali.

Peran yang diperlukan untuk Operasi AAPI

Untuk menggunakan AAPI Ops, Anda harus 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, dapatkan token akses OAuth 2.0 terlebih dahulu. Kemudian, Anda dapat mengaktifkan Operasi AAPI 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 adalah 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 dimulai dengan "advancedApiOpsConfig", seperti contoh berikut:

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

Jika entri ini ada, AAPI Ops 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, kirim permintaan POST seperti yang ditunjukkan di bawah.

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 dalam 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 Operasi AAPI 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, Anda dapat melakukannya dengan mengirimkan permintaan POST, meneruskan konfigurasi add-on di 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 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 mengetahui informasi selengkapnya, lihat Configure organization add-ons API.