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

Avant d'utiliser l'interface de ligne de commande pour gérer les cibles, procédez comme suit :

1. Installez l'interface de ligne de commande IBM Cloud.

2. Installez l'interface de ligne de commande IBM Cloud Activity Tracker Event Routing.

   La version 0.3.2 ou supérieure de l'interface CLI d' atracker est requise pour exécuter les commandes CLI d' Event Streams. Si vous avez déjà installé l'interface de ligne de commande atracker, vous devrez peut-être mettre à niveau le plug-in d'interface de ligne de commande atracker en exécutant ibmcloud plugin update atracker.

3. Connectez-vous à IBM Cloud. Exécutez la commande suivante : ibmcloud login

Configuration de l'autorisation « S2S » via l'interface utilisateur au sein d'un même compte

Procédez comme suit pour configurer une autorisation de service à service à l'aide de l'interface utilisateur IBM Cloud.

1. Connectez-vous à votre compte IBM Cloud en tant que propriétaire du compte qui va configurer les cibles IBM Cloud Activity Tracker Event Routing.

   Une fois connecté avec votre ID utilisateur et votre mot de passe, le tableau de bord IBM Cloud s'ouvre.

2. Cliquez sur « Gérer » > Accès (IAM). La page « Gérer les accès et les utilisateurs » s'affiche.

3. Cliquez sur Autorisations.

4. Cliquez sur Créer.

5. Pour le service « Source », sélectionnez Activity Tracker et, pour « **Comment souhaitez-vous définir la portée de l'accès? ** », sélectionnez « Toutes les ressources ».

6. Pour le service cible, sélectionnez Message Hub pour « **Comment souhaitez-vous définir la portée de l'accès? ** », sélectionnez « Ressources en fonction des attributs sélectionnés ».

7. Sélectionnez « Instance de service » et saisissez une chaîne de caractères correspondant au nom de votre instance Event Streams.

8. Pour accéder au service, sélectionnez « Writer ».

9. Cliquez sur Autoriser. Votre nouvelle autorisation de service à service sera répertoriée dans la vue Gérer les autorisations.

Configuration de l'autorisation « S2S » à l'aide de l'interface de ligne de commande (CLI)

Procédez comme suit pour configurer une autorisation de service à service à l'aide de a CLI IBM Cloud.

1. Connectez-vous à votre compte IBM Cloud en tant que titulaire du compte chargé de configurer l'autorisation d' IBM Cloud Activity Tracker Event Routing.

