Mit der Begrenzungs-API können Sie Begrenzungskonfigurationen erstellen, konfigurieren und überwachen.
Methode | Pfad | Beschreibung |
---|---|---|
POST | list/endpointConfigs | Liste der Endpunktbegrenzungskonfigurationen abrufen |
POST | /endpointConfigs | Endpunktbegrenzungskonfiguration erstellen |
POST | /endpointConfigs/{uid} /deploy |
Endpunktbegrenzungskonfiguration bereitstellen |
POST | /endpointConfigs/{uid} /undeploy |
Bereitstellung einer Endpunktbegrenzungskonfiguration aufheben |
POST | /endpointConfigs/{uid} /canDeploy |
Überprüfen, ob eine Endpunktbegrenzungskonfiguration bereitgestellt werden kann oder nicht |
PUT | /endpointConfigs/{uid} |
Endpunktbegrenzungskonfiguration aktualisieren |
GET | /endpointConfigs/{uid} |
Endpunktbegrenzungskonfiguration abrufen |
DELETE | /endpointConfigs/{uid} |
Endpunktbegrenzungskonfiguration löschen |
Bei der Erstellung oder Aktualisierung einer Konfiguration wird automatisch eine Überprüfung durchgeführt, um die Syntax und Integrität der Payload sicherzustellen.
Wenn Probleme auftreten, gibt der Vorgang eine Warnung oder Fehler zurück, die Ihnen beim Korrigieren der Konfiguration helfen.
Die grundlegende Struktur einer Endpunktkonfiguration sieht wie folgt aus:
{
"url": "<endpoint URL>", //wildcards are allowed in the endpoint URL
"methods": [ "<HTTP method such as GET, POST, >, ...],
"services": {
"<service name>": { . //must be "action" or "dataSource"
"maxHttpConnections": <max connections count to the endpoint (optional)>
"rating": {
"maxCallsCount": <max calls to be performed in the period defined by period/timeUnit>,
"periodInMs": <integer value greater than 0>
}
},
...
}
}
Der Parameter maxHttpConnections ist optional. Dadurch können Sie die Anzahl der Verbindungen einschränken, die Journey Optimizer für das externe System öffnet.
Der maximale Wert, der festgelegt werden kann, ist 400. Wenn nichts angegeben ist, kann das System abhängig von seiner dynamischen Skalierung bis zu mehreren tausend Verbindungen öffnen.
`{
"url": "https://api.example.org/data/2.5/*",
"methods": [
"GET"
],
"services": {
"dataSource": {
"maxHttpConnections": 50,
"rating": {
"maxCallsCount": 500,
"periodInMs": 1000
}
}
},
"orgId": "<IMS Org Id>"
}
Wenn eine canDeploy-Methode aufgerufen wird, validiert der Prozess die Konfiguration und gibt den durch seine eindeutige Kennung identifizierten Validierungsstatus zurück:
"ok" or "error"
Mögliche Fehler sind:
<!--<given value>-->
: must be 'dataSource' or 'action'Die potenzielle Warnung lautet:
ERR_ENDPOINTCONFIG_106: capping config: max HTTP connections not defined: no limitation by default
In diesem Abschnitt finden Sie die fünf Hauptanwendungsfälle für die Verwaltung Ihrer Begrenzungskonfiguration in Journey Orchestration.
Um Ihnen bei Tests und der Konfiguration behilflich zu sein, steht Ihnen hier eine Postman-Sammlung zur Verfügung.
Diese Postman-Sammlung wurde eingerichtet, um die Postman-Variablensammlung freizugeben, die über Integrationen der Adobe I/O-Konsole > Testen > Für Postman herunterladen generiert wurde. Dadurch wird eine Postman-Umgebung mit den ausgewählten Integrationswerten erzeugt.
Nach dem Herunterladen und Hochladen in Postman müssen Sie drei Variablen hinzufügen: {JO_HOST}
, {BASE_PATH}
und {SANDBOX_NAME}
.
{JO_HOST}
: Journey Orchestration-Gateway-URL{BASE_PATH}
: Einstiegspunkt für die API. Der Wert lautet „/authoring“{SANDBOX_NAME}
: der Header x-sandbox-name (z. B. „prod“), der dem Sandbox-Namen entspricht, in dem die API-Vorgänge stattfinden. Weiterführende Informationen dazu finden Sie unter Sandbox-Übersicht.Im folgenden Abschnitt finden Sie die sortierte Liste der Rest-API-Aufrufe, um den Anwendungsfall auszuführen.
Anwendungsfall 1: Erstellen und Bereitstellen einer neuen Begrenzungskonfiguration
Anwendungsfall 2: Aktualisieren und Bereitstellen einer noch nicht bereitgestellten Begrenzungskonfiguration
Anwendungsfall 3: Aufheben einer Bereitstellung und Löschen einer bereitgestellten Begrenzungskonfiguration
Anwendungsfall 4: Löschen einer bereitgestellten Begrenzungskonfiguration.
In nur einem API-Aufruf können Sie die Bereitstellung aufheben und die Konfiguration mithilfe des forceDelete-Parameters löschen.
Anwendungsfall 5: Aktualisieren einer bereits bereitgestellten Begrenzungskonfiguration