Prerequisiti CLI

Prima di utilizzare la CLI per gestire i percorsi, installa l'ultimo plugin CLI V2 Activity Tracker Event Routing nel tuo sistema locale. Vedere Installazione della CLI Activity Tracker Event Routing.

Successivamente, accedi a IBM Cloud. Esegui il seguente comando: ibmcloud login

Creazione di un percorso tramite CLI

Utilizzare questo comando per creare un nuovo percorso per una destinazione Activity Tracker Event Routing.

ibmcloud atracker route create --name ROUTE_NAME  ( --target-ids TARGETS  [--locations REGIONS] | --rules RULES | --file RULES_DEFINITION_JSON_FILE ) [--output FORMAT]

OK
Route
Name:                    dev-eu-de-route
ID:                      44444444-4444-4444-4444-444444444444
CRN:                     crn:v1:staging:public:atracker:eu-de:a/11111111111111111111111111111111::route:44444444-4444-4444-4444-444444444444
Version:                 0
Rules:                   [locations: [us-south], target_ids: [33333333-3333-3333-3333-333333333333]]
Created:                 2022-02-24T21:10:09.996Z
Updated:                 2022-02-24T21:10:09.996Z

Aggiornamento di un percorso tramite CLI

Utilizzare questo comando per aggiornare un percorso per una destinazione Activity Tracker Event Routing. Qualsiasi valore specificato diverso da quello impostato al momento della creazione originale del percorso verrà aggiornato al valore specificato nel comando.

ibmcloud atracker route update --route ROUTE [--name ROUTE_NAME] [--force] ( [--target-ids TARGETS]  [--locations REGIONS] | [--rules RULES] | [--file RULES_DEFINITION_JSON_FILE] ) [--output FORMAT] [--output FORMAT]

OK
Route
Name:                    dev-eu-de-route
ID:                      44444444-4444-4444-4444-444444444444
CRN:                     crn:v1:staging:public:atracker:eu-de:a/11111111111111111111111111111111::route:44444444-4444-4444-4444-444444444444
Version:                 1
Rules:                   [locations: [*], target_ids: [55555555-5555-5555-5555-555555555555]]
Created:                 2022-02-24T21:10:09.996Z
Updated:                 2022-02-24T21:13:37.218Z

Eliminazione di un percorso tramite CLI

Utilizzare questo comando per eliminare una rotta Activity Tracker Event Routing.

ibmcloud atracker route rm --route ROUTE [--force]

Are you sure you want to remove the route with the Route ID 44444444-4444-4444-4444-444444444444? [y/N]> y
OK
Route with route ID 44444444-4444-4444-4444-444444444444 was successfully removed.

FAILED
No route found with route name - 33333333-3333-3333-3333-333333333333

Visualizzazione di un percorso tramite la CLI

Utilizzare questo comando per ottenere informazioni su un percorso Activity Tracker Event Routing.

ibmcloud atracker route get --route ROUTE [--output FORMAT]

OK
Route
Name:                    dev-eu-de-route-0
ID:                      44444444-4444-4444-4444-444444444444
CRN:                     crn:v1:staging:public:atracker:eu-de:a/11111111111111111111111111111111::route:44444444-4444-4444-4444-444444444444
Version:                 2
Rules:                   [locations: [us-south], target_ids: [55555555-5555-5555-5555-555555555555]]
Created:                 2022-02-24T21:10:09.996Z
Updated:                 2022-02-24T21:15:07.281Z

Elencare tutti i percorsi utilizzando la CLI

Utilizzare questo comando per elencare tutti i percorsi configurati per Activity Tracker Event Routing.

ibmcloud atracker route ls [--output FORMAT]

Name                      ID                                     Rules                                              Route Version   API version   CreatedAt                  UpdatedAt
my-global-route           aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa   [[11111111-1111-1111-1111-111111111111],[global]]  5               2             2022-05-04T20:18:00.595Z   2022-05-05T19:04:58.374Z
send-all-to-us-east       bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb   [[22222222-2222-2222-2222-222222222222],[*]]       0               2             2022-05-06T12:02:47.832Z   2022-05-06T12:02:47.832Z

Percorsi e azioni API

La tabella seguente elenca le operazioni che è possibile eseguire per gestire le rotte:

