Prérequis pour l'interface de ligne de commande (CLI)

Avant d'utiliser l'interface de ligne de commande (CLI) pour gérer les routes, installez la dernière version du plugin CLI « Activity Tracker Event Routing » V2 sur votre système local. Voir Installation de l'interface de ligne de commande Activity Tracker Event Routing.

Ensuite, connectez-vous à IBM Cloud. Exécutez la commande suivante : ibmcloud login

Création d'une route à l'aide de l'interface de ligne de commande

Cette commande permet de créer une route pour une cible 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

Mise à jour d'une route à l'aide de l'interface de ligne de commande

Cette commande permet de mettre à jour une route pour une cible Activity Tracker Event Routing. Toute valeur spécifiée différente de la date de création initiale de la route est mise à jour à la valeur spécifiée dans la commande.

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

Suppression d'une route à l'aide de l'interface de ligne de commande

Utilisez cette commande pour supprimer une route 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

Affichage d'une route à l'aide de l'interface de ligne de commande

Cette commande permet d'obtenir des informations sur une route 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

Affichage de toutes les routes à l'aide de l'interface CLI

Cette commande permet de répertorier toutes les routes configurées pour 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

Routes et actions d'API

Le tableau suivant répertorie les actions que vous pouvez exécuter pour gérer les routes :

Vous pouvez utiliser des noeuds finaux privés et publics pour gérer les routes. Pour plus d'informations sur la liste des ENDPOINTS disponibles, voir Noeuds finaux.

• Vous pouvez gérer des routes à partir du réseau privé à l'aide d'un noeud final d'API au format suivant : https://private.REGION.atracker.cloud.ibm.com.

• Vous pouvez gérer les routes à partir du réseau public à l'aide d'un noeud final d'API au format suivant : https://REGION.atracker.cloud.ibm.com.

• Etant donné que les routes sont des configurations globales, vous pouvez utiliser n'importe quel noeud final régional pour gérer les routes du compte.

• Vous pouvez désactiver les noeuds finaux publics en mettant à jour les paramètres du compte. Pour plus d'informations, voir Configuration des paramètres de la cible et de la région.

Pour plus d'informations sur l'API REST, voir Routes.

Prérequis de l'API

Pour effectuer des appels d'API pour gérer des routes, procédez comme suit :

1. Obtenez un jeton d'accès IAM. Pour plus d'informations, voir Extraction des jetons d'accès IAM.
2. Identifiez le noeud final de l'API dans la région où vous prévoyez de configurer ou de gérer une route. Pour plus d'informations, voir Nœuds finaux.

Création d'une route à l'aide de l'API

Vous devez créer une cible avant de créer une route.

Vous pouvez utiliser la commande cURL suivante pour créer une route :

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"]
      }
    ]
  }'

Où

• <ENDPOINT>est le nœud final de l'interface de programmation de la région où vous prévoyez de configurer ou de gérer une route. Pour plus d'informations, voir Nœuds finaux.

• ROUTE_NAME est le nom de la route. La longueur maximale du nom est de 180 caractères et ne peut inclure aucun des caractères spéciaux suivants : -, ., _, :.

  N'incluez aucune information d'identification personnelle (PII) dans les noms de ressources.

• LOCATIONS est la liste des emplacements associés à la route. Indiquez global pour inclure les événements globaux. Pour inclure tous les emplacements, indiquez *. Si vous disposez de plusieurs règles, ainsi que d'une règle avec un emplacement *, les autres règles achemineront les événements vers les cibles spécifiées, les événements ne correspondant à aucune autre règle acheminant les événements restants vers la cible spécifiée par la règle avec l'emplacement *.

• TARGET_ID est le GUID unique de la cible qui définit où les événements d'audit sont acheminés et collectés. Cela peut inclure les GUID des cibles dans d'autres régions. Si TARGET_ID est vide, tous les événements correspondant à la règle seront supprimés.

