Menjadwalkan tugas monetisasi

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

Ringkasan tugas terjadwal

Monetisasi menyediakan penjadwal tugas dan serangkaian tugas yang telah dijadwalkan sebelumnya untuk dijalankan pada waktu yang ditentukan.

Tabel di bawah mencantumkan tugas yang telah dijadwalkan yang disediakan oleh monetisasi dan waktu tugas tersebut dijadwalkan untuk dijalankan (semua waktu yang tercantum dalam UTC). Pemicu untuk setiap tugas juga tercantum.

Selain tugas yang tercantum di atas, ada tugas yang dapat Anda aktifkan melalui notifikasi peristiwa, seperti yang tercantum dalam tabel berikut. Untuk mengetahui informasi selengkapnya, lihat Menyiapkan notifikasi.

Mengelola jadwal tugas monetisasi menggunakan API

Bagian berikut menjelaskan cara mengelola jadwal tugas monetisasi menggunakan API:

• Mengonfigurasi pemicu
• Membuat ekspresi cron
• Melihat tugas terjadwal menggunakan API
• Memperbarui tugas terjadwal menggunakan API
• Menonaktifkan dan mengaktifkan kembali tugas terjadwal menggunakan API

Untuk mengetahui informasi selengkapnya tentang API yang dijelaskan di bagian ini, lihat Tugas terjadwal dalam referensi API.

Mengonfigurasi pemicu

Penjadwal mengandalkan pemicu untuk menjalankan tugas. Tugas terjadwal dijalankan saat pemicu terkait dijalankan. Properti pemicu mengonfigurasi eksekusi tugas, dan dengan menetapkan nilai properti ini, Anda dapat mengontrol karakteristik eksekusi tugas seperti kapan tugas dieksekusi, dan seberapa sering.

Dua jenis pemicu yang paling umum adalah pemicu cron dan pemicu sederhana. Pemicu cron memiliki properti cronExpression yang menentukan jadwal eksekusi. Pemicu sederhana tidak memiliki properti cronExpression; Anda menentukan startTime untuk menunjukkan kapan pemicu mulai berlaku, dan opsional endTime.

Properti pemicu adalah sebagai berikut (semua waktu yang tercantum dalam UTC):

Membangun ekspresi cron

Ekspresi cron adalah string yang terdiri dari enam atau tujuh kolom yang dipisahkan oleh spasi kosong. Ekspresi mewakili serangkaian waktu, biasanya sebagai jadwal untuk menjalankan rutinitas. Ekspresi Cron yang ditentukan dalam properti cronExpression pemicu digunakan untuk menjadwalkan eksekusi pemicu tersebut.

Dengan:

Karakter khusus didefinisikan sebagai berikut:

Berikut beberapa contoh ekspresi cron (semua waktu yang tercantum menggunakan zona waktu UTC):

Melihat tugas terjadwal menggunakan API

Anda dapat melihat semua tugas yang dijadwalkan saat ini dengan mengirimkan permintaan GET ke /triggers?orgid={org_name}.

Contoh:

$ curl -H "Accept:application/json" -X GET \ "http://localhost:8080/v1/mint/triggers?orgid={org_name}" \ -u email:password

Berikut adalah contoh respons:

[ {
  "createdDate" : 1457924378176,
  "cronExpression" : "3 0 0 * * ?",
  "enabled" : true,
  "group" : "management-server",
  "id" : "MINT.RESET_DEVELOPER_RATE_PLAN_COUNTER@@@management-server@@@DEFAULT@@@management-server@@@DEFAULT",
  "jobId" : "MINT.RESET_DEVELOPER_RATE_PLAN_COUNTER@@@management-server",
  "name" : "MINT.RESET_DEVELOPER_RATE_PLAN_COUNTER@@@management-server@@@DEFAULT",
  "priority" : "1",
  "suiteId" : "DEFAULT",
  "triggerDataMap" : {
    "custom_lock_key" : "mint.scheduler.__ORG_ID__.resetdeveloperrateplancounter@@@management"
  },
  "updatedDate" : 1457924378176
}, {
  "createdDate" : 1457924378014,
  "cronExpression" : "",
  "enabled" : true,
  "group" : "management-server",
  "id" : "MINT.ADHOC_NOTIFY@@@management-server@@@DEFAULT@@@management-server@@@DEFAULT",
  "jobId" : "MINT.ADHOC_NOTIFY@@@management-server",
  "name" : "MINT.ADHOC_NOTIFY@@@management-server@@@DEFAULT",
  "priority" : "4",
  "startTime" : "1372916749000",
  "suiteId" : "DEFAULT",
  "triggerDataMap" : {
    "custom_lock_key" : "mint.scheduler.__ORG_ID__.adhocnotify@@@management"
  },
  "updatedDate" : 1457924378014
}, {
  "createdDate" : 1457924377877,
  "cronExpression" : "0 20 1 * * ?",
  "enabled" : true,
  "group" : "management-server",
  "id" : "MINT.CHARGE_DAILY@@@management-server@@@DEFAULT@@@management-server@@@DEFAULT",
  "jobId" : "MINT.CHARGE_DAILY@@@management-server",
  "name" : "MINT.CHARGE_DAILY@@@management-server@@@DEFAULT",
  "priority" : "1",
  "suiteId" : "DEFAULT",
  "triggerDataMap" : {
    "custom_lock_key" : "mint.scheduler.__ORG_ID__.chargedaily@@@management"
  },
  "updatedDate" : 1457924377877
},
...
]