È possibile utilizzare endpoint privati e pubblici per gestire i percorsi. Per ulteriori informazioni sull'elenco dei ENDPOINTS disponibili, vedere Endpoint.

• È possibile gestire i percorsi dalla rete privata utilizzando un endpoint API con il seguente formato: https://private.REGION.atracker.cloud.ibm.com.

• È possibile gestire i percorsi dalla rete pubblica utilizzando un endpoint API con il seguente formato: https://REGION.atracker.cloud.ibm.com.

• Poiché le rotte sono configurazioni globali, è possibile utilizzare qualsiasi endpoint regionale per gestire le rotte per l'account.

• È possibile disattivare gli endpoint pubblici aggiornando le impostazioni dell'account. Per ulteriori informazioni, vedere Configurazione delle impostazioni di destinazione e regione.

Per ulteriori informazioni sulla REST API, vedere Percorsi.

Prerequisiti API

Per effettuare chiamate API per gestire i percorsi, completare i seguenti passaggi:

1. Ottenere un token di accesso IAM. Per ulteriori informazioni, vedere Recupero dei token di accesso IAM.
2. Identifica l'endpoint API nella regione in cui intendi configurare o gestire un percorso. Per ulteriori informazioni, vedere Endpoint.

Creazione di un percorso tramite API

È necessario creare una destinazione prima di creare un percorso.

È possibile utilizzare il seguente comando cURL per creare un percorso:

curl -X POST  <ENDPOINT>/api/v2/routes   -H "Authorization:  $ACCESS_TOKEN"   -H "content-type: application/json"  -d '{
    "name": "ROUTE_NAME",
    "rules": [
      {
        "locations": ["LOCATIONS"],
        "target_ids": ["TARGET_ID"]
      }
    ]
  }'

Dove

• <ENDPOINT> è l'endpoint API nella regione in cui intendi configurare o gestire un percorso. Per ulteriori informazioni, vedere Endpoint.

• ROUTE_NAME è il nome del percorso. La lunghezza massima del nome è di 180 caratteri e non può includere nessuno dei seguenti caratteri speciali: -, ., _, :.

  Non includere alcuna informazione di identificazione personale (PII) nei nomi delle risorse.

• LOCATIONS è un elenco di località associate al percorso. Specificare global per includere eventi globali. Per includere tutte le posizioni specificare *. Se si hanno più regole, insieme a una regola con posizione *, le altre regole instraderanno gli eventi alle destinazioni specificate, mentre tutti gli eventi che non corrispondono a nessun'altra regola instraderanno gli eventi rimanenti alla destinazione specificata dalla regola con posizione *.

• TARGET_ID è il GUID della destinazione che definisce dove vengono instradati e raccolti gli eventi di auditing. Ciò può includere GUID di target in altre regioni. Se TARGET_ID è vuoto, tutti gli eventi che corrispondono alla regola verranno scartati.

Ad esempio, puoi utilizzare la seguente richiesta cURL per creare un percorso che definisca il modo in cui gli eventi basati sulla posizione globale e degli Stati Uniti meridionali vengono raccolti e instradati nell'account:

curl -X POST   https://private.us-south.atracker.cloud.ibm.com/api/v2/routes   -H "Authorization:  $ACCESS_TOKEN"   -H "content-type: application/json"  -d '{
    "name": "my-route",
    "rules": [
      {
        "locations": ["us-south", "global"],
        "target_ids": ["22222222-2222-2222-2222-222222222222"]
      }
    ]
  }'

Nella risposta si ottengono informazioni sul percorso, come id, che indica il GUID del percorso, e crn, che indica il CRN del percorso.

Aggiornamento di un percorso tramite API

Quando si aggiorna un percorso, è necessario includere le informazioni sul percorso nella sezione dati della richiesta.

• Devi superare tutti i campi.
• Aggiorna i campi che devono essere modificati.

È possibile utilizzare il seguente comando cURL per aggiornare un percorso:

curl -X PUT  <ENDPOINT>/api/v2/routes/<ROUTE_ID>   -H "Authorization:  $ACCESS_TOKEN"   -H "content-type: application/json"  -d '{
    "name": "ROUTE_NAME",
    "rules": [
      {
        "locations": ["LOCATIONS"],
        "target_ids": ["TARGET_ID"]
      }
    ]
  }'