2. Créez une règle d'autorisation définissant votre autorisation de service à service.

   ibmcloud iam authorization-policy-create atracker messagehub "Writer" [--target-service-instance-id <IES_SERVICE_INSTANCE>
   

   Où :

   IES_SERVICE_INSTANCE est le CRN de l'instance Event Streams à autoriser.

Configuration de l'autorisation d' S2S s à l'aide de l'API

Procédez comme suit pour configurer une autorisation de service à service à l'aide de l'API IBM Cloud.

1. Connectez-vous à votre compte IBM Cloud en tant que propriétaire du compte qui va configurer l'autorisation IBM Cloud Activity Tracker Event Routing IAM.

2. Créez un fichier authorization_policy_resource.json définissant votre autorisation de service à service.

   {
       "type": "authorization",
       "subjects": [
           {
               "attributes": [
                 {
                      "name": "accountId",
                      "value": "CUSTOMER_ACCOUNT_ID"
                  },
                  {
                       "name": "serviceName",
                       "value": "atracker"
                   }
               ]
           }
       ],
       "roles": [
           {
               "role_id": "crn:v1:bluemix:public:iam::::serviceRole:Writer"
           }
       ],
       "resources": [
           {
               "attributes": [
                 {
                      "name": "accountId",
                      "value": "CUSTOMER_ACCOUNT_ID"
                  },
                  {
                       "name": "serviceName",
                       "value": "messagehub"
                   },
                   {
                       "name": "serviceInstance",
                       "value": "IES_SERVICE_INSTANCE"
                   }
               ]
           }
       ]
   }
   

   Où :

   CUSTOMER_ACCOUNT_ID est le GUID du compte qui va configurer des cibles. Vous pouvez le trouver à l'aide de la commande ibmcloud account list.

   IES_SERVICE_INSTANCE est le CRN de l'instance IES à autoriser.

3. Obtenez un jeton d'accès IAM. Pour plus d'informations, voir Extraction des jetons d'accès IAM.

4. Exécutez la commande suivante pour configurer votre autorisation de service à service :

   curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' --header "Authorization: $ACCESS_TOKEN" -d @authorization_policy_resource.json "https://iam.cloud.ibm.com/v1/policies"
   

Création d'une cible Event Streams à l'aide de l'interface de ligne de commande

Utilisez cette commande pour créer une cible « IBM® Event Streams for IBM Cloud® » qui servira à configurer une destination pour les événements d'activité.

 ibmcloud atracker target create --name TARGET_NAME --type TARGET_TYPE ( [--file EVENTSTREAMS_ENDPOINT_DEFINITION_JSON_FILE] | ( [--target-crn EVENTSTREAMS_TARGET_CRN] [--brokers BROKER_LIST] [--topic TOPIC] [--api-key ( EVENTSTREAMS_API_KEY | @EVENTSTREAMS_API_KEY_FILE )] | [--service-to-service-enabled ( TRUE | FALSE )]) ) [--region REGION] [--output FORMAT]

Target
Name:                     my-target
ID:                       000000000-00000000-0000-0000-00000000
CRN:                      crn:v1:staging:public:atracker:us-south:a/xxxxxxxxxx:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx
Region:                   us-south
Type:                     event_streams
Event Streams Target CRN: crn:v1:bluemix:public:messagehub:us-south:a/xxxxxxxxxx:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx::
Event Streams Topic:      my-topic
Event Streams Brokers:    [broker-1:9093,broker-2:9093]
Write Status:             success
CreatedAt:                2022-10-20T19:20:38.888Z
UpdatedAt:                2022-10-20T19:20:38.888Z

Mise à jour d'une cible Event Streams à l'aide de l'interface de ligne de commande

Utilisez cette commande pour mettre à jour une cible « Event Streams » pour une région « IBM Cloud Activity Tracker Event Routing ». Toute valeur spécifiée différente de la date de création initiale de la cible est mise à jour à la valeur spécifiée dans la commande.

ibmcloud atracker target update --target TARGET [--name TARGET_NAME] [ [--file EVENTSTREAMS_ENDPOINT_DEFINITION_JSON_FILE] | ( [--brokers BROKER_LIST] [--target-crn EVENTSTREAMS_TARGET_CRN] [--topic TOPIC] ( [--api-key ( EVENTSTREAMS_API_KEY | @EVENTSTREAMS_API_KEY_FILE )] | [--service-to-service-enabled ( TRUE | FALSE )]))] [--output FORMAT]

Target
Name:                     my-new-target
ID:                       000000000-00000000-0000-0000-00000000
CRN:                      crn:v1:staging:public:atracker:us-south:a/xxxxxxxxxx:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx
Region:                   us-south
Type:                     event_streams
Event Streams Target CRN: crn:v1:bluemix:public:messagehub:us-south:a/xxxxxxxxxx:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx::
Event Streams Topic:      my-topic
Event Streams Brokers:    [broker-1:9093,broker-2:9093]
Write Status:             success
CreatedAt:                2022-10-20T19:20:38.888Z
UpdatedAt:                2022-10-20T19:20:38.888Z

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

Cette commande permet de supprimer une cible.

ibmcloud atracker target rm --target TARGET [--force]

Are you sure you want to remove the target with target ID xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx? [y/N]>y
OK
Target with target ID xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx was successfully removed.

Are you sure you want to remove the Target bearing Target ID 33333333-3333-3333-3333-333333333333? [y/N]> y
FAILED
Something went wrong. Error:
 Status Code:  404
 Incident ID:  67a33257-d5a4-46ec-94d9-14eb70e94f3d
 Code:         not_found
 Message:      The target id specified in `target_id` field is not found.

Validation d'une cible à l'aide de l'interface de ligne de commande

Cette commande permet de confirmer qu'une cible est correctement configurée pour une région IBM Cloud Activity Tracker Event Routing.

ibmcloud atracker target validate --target TARGET [--region REGION] [--output FORMAT]

Target
Name:               		    new-target-name
ID:                 		    xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
CRN:               		      crn:v1:staging:public:atracker:us-south:a/xxxxxxxxxx:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx
Region:                     us-south
Type:                       event_streams
Event Streams Target CRN:   crn:v1:bluemix:public:messagehub:us-south:a/a/xxxxxxxxxx:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx::
Event Streams Topic:        my-test-topic
Event Streams Brokers:      [broker-1:9093,broker-2:9093]
Write Status:               success
CreatedAt:                  2022-10-20T19:20:38.888Z
UpdatedAt:                  2022-10-20T19:20:38.888Z

Obtention d'informations à propos d'une cible à l'aide de l'interface de ligne de commande

Cette commande permet d'obtenir des informations à propos d'une cible pour une région IBM Cloud Activity Tracker Event Routing.

ibmcloud atracker target get --target TARGET [--output FORMAT]

Target
Name:               		    updated-target-name
ID:                 		    xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
CRN:               		      crn:v1:staging:public:atracker:us-south:a/xxxxxxxxxx:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx
Region:                     us-south
Type:                       event_streams
Event Streams Target CRN:   crn:v1:bluemix:public:messagehub:us-south:a/a/xxxxxxxxxx:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx::
Event Streams Topic:        my-test-topic
Event Streams Brokers:      [broker-1:9093,broker-2:9093]
Write Status:               success
CreatedAt:                  2022-10-20T19:20:38.888Z
UpdatedAt:                  2022-10-20T19:20:38.888Z

Liste de toutes les cibles d'une région

Cette commande permet de répertorier les cibles configurées pour une région IBM Cloud Activity Tracker Event Routing.

ibmcloud atracker target ls [--output FORMAT]

Name                       ID                                     Region     Type             Service to Service Enabled Created
target-01                  xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx   us-south    event_streams   -				                     2020-11-18T03:52:08.603Z
target-02                  yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy   us-south    event_streams   -				                     2020-11-18T03:52:01.592Z
target-02-backup           zzzzzzzz-zzzz-zzzz-zzzz-zzzzzzzzzzzz   us-east     event_streams   -				                     2021-02-26T06:53:13.466Z

Cibles et actions d'API

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

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

• Vous pouvez gérer des cibles à 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 des cibles à partir du réseau public à l'aide d'un noeud final d'API au format suivant : https://REGION.atracker.cloud.ibm.com

• 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 Cibles.

Prérequis d'API

Pour effectuer des appels d'API pour gérer des cibles, 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 nœud final d'API dans la région dans laquelle vous prévoyez de configurer ou de gérer une cible. Pour plus d'informations, voir Nœuds finaux.

Création d'une cible Event Streams à l'aide de l'API

Vous pouvez utiliser la commande curl suivante pour créer une cible « IBM® Event Streams for IBM Cloud® » ( Event Streams ):

curl -X POST  <ENDPOINT>/api/v2/targets   -H "Authorization:  $ACCESS_TOKEN"   -H "content-type: application/json"   -d '{
    "name": "TARGET_NAME",
    "target_type": "TARGET_TYPE",
    "eventstreams_endpoint": {
        "target_crn": "EVENTSTREAMS_CRN",
        "brokers": "BROKER_LIST",
        "topic”: "TOPIC_NAME",
        "password": "API_KEY",
        "service_to_service_enabled": false}
    }
  }'