Anda juga dapat melihat tugas terjadwal tertentu dengan mengirimkan permintaan GET ke /triggers/{trig_id}, dengan {trig_id} adalah identifikasi pemicu tugas seperti yang dijelaskan dalam Ringkasan tugas terjadwal. Contoh:

$ curl -X GET \ "http://localhost:8080/v1/mint/triggers/MINT.RENEW_DEV_RATEPLAN@@@management-server@@@DEFAULT@@@management-server@@@DEFAULT" \ -u email:password

Berikut adalah contoh respons:

{
    "createdDate" : 1457924377925,
    "cronExpression" : "0 20 2 * * ?",
    "enabled" : true,
    "group" : "management-server",
    "id" : "MINT.RENEW_DEV_RATEPLAN@@@management-server@@@DEFAULT@@@management-server@@@DEFAULT",
    "jobId" : "MINT.RENEW_DEV_RATEPLAN@@@management-server",
    "name" : "MINT.RENEW_DEV_RATEPLAN@@@management-server@@@DEFAULT",
    "priority" : "1",
    "suiteId" : "DEFAULT",
    "triggerDataMap" : {
        "custom_lock_key" : "mint.scheduler.__ORG_ID__.renewydevrateplan@@@management"
    },
    "updatedDate" : 1457924377925
}

Memperbarui tugas terjadwal menggunakan API

Anda dapat memperbarui tugas terjadwal dengan mengubah properti pemicunya. Misalnya, Anda mungkin perlu mengubah jadwal eksekusi pemicu.

Untuk tugas pemicu cron (yaitu, tugas yang menyertakan nilai ekspresi cron), Anda hanya dapat mengubah nilai properti cronExpression dan enabled. Perubahan lainnya akan diabaikan. Untuk tugas yang tidak menentukan nilai ekspresi cron, Anda dapat mengubah properti lain seperti startTime atau priority.

Untuk memperbarui tugas terjadwal, kirim permintaan PUT ke /triggers/{trig_id}, dengan {trig_id} adalah identifikasi pemicu tugas, seperti yang dijelaskan dalam Ringkasan tugas terjadwal. Saat melakukan pembaruan, Anda harus menentukan di isi permintaan setelan yang diperbarui dan ID pemicu.

Misalnya, permintaan berikut memperbarui ekspresi cron untuk tugas Perpanjangan Paket Tarif Developer Baru agar berjalan setiap hari pada pukul 05.00 UTC:

$ curl -H "Content-Type: application/json" -X PUT -d \
 '{
    "cronExpression" : "0 0 5 * * ?",
    "enabled" : true,
    "group" : "management-server", 
    "id" : "MINT.RENEW_DEV_RATEPLAN@@@management-server@@@DEFAULT@@@management-server@@@DEFAULT",
    "jobId" : "MINT.RENEW_DEV_RATEPLAN@@@management-server",
    "name" : "MINT.RENEW_DEV_RATEPLAN@@@management-server@@@DEFAULT",
    "priority" : "1",
    "suiteId" : "DEFAULT",
    "triggerDataMap" : {
        "custom_lock_key" : "mint.scheduler.__ORG_ID__.renewydevrateplan@@@management"
    },
}' \
https://localhost:8080/v1/mint/triggers/MINT.RENEW_DEV_RATEPLAN@@@management-server@@@DEFAULT@@@management-server@@@DEFAULT
\
-u email:password

Menonaktifkan dan mengaktifkan kembali tugas terjadwal menggunakan API

Untuk menonaktifkan tugas terjadwal, tetapkan nilai properti enabled pemicunya ke false. Contoh:

$ curl -H "Content-Type: application/json" -X PUT -d \
 '{
    "cronExpression" : "0 0 5 * * ?",
    "enabled" : false,
    "group" : "management-server",
    "id" : "MINT.RENEW_DEV_RATEPLAN@@@management-server@@@DEFAULT@@@management-server@@@DEFAULT",
    "jobId" : "MINT.RENEW_DEV_RATEPLAN@@@management-server",
    "name" : "MINT.RENEW_DEV_RATEPLAN@@@management-server@@@DEFAULT",
    "priority" : "1",
    "suiteId" : "DEFAULT",
    "triggerDataMap" : {
        "custom_lock_key" : "mint.scheduler.__ORG_ID__.renewydevrateplan@@@management"
    },
}' \
https://localhost:8080/v1/mint/triggers/MINT.RENEW_DEV_RATEPLAN@@@management-server@@@DEFAULT@@@management-server@@@DEFAULT
\
-u email:password

Untuk mengaktifkan kembali tugas yang dinonaktifkan, tetapkan nilai properti enabled pemicunya ke true.

Langkah berikutnya

Sebaiknya lakukan sinkronisasi ulang secara berkala dengan monetisasi organisasi Anda dan semua developer, aplikasi, dan produk yang Anda buat menggunakan Layanan API Edge. Pelajari caranya di Menyinkronkan data Apigee Edge dengan monetisasi.