Par exemple, vous pouvez utiliser la demande cURL suivante pour créer une route qui définit comment les événements basés sur l'emplacement global et Etats-UNis Sud sont collectés et acheminés dans le compte :

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"]
      }
    ]
  }'

Dans la réponse, vous obtenez des informations sur la route, telles que l'id qui indique l'identificateur global unique de la route et crn qui indique le CRN de la route.

Mise à jour d'une route à l'aide de l'API

Lorsque vous mettez à jour une route, vous devez inclure les informations de route dans la section de données de la demande.

• Vous devez passer toutes les zones.
• Mettez à jour les zones qui doivent être modifiées.

Vous pouvez utiliser la commande cURL suivante pour mettre à jour une route :

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"]
      }
    ]
  }'

Où

• <ENDPOINT>est le nœud final de l'interface de programmation de la région où vous prévoyez de configurer ou de gérer une route. Pour plus d'informations, voir Nœuds finaux.

• <ROUTE_ID> est l'ID de la route à mettre à jour

• ROUTE_NAME est le nom de la route. La longueur maximale du nom est de 180 caractères et ne peut inclure aucun des caractères spéciaux suivants : -, ., _, :.

  N'incluez aucune information d'identification personnelle (PII) dans les noms de ressources.

• LOCATIONS est la liste des emplacements associés à la route. Indiquez global pour inclure les événements globaux. Pour inclure tous les emplacements, indiquez *. Si vous disposez de plusieurs règles, ainsi que d'une règle avec un emplacement *, les autres règles achemineront les événements vers les cibles spécifiées, les événements ne correspondant à aucune autre règle acheminant les événements restants vers la cible spécifiée par la règle avec l'emplacement *.

• TARGET_ID est le GUID unique de la cible qui définit où les événements d'audit sont acheminés et collectés. Cela peut inclure les GUID des cibles dans d'autres régions. Si TARGET_ID est vide, tous les événements correspondant à la règle seront supprimés.

Par exemple, vous pouvez utiliser la demande cURL suivante pour mettre à jour une route qui définit comment les événements basés sur l'emplacement global et Etats-Unis Sud sont collectés et acheminés dans le compte :

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"]
      }
    ]
  }'

Suppression d'une route à l'aide de l'API

Vous pouvez utiliser la commande cURL suivante pour supprimer une route :

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

Où

• <ENDPOINT>est le nœud final de l'interface de programmation de la région où vous prévoyez de configurer ou de gérer une route. Pour plus d'informations, voir Nœuds finaux.
• <ROUTE_ID> est l'ID de la route à supprimer

Par exemple, vous pouvez exécuter la demande cURL suivante pour supprimer la route avec l'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"

Affichage d'une route à l'aide de l'API

Vous pouvez utiliser la commande cURL suivante pour afficher une route :

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

Où

• <ENDPOINT>est le nœud final de l'interface de programmation de la région où vous prévoyez de configurer ou de gérer une route. Pour plus d'informations, voir Nœuds finaux.
• <ROUTE_ID> est l'ID de la route à extraire

Par exemple, vous pouvez exécuter la demande cURL suivante pour obtenir des informations sur une route avec l'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"

Création d'une liste de toutes les routes d'une région à l'aide de l'API

Vous pouvez utiliser la commande cURL suivante pour afficher toutes les routes :

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

Où

• <ENDPOINT>est le nœud final de l'interface de programmation de la région où vous prévoyez de configurer ou de gérer une route. Pour plus d'informations, voir Nœuds finaux.

Par exemple, vous pouvez exécuter la demande cURL suivante pour obtenir des informations sur les routes qui sont définies dans Etat-Unis Sud :

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

Codes de réponse HTTP

Lorsque vous utilisez l'API REST Activity Tracker Event Routing, vous pouvez obtenir des codes de réponse HTTP normaux indiquant si une méthode a abouti.