Où

• TARGET_NAME est le nom de la cible. La longueur maximale du nom est de 256 caractères.

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

• TARGET_TYPE est le type de la cible. Définissez la valeur sur event_streams pour une cible Event Streams.

• BROKER_LIST est la liste des courtiers Event Streams (noeuds finaux).

• TOPIC_NAME est le nom d'une rubrique Event Streams dans laquelle les événements sont envoyés.

• API_KEY est la valeur de mot de passe trouvée dans les données d'identification du service Event Streams. Il s'agit de la clé d'API IAM.

• service_to_service_enabled détermine si IBM Cloud Activity Tracker Event Routing l'authentification de service à service est activée. Mettre ce drapeau à vrai si le service à service est activé et que vous ne fournissez pas de code d'accès.

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

Mise à jour d'une cible Event Streams à l'aide de l'API

Lorsque vous mettez à jour une cible « IBM® Event Streams for IBM Cloud® » ( Event Streams ), vous devez inclure les informations relatives à cette cible dans la section « données » de la requête.

• Vous devez passer toutes les zones.
• Mettez à jour les zones qui doivent être modifiées.
• Vous ne pouvez pas modifier target_type d'une cible une fois créée.

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

curl -X PUT  <ENDPOINT>/api/v2/targets/TARGET_ID  -H "Authorization:  $ACCESS_TOKEN"   -H "content-type: application/json"   -d '{
    "name": "TARGET_NAME",
    "target_type": "TARGET_TYPE",
    "eventstreams_endpoint": {
      "target_crn": "EVENTSTREAMS_CRN",
      "brokers": "BROKER_LIST",
      "topic”: "TOPIC_NAME",
      "password": "API_KEY",
      "service_to_service_enabled": false}
    }
  }'