Dove

• <ENDPOINT> è l'endpoint API nella regione in cui intendi configurare o gestire un percorso. Per ulteriori informazioni, vedere Endpoint.

• <ROUTE_ID> è l'ID del percorso da aggiornare

• ROUTE_NAME è il nome del percorso. La lunghezza massima del nome è di 180 caratteri e non può includere nessuno dei seguenti caratteri speciali: -, ., _, :.

  Non includere alcuna informazione di identificazione personale (PII) nei nomi delle risorse.

• LOCATIONS è un elenco di località associate al percorso. Specificare global per includere eventi globali. Per includere tutte le posizioni specificare *. Se si hanno più regole, insieme a una regola con posizione *, le altre regole instraderanno gli eventi alle destinazioni specificate, mentre tutti gli eventi che non corrispondono a nessun'altra regola instraderanno gli eventi rimanenti alla destinazione specificata dalla regola con posizione *.

• TARGET_ID è il GUID della destinazione che definisce dove vengono instradati e raccolti gli eventi di auditing. Ciò può includere GUID di target in altre regioni. Se TARGET_ID è vuoto, tutti gli eventi che corrispondono alla regola verranno scartati.

Ad esempio, puoi utilizzare la seguente richiesta cURL per aggiornare un percorso che definisce il modo in cui gli eventi basati sulla posizione globale e US-South e US-East vengono raccolti e instradati nell'account:

curl -X PUT https://private.us-south.atracker.cloud.ibm.com/api/v2/routes/aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa   -H "Authorization:  $ACCESS_TOKEN"   -H "content-type: application/json"  -d '{
    "name": "my-route",
    "rules": [
      {
        "locations": ["us-south", "global", "us-east],
        "target_ids": ["22222222-2222-2222-2222-222222222222"]
      }
    ]
  }'

Eliminazione di un percorso tramite API

Per eliminare una rotta, puoi usare il seguente comando cURL:

curl -X DELETE   <ENDPOINT>/api/v2/routes/<ROUTE_ID>   -H "Authorization:  $ACCESS_TOKEN"   -H "content-type: application/json"

Dove

• <ENDPOINT> è l'endpoint API nella regione in cui intendi configurare o gestire un percorso. Per ulteriori informazioni, vedere Endpoint.
• <ROUTE_ID> è l'ID del percorso da eliminare

Ad esempio, puoi eseguire la seguente richiesta cURL per eliminare la rotta con ID aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa:

curl -X DELETE  https://private.us-south.atracker.cloud.ibm.com/api/v2/routes/aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa -H "Authorization:  $ACCESS_TOKEN"   -H "content-type: application/json"

Visualizzazione di un percorso tramite API

È possibile utilizzare il seguente comando cURL per visualizzare 1 percorso:

curl -X GET   <ENDPOINT>/api/v2/routes/<ROUTE_ID>   -H "Authorization:  $ACCESS_TOKEN"   -H "content-type: application/json"

Dove

• <ENDPOINT> è l'endpoint API nella regione in cui intendi configurare o gestire un percorso. Per ulteriori informazioni, vedere Endpoint.
• <ROUTE_ID> è l'ID del percorso da recuperare

Ad esempio, è possibile eseguire la seguente richiesta cURL per ottenere informazioni su un percorso con ID aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa:

curl -X GET   https://private.us-south.atracker.cloud.ibm.com/api/v2/routes/aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa    -H "Authorization:  $ACCESS_TOKEN"   -H "content-type: application/json"

Elencare tutti i percorsi in una regione utilizzando l'API

È possibile utilizzare il seguente comando cURL per visualizzare tutti i percorsi:

curl -X GET   <ENDPOINT>/api/v2/routes   -H "Authorization:  $ACCESS_TOKEN"   -H "content-type: application/json"

Dove

• <ENDPOINT> è l'endpoint API nella regione in cui intendi configurare o gestire un percorso. Per ulteriori informazioni, vedere Endpoint.

Ad esempio, è possibile eseguire la seguente richiesta cURL per ottenere informazioni sui percorsi definiti in US South:

curl -X GET   https://private.us-south.atracker.cloud.ibm.com/api/v2/routes    -H "Authorization:  $ACCESS_TOKEN"   -H "content-type: application/json"

Codici di risposta HTTP

Quando si utilizza l'API REST di Activity Tracker Event Routing, è possibile ottenere i codici di risposta standard di HTTP per indicare se un metodo è stato completato con successo.

• Una risposta pari a 200 indica sempre successo.
• Una risposta 4xx indica un errore.
• Una risposta 5xx indica solitamente un errore interno del sistema.

Vedere la tabella seguente per alcuni codici di risposta di HTTP:

Creazione di un percorso tramite l'interfaccia utente

1. Accedi al tuo account IBM Cloud.
2. Fai clic sull'icona Menu > Osservabilità.
3. Seleziona " Monitoraggio attività ".
4. Seleziona Percorsi.
5. Fare clic su Crea per aprire la pagina di creazione.
6. Inserisci un nome significativo per il percorso.
7. Nelle regole di routing, modificare la regola 1:
   • Invia eventi di controllo da: seleziona le posizioni degli eventi di controllo che corrisponderanno a questa regola.
   • Ai target: seleziona un target che verrà associato a questa regola. Fare clic su Aggiungi destinazione per aggiungere altre destinazioni alla regola.
8. Fare clic su Aggiungi regola per aggiungere ulteriori regole al percorso.
   • L'ordine delle regole di percorso influisce sul comportamento del routing. Le regole vengono elaborate in ordine e una volta che una regola viene soddisfatta, le regole successive non vengono elaborate.
9. Ogni regola ha una freccia su e una freccia giù che consentono di modificare l'ordine delle regole.
10. Ogni regola ha un pulsante Rimuovi che consente di eliminare una regola da un percorso.
11. Rivedere la definizione del percorso assicurandosi che l'ordine delle regole sia quello previsto.
12. Fai clic su Crea.

Aggiornamento di un percorso tramite l'interfaccia utente

1. Accedi al tuo account IBM Cloud.
2. Fai clic sull'icona Menu > Osservabilità.
3. Seleziona " Monitoraggio attività ".
4. Seleziona Percorsi.
5. Determina quale percorso aggiornare e clicca .
6. Fare clic su Rinomina per rinominare il percorso.
7. Fare clic su Modifica per aggiornare le regole del percorso.
8. Se lo desideri, modifica le regole esistenti:
   • Invia eventi di controllo da: seleziona le posizioni degli eventi di controllo che corrisponderanno a questa regola.
   • Ai target: seleziona un target che verrà associato a questa regola. Fare clic su Aggiungi destinazione per aggiungere altre destinazioni alla regola.
9. Fare clic su Aggiungi regola per aggiungere ulteriori regole al percorso.
   • L'ordine delle regole di percorso influisce sul comportamento del routing. Le regole vengono elaborate in ordine e una volta che una regola viene soddisfatta, le regole successive non vengono elaborate.
10. Ogni regola ha una freccia su e una freccia giù che consentono di modificare l'ordine delle regole.
11. Ogni regola ha un pulsante Rimuovi che consente di eliminare una regola da un percorso.
12. Fai clic su Aggiorna per apportare modifiche al percorso.

Visualizzazione di un percorso tramite l'interfaccia utente

1. Accedi al tuo account IBM Cloud.
2. Fai clic sull'icona Menu > Osservabilità.
3. Seleziona " Monitoraggio attività ".
4. Seleziona Percorsi.
5. La tabella dei percorsi è ordinata in base alla data di creazione. L'ordine dei percorsi non influisce sul comportamento del routing.
6. Ogni blocco di percorso visualizza il nome del percorso e le regole.
7. Nella pagina dei percorsi vengono inoltre visualizzate le indicazioni di routing con informazioni aggiuntive sulla configurazione del routing.

Eliminazione di un percorso tramite l'interfaccia utente

1. Accedi al tuo account IBM Cloud.
2. Fai clic sull'icona Menu > Osservabilità.
3. Seleziona " Monitoraggio attività ".
4. Seleziona Percorsi.
5. Determina quale percorso aggiornare e clicca .
6. Fare clic su Elimina per eliminare l'intero percorso. È necessario immettere il nome del percorso prima che il percorso venga eliminato.