L’API di limitazione di utilizzo consente di creare, configurare e monitorare le configurazioni di limitazione di utilizzo.
Metodo | Percorso | Descrizione |
---|---|---|
POST | list/endpointConfigs | Ottieni un elenco delle configurazioni del limite dell’endpoint |
POST | /endpointConfigs | Creare una configurazione di limitazione di endpoint |
POST | /endpointConfigs/{uid} /deploy |
Distribuire una configurazione di limitazione di endpoint |
POST | /endpointConfigs/{uid} /undeploy |
Annullare la distribuzione di una configurazione di limitazione di endpoint |
POST | /endpointConfigs/{uid} /canDeploy |
Controlla se è possibile distribuire o meno una configurazione di limitazione di endpoint |
PUT | /endpointConfigs/{uid} |
Aggiornare la configurazione della limitazione di un endpoint |
GET | /endpointConfigs/{uid} |
Recuperare la configurazione della limitazione di un endpoint |
DELETE | /endpointConfigs/{uid} |
Eliminare una configurazione di limitazione degli endpoint |
Quando viene creata o aggiornata una configurazione, viene eseguito automaticamente un controllo per garantire la sintassi e l’integrità del payload.
Se si verificano alcuni problemi, l’operazione restituisce un avviso o degli errori per facilitare la correzione della configurazione.
Di seguito è riportata la struttura di base di una configurazione di endpoint:
{
"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>
}
},
...
}
}
Il maxHttpConnections Il parametro è facoltativo. Consente di limitare il numero di connessioni aperte da Journey Optimizer al sistema esterno.
Il valore massimo impostabile è 400. Se non viene specificato nulla, il sistema può aprire più di migliaia di connessioni a seconda della scalabilità dinamica del sistema.
`{
"url": "https://api.example.org/data/2.5/*",
"methods": [
"GET"
],
"services": {
"dataSource": {
"maxHttpConnections": 50,
"rating": {
"maxCallsCount": 500,
"periodInMs": 1000
}
}
},
"orgId": "<IMS Org Id>"
}
Quando un canDeploy viene chiamato, il processo convalida la configurazione e restituisce lo stato di convalida identificato dal relativo ID univoco:
"ok" or "error"
I potenziali errori sono:
<!--<given value>-->
: deve essere "dataSource" o "action"Il potenziale avviso è:
ERR_ENDPOINTCONFIG_106: limite configurazione: numero massimo connessioni HTTP non definito: nessuna limitazione per impostazione predefinita
In questa sezione trovi i cinque casi d’uso principali che puoi eseguire per gestire la configurazione dei limiti in Journey Orchestration.
Per facilitare i test e la configurazione, qui è disponibile una raccolta Postman.
Questa raccolta Postman è stata configurata per condividere la raccolta di variabili Postman generata tramite Integrazioni della console di Adobe I/O > Prova > Scarica per Postman, che genera un file di ambiente Postman con i valori delle integrazioni selezionate.
Una volta scaricata e caricata in Postman, è necessario aggiungere tre variabili: {JO_HOST}
,{BASE_PATH}
e {SANDBOX_NAME}
.
{JO_HOST}
: Journey Orchestration URL gateway{BASE_PATH}
: punto di ingresso per l’API. Il valore è “/authoring”{SANDBOX_NAME}
: l’intestazione x-sandbox-name (ad esempio, “prod”) corrispondente al nome della sandbox in cui si svolgeranno le operazioni API. Per ulteriori informazioni, consulta la panoramica delle sandbox.Nella sezione seguente, è disponibile un elenco ordinato delle chiamate API REST per eseguire il caso d’uso.
Caso d’uso n. 1: Creazione e distribuzione di una nuova configurazione dei limiti
Caso d’uso n. 2: Aggiornare e distribuire una configurazione di limitazione di utilizzo non ancora distribuita
Caso d’uso n. 3: Annullare la distribuzione ed eliminare una configurazione di limitazione distribuita
Caso d’uso n. 4: Elimina una configurazione di limite distribuita.
È possibile annullare la distribuzione ed eliminare la configurazione in una sola chiamata API utilizzando il parametro forceDelete.
Caso d’uso n. 5: Aggiornare una configurazione di limite già distribuita