Monetarisierungsjobs planen

Sie lesen gerade die Dokumentation zu Apigee Edge.
Apigee X-Dokumentation aufrufen info

Übersicht über geplante Jobs

Monetization bietet einen Jobplaner und eine Reihe von Jobs, die für die Ausführung zu bestimmten Zeiten geplant sind.

In der folgenden Tabelle sind die von der Monetarisierung bereitgestellten vorab geplanten Jobs und die Zeiten aufgeführt, zu denen sie ausgeführt werden sollen (alle Zeiten sind in UTC angegeben). Außerdem wird der Trigger für jeden Job aufgeführt.

Zusätzlich zu den oben aufgeführten Jobs gibt es Jobs, die Sie über Ereignisbenachrichtigungen aktivieren können. Diese sind in der folgenden Tabelle aufgeführt. Weitere Informationen finden Sie unter Benachrichtigungen einrichten.

Zeitplan für Monetarisierungsjobs mit der API verwalten

In den folgenden Abschnitten wird beschrieben, wie Sie den Zeitplan für Monetarisierungsjobs mit der API verwalten:

• Trigger konfigurieren
• Cron-Ausdrücke erstellen
• Geplante Jobs mit der API ansehen
• Geplante Jobs mit der API aktualisieren
• Geplanten Job mit der API deaktivieren und wieder aktivieren

Weitere Informationen zu den in diesem Abschnitt beschriebenen APIs finden Sie in der API-Referenz unter Geplante Jobs.

Trigger konfigurieren

Der Scheduler verwendet Trigger, um Jobs auszuführen. Ein geplanter Job wird ausgeführt, wenn der zugehörige Trigger ausgelöst wird. Mit den Attributen eines Triggers wird die Jobausführung konfiguriert. Durch Festlegen des Werts dieser Attribute können Sie Merkmale der Jobausführung steuern, z. B. wann und wie oft ein Job ausgeführt wird.

Die beiden häufigsten Arten von Triggern sind Cron-Trigger und einfache Trigger. Ein Cron-Trigger hat das Attribut cronExpression, das einen Ausführungszeitplan angibt. Ein einfacher Trigger hat keine cronExpression-Property. Sie geben die startTime an, um festzulegen, wann der Trigger in Kraft tritt, und optional die endTime.

Die Triggereigenschaften sind wie folgt (alle Zeiten sind in UTC angegeben):

Cron-Ausdrücke erstellen

Ein Cron-Ausdruck ist ein String, der aus sechs oder sieben durch Leerzeichen getrennten Feldern besteht. Der Ausdruck stellt eine Reihe von Zeiten dar, normalerweise als Zeitplan für die Ausführung einer Routine. Cron-Ausdrücke, die in der Property cronExpression eines Triggers angegeben sind, werden verwendet, um die Ausführung dieses Triggers zu planen.

Wobei:

Die Sonderzeichen sind so definiert:

Hier sind einige Beispiele für Cron-Ausdrücke (alle Zeiten sind in UTC angegeben):

Geplante Jobs mithilfe der API ansehen

Sie können alle derzeit geplanten Jobs aufrufen, indem Sie eine GET-Anfrage an /triggers?orgid={org_name} senden.

Beispiel:

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

Im Folgenden finden Sie ein Beispiel für die Antwort:

[ {
  "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
},
...
]

Sie können sich auch einen bestimmten geplanten Job ansehen, indem Sie eine GET-Anfrage an /triggers/{trig_id} senden, wobei {trig_id} die ID des Job-Triggers ist, wie unter Übersicht über geplante Jobs beschrieben. Beispiel:

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

Im Folgenden finden Sie ein Beispiel für die Antwort:

{
    "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
}

Geplante Jobs mit der API aktualisieren

Sie können einen geplanten Job aktualisieren, indem Sie die Eigenschaften seines Triggers ändern. Möglicherweise müssen Sie beispielsweise den Ausführungszeitplan des Triggers ändern.

Bei Jobs mit Cron-Trigger (d. h. Jobs mit einem Cron-Ausdruckswert) können Sie nur die Werte der Attribute cronExpression und „enabled“ ändern. Andere Änderungen werden ignoriert. Bei Jobs, für die kein Cron-Ausdruckswert angegeben ist, können Sie andere Eigenschaften wie startTime oder priority ändern.

Wenn Sie einen geplanten Job aktualisieren möchten, senden Sie eine PUT-Anfrage an /triggers/{trig_id}. Dabei ist {trig_id} die Kennzeichnung des Job-Triggers, wie unter Übersicht über geplante Jobs beschrieben. Wenn Sie die Aktualisierung vornehmen, müssen Sie im Anfragetext die aktualisierten Einstellungen und die ID des Triggers angeben.

Mit der folgenden Anfrage wird beispielsweise der Cron-Ausdruck für den Job zur Verlängerung des neuen Entwickler-Tarifs so aktualisiert, dass er täglich um 5:00 Uhr UTC ausgeführt wird:

$ 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

Geplanten Job über die API deaktivieren und wieder aktivieren

Wenn Sie einen geplanten Job deaktivieren möchten, legen Sie den Wert des Attributs enabled seines Triggers auf „false“ fest. Beispiel:

$ 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

Wenn Sie einen deaktivierten Job wieder aktivieren möchten, legen Sie den Wert des Attributs enabled seines Triggers auf „true“ fest.

Nächste Schritte

Es empfiehlt sich, Ihre Organisation und alle Entwickler, Anwendungen und Produkte, die Sie mit Edge API Services erstellt haben, regelmäßig mit der Monetarisierung zu synchronisieren. Informationen zum Synchronisieren von Apigee Edge-Daten mit der Monetarisierung