• Une réponse 200 indique toujours le succès.
• Une réponse 4xx indique un incident.
• Une réponse 5xx indique généralement une erreur système interne.

Voir le tableau suivant pour certains codes de réponse HTTP :

Création d'une route à l'aide de l'interface utilisateur

1. Connectez-vous à votre compte IBM Cloud.
2. Cliquez sur l'icône Menu > Observabilité.
3. Sélectionnez « Suivi de l'activité ».
4. Sélectionnez Routes.
5. Cliquez sur « Créer » pour ouvrir la page de création.
6. Entrez un nom significatif pour la route.
7. Dans Règles de routage, modifiez Règle 1:
   • Envoyer les événements d'audit à partir de: Sélectionnez les emplacements d'événement d'audit qui correspondront à cette règle.
   • Vers les cibles: Sélectionnez une cible qui sera associée à cette règle. Cliquez sur Ajouter une cible pour ajouter d'autres cibles à la règle.
8. Cliquez sur Ajouter une règle pour ajouter des règles supplémentaires à la route.
   • L'ordre des règles de routage affecte le comportement de routage. Les règles sont traitées dans l'ordre et une fois qu'une règle est mise en correspondance, les règles suivantes ne sont pas traitées.
9. Chaque règle possède une flèche vers le haut et vers le bas qui vous permet de modifier l'ordre des règles.
10. Chaque règle comporte un bouton Supprimer qui vous permet de supprimer une règle d'une route.
11. Vérifiez la définition de route en vous assurant que l'ordre des règles est celui prévu.
12. Cliquez sur Créer.

Mise à jour d'un itinéraire via l'interface utilisateur

1. Connectez-vous à votre compte IBM Cloud.
2. Cliquez sur l'icône Menu > Observabilité.
3. Sélectionnez « Suivi de l'activité ».
4. Sélectionnez Routes.
5. Déterminez la route à mettre à jour et cliquez sur l' .
6. Cliquez sur Renommer pour renommer la route.
7. Cliquez sur Editer pour mettre à jour les règles de route.
8. Si vous le souhaitez, éditez les règles existantes:
   • Envoyer les événements d'audit à partir de: Sélectionnez les emplacements d'événement d'audit qui correspondront à cette règle.
   • Vers les cibles: Sélectionnez une cible qui sera associée à cette règle. Cliquez sur Ajouter une cible pour ajouter d'autres cibles à la règle.
9. Cliquez sur Ajouter une règle pour ajouter des règles supplémentaires à la route.
   • L'ordre des règles de routage affecte le comportement de routage. Les règles sont traitées dans l'ordre et une fois qu'une règle est mise en correspondance, les règles suivantes ne sont pas traitées.
10. Chaque règle possède une flèche vers le haut et vers le bas qui vous permet de modifier l'ordre des règles.
11. Chaque règle comporte un bouton Supprimer qui vous permet de supprimer une règle d'une route.
12. Cliquez sur Mettre à jour pour modifier votre route.

Affichage d'un itinéraire via l'interface utilisateur

1. Connectez-vous à votre compte IBM Cloud.
2. Cliquez sur l'icône Menu > Observabilité.
3. Sélectionnez « Suivi de l'activité ».
4. Sélectionnez Routes.
5. La table des routes est classée par date de création. L'ordre des routes n'affecte pas le comportement de routage.
6. Chaque bloc de route affiche le nom de la route et les règles.
7. La page des routes affiche également des conseils de routage avec des informations supplémentaires sur la configuration du routage.

Suppression d'une route à l'aide de l'interface utilisateur

1. Connectez-vous à votre compte IBM Cloud.
2. Cliquez sur l'icône Menu > Observabilité.
3. Sélectionnez « Suivi de l'activité ».
4. Sélectionnez Routes.
5. Déterminez la route à mettre à jour et cliquez sur l' .
6. Cliquez sur Supprimer pour supprimer la totalité de la route. Vous devez entrer le nom de la route avant de la supprimer.