Où

• TARGET_ID est l'ID de la cible.

• TARGET_NAME est le nom de la cible. La longueur maximale du nom est de 256 caractères.

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

• TARGET_TYPE est le type de la cible. Définissez la valeur sur event_streams pour une cible Event Streams.

• BROKER_LIST est la liste des courtiers Event Streams (noeuds finaux).

• TOPIC_NAME est le nom d'une rubrique Event Streams dans laquelle les événements sont envoyés.

• API_KEY est la valeur de mot de passe trouvée dans les données d'identification du service Event Streams. Il s'agit de la clé d'API IAM.

• service_to_service_enabled détermine si IBM Cloud Activity Tracker Event Routing l'authentification de service à service est activée. Mettre ce drapeau à vrai si le service à service est activé et que vous ne fournissez pas de code d'accès.

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

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

curl -X DELETE <ENDPOINT>/api/v2/targets/<TARGET_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 cible. Pour plus d'informations, voir Nœuds finaux.
• <TARGET_ID> est l'ID de la cible.

Par exemple, vous pouvez utiliser la demande cURL suivante pour supprimer une cible dans Etats-Unis Sud avec l'ID 00000000-0000-0000-0000-000000000000:

curl -X DELETE https://private.us-south.atracker.cloud.ibm.com/api/v2/targets/00000000-0000-0000-0000-000000000000 -H "Authorization: $ACCESS_TOKEN" -H "content-type: application/json"

Dans la réponse, vous obtenez un résultat vide si la suppression a abouti :

{}

Validation d'une cible à l'aide de l'API

Vous pouvez utiliser la commande cURL suivante pour valider une cible en vérifiant les données d'identification pour écrire sur la cible.

curl -X POST <ENDPOINT>/api/v2/targets/<TARGET_ID>/validate -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 cible. Pour plus d'informations, voir Nœuds finaux.
• <TARGET_ID> est l'ID de la cible.

Par exemple, vous pouvez utiliser la demande cURL suivante pour valider une cible dans Etats-Unis Sud avec l'ID 00000000-0000-0000-0000-000000000000 :

curl -X POST https://private.us-south.atracker.cloud.ibm.com/api/v2/targets/<TARGETID>/validate -H "Authorization: $ACCESS_TOKEN" -H "content-type: application/json"

Dans la réponse, vous trouverez des informations dans la section « write_status », par exemple :

"write_status": {
    "status": "success"
  },

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

Vous pouvez utiliser la commande cURL suivante pour afficher les informations de configuration d'une cible :

curl -X GET <ENDPOINT>/api/v2/targets/<TARGET_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 cible. Pour plus d'informations, voir Nœuds finaux.
• <TARGET_ID> est l'ID de la cible.

Par exemple, vous pouvez exécuter la demande cURL suivante pour obtenir des informations sur une cible avec l'ID 00000000-0000-0000-0000-000000000000 :

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

Les résultats indiqueront si la cible est COS ("target_type": "cloud_object_storage") ou Event Streams ("target_type": "event_streams").

Liste de toutes les cibles à l'aide de l'API

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

curl -X GET <ENDPOINT>/api/v2/targets -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 cible. Pour plus d'informations, voir Nœuds finaux.

Par exemple, vous pouvez exécuter la demande cURL suivante pour obtenir des informations sur les cibles définies à Dallas :

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

Les résultats indiqueront si la cible est COS ("target_type": "cloud_object_storage") ou Event Streams ("target_type": "event_streams").

Codes de réponse HTTP

Lorsque vous utilisez l'API REST IBM Cloud 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 cible Event Streams à l'aide de l'interface utilisateur

Seules les ressources de votre compte sont répertoriées et sélectionnables. Pour spécifier une ressource dans un autre compte, sélectionnez Spécifier le CRN sous Choisir la destination.

1. Connectez-vous à votre compte IBM Cloud.
2. Cliquez sur l'icône Menu > Observabilité.
3. Sélectionnez « Suivi de l'activité »...
4. Cliquez sur Créer pour ouvrir le panneau de création.
5. Choisir un type: cliquez sur Event Streams.
6. Choisir une destination: Sélectionnez Rechercher par instance ou Spécifier un nom de ressource de cloud
   • Rechercher par instance: Sélectionnez une instance Event Streams dans la table ou cliquez sur Créer pour créer une nouvelle instance Event Streams.
   • Indiquez CRN: entrez le nom de ressource de cloud (CRN) de l'instance Event Streams. Cela vous permet d'entrer un nom de ressource de cloud à partir d'un autre compte.

• Données d'identification du service: sélectionnez l'une des données d'identification du service, elle contient le nom d'utilisateur de la liste des courtiers, ainsi que la clé d'API ou le mot de passe.
• RubriqueEvent Streams: sélectionnez une rubrique existante.
• Nom de la cible: Entrez un nom significatif pour la cible.
• Région cible: Sélectionnez la région qui traitera les données d'événement.
• Activez l'option Définir comme cible par défaut pour définir automatiquement votre nouvelle cible comme cible par défaut dans vos paramètres IBM Cloud Activity Tracker Event Routing. Voir la documentation sur les cibles par défaut pour plus de détails.
• Cliquez sur Créer une cible.

Mise à jour d'une cible Event Streams à l'aide de l'interface utilisateur

Seules les ressources de votre compte sont répertoriées et sélectionnables. Pour spécifier une ressource dans un autre compte, sélectionnez Spécifier le CRN sous Choisir la destination.

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 l'élément à mettre à jour, puis cliquez sur .
5. Vous pouvez cliquer sur Dédéfinir comme valeur par défaut pour supprimer votre cible en tant que cible par défaut dans vos paramètres IBM Cloud Activity Tracker Event Routing. Voir la documentation sur les cibles par défaut pour plus de détails.
6. Cliquez sur Editer pour ouvrir le panneau de mise à jour.
7. Détails: cliquez sur Editer pour mettre à jour le nom ou la région de votre cible. Vous pouvez également activer Cible par défaut pour ajouter ou supprimer votre cible en tant que cible par défaut dans vos paramètres IBM Cloud Activity Tracker Event Routing.
8. Cliquez sur Sauvegarder pour mettre à jour votre cible.
9. Destination: cliquez sur Editer pour modifier l'instance Event Streams, les données d'identification du service ou la rubrique associée à votre cible.
10. Cliquez sur Sauvegarder pour mettre à jour votre cible.

Suppression d'une cible via l'interface utilisateur

Vous ne pouvez pas supprimer une cible « IBM Cloud Activity Tracker Event Routing » si celle-ci est utilisée dans un itinéraire ou comme cible par défaut.

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 l'élément à supprimer, puis cliquez sur .
5. Cliquez sur Supprimer, puis sur Supprimer dans le panneau de confirmation.

Afficher la liste de toutes les cibles d'une région 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é ».

Le tableau présente toutes les informations relatives aux cibles :

• Type de cible
• Nom de destination
• Région de destination
• Routes: s'il est utilisé dans des routes
• Statut de la cible:
  • Actif: la cible fonctionne comme prévu
  • Erreur: La cible est déchiffrée et les événements ne seront pas acheminés vers la destination. Mettez à jour les détails ou la destination de la cible pour corriger la configuration cible ou supprimez la cible si elle n'est plus nécessaire