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.

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

Configuration de l'autorisation S2S à l'aide de 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. Sélectionnez « Gérer » > « Accès (IAM) » > « Autorisations ».

3. Cliquez sur Créer.

4. 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.

5. Dans la section Service cible, sélectionnez App Configuration et, dans la section Comment souhaitez-vous définir la portée de l'accès?, sélectionnez Ressources en fonction des attributs sélectionnés.

6. Sélectionnez « Instance de service » et « chaîne égale à ». Définissez le nom de votre instance d' IBM Cloud App Configuration.

7. Pour l'accès au service, sélectionnez les rôles « Manager » et « Configuration Update Reporter ».

8. 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 apprapp "ConfigurationUpdateReporter" [--target-service-instance-id <APPCONFIG_SERVICE_INSTANCE>
   

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:ConfigurationUpdateReporter"
           }
       ],
       "resources": [
           {
               "attributes": [
                 {
                      "name": "accountId",
                      "value": "CUSTOMER_ACCOUNT_ID"
                  },
                  {
                       "name": "serviceName",
                       "value": "apprapp"
                   },
                   {
                       "name": "serviceInstance",
                       "value": "APPCONFIG_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.

   APPCONFIG_SERVICE_INSTANCE correspond à l'ID de l'instance « IBM Cloud App Configuration ».

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 « IBM Cloud App Configuration » à l'aide de l'interface de ligne de commande (CLI)

Utilisez cette commande pour créer une cible IBM Cloud App Configuration qui servira à configurer une destination pour les événements d'activité.

 ibmcloud atracker target create --name TARGET_NAME --type TARGET_TYPE ( [--file APPCONFIG_ENDPOINT_DEFINITION_JSON_FILE] | ( [--target-crn APPCONFIG_TARGET_CRN] ) ) [--region REGION] [--output FORMAT]

OK
Target
Name:                         my-target
ID:                           000000000-00000000-0000-0000-00000000
CRN:                          crn:v1:bluemix:public:atracker:us-south:a/xxxxxxxxxx:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx
Region:                       us-south
Type:                         app_config
App Configuration Target CRN: crn:v1:bluemix:public:apprapp:us-south:a/xxxxxxxxxx:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx::
Write Status:                 success
CreatedAt:                    2024-05-31T19:03:35.427Z
UpdatedAt:                    2024-05-31T19:03:35.427Z

Mise à jour d'une cible « IBM Cloud App Configuration » à l'aide de l'interface de ligne de commande (CLI)

Utilisez cette commande pour mettre à jour une cible IBM Cloud App Configuration 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 APPCONFIG_ENDPOINT_DEFINITION_JSON_FILE] | [--target-crn APPCONFIG_TARGET_CRN]] [--output FORMAT]

OK
Target
Name:                         new-target-name
ID:                           000000000-00000000-0000-0000-00000000
CRN:                          crn:v1:bluemix:public:atracker:us-south:a/xxxxxxxxxx:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx
Region:                       us-south
Type:                         app_config
App Configuration Target CRN: crn:v1:bluemix:public:apprapp:us-south:a/xxxxxxxxxx:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx::
Write Status:                 success
Created:                      2024-05-31T19:03:35.427Z
Updated:                      2024-05-31T19:03:35.427Z

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:bluemix:public:atracker:us-south:a/xxxxxxxxxx:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx
Type:                            app_config
App Configuration Target CRN:    crn:v1:bluemix:public:apprapp:us-south:a/xxxxxxxxxx:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx::
Service to Service Enabled:      true
Write Status:                    success
Created:                         2021-07-21T16:04:15.174Z
Updated:                         2021-07-21T17:49:56.452Z

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:                            new-target-name
ID:                              xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
CRN:                             crn:v1:bluemix:public:atracker:us-south:a/xxxxxxxxxx:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx
Region:                          us-east
Type:                            app_config
App Configuration Target CRN:    crn:v1:bluemix:public:apprapp:us-south:a/xxxxxxxxxx:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx::
Write Status:                    success
Created:                         2024-06-02T16:04:15.174Z
Updated:                         2024-06-05T17:49:56.452Z

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                Created
target-01                  xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx   us-south   app_config   2020-11-18T03:52:08.603Z

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 « IBM Cloud App Configuration » à l'aide de l'API

Vous pouvez utiliser la commande cURL suivante pour créer une cible IBM Cloud App Configuration:

curl -X POST  <ENDPOINT>/api/v2/targets   -H "Authorization:  $ACCESS_TOKEN"   -H "content-type: application/json"   -d '{
    "name": "TARGET_NAME",
    "target_type": "app_config",
    "app_config_endpoint": {
      "target_crn": "APPCONFIG_CRN"
    }
  }'

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_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.

• app_config_endpoint inclut des informations sur la cible.

APPCONFIG_CRN indique le CRN de l'instance d' IBM Cloud App Configuration.

Par exemple, vous pouvez utiliser la demande cURL suivante pour créer une cible à Dallas :

curl -X POST   https://private.us-south.atracker.cloud.ibm.com/api/v2/targets   -H "Authorization:  $ACCESS_TOKEN"   -H "content-type: application/json"   -d '{
    "name": "My App Configuration target",
    "target_type": "app_config",
    "app_config_endpoint": {
      "target_crn": "crn:v1:bluemix:public:apprapp:us-south:a/<account-id>:<instance-id>::"
    }
  }'

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 « IBM Cloud App Configuration » à l'aide de l'API

Lorsque vous mettez à jour une cible d' IBM Cloud App Configuration, 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": "app_config",
    "app_config_endpoint": {
      "target_crn": "APPCONFIG_CRN"
    }
  }'

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.

• 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 « app_config » pour une cible « IBM Cloud App Configuration ».

• app_config_endpoint inclut des informations sur la cible.

APPCONFIG_CRN indique le CRN de l'instance d' IBM Cloud App Configuration.

Par exemple, vous pouvez utiliser la demande cURL suivante pour mettre à jour une cible à Dallas :

curl -X PUT   https://private.us-south.atracker.cloud.ibm.com/api/v2/targets/TARGET_ID   -H "Authorization:  $ACCESS_TOKEN"   -H "content-type: application/json"   -d '{
    "name": "My new App Configuration target name",
    "target_type": "app_config",
    "app_config_endpoint": {
      "target_crn": "crn:v1:bluemix:public:apprapp:us-south:a/<account-id>:<instance-id>::"
    }
  }'

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 s'il s'agit de COS ("target_type": "cloud_object_storage"), de l'offre « IBM Cloud Logs » ("target_type": "cloud_logs") ou de « IBM Cloud App Configuration » ("target_type": "app_config")

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 s'il s'agit de COS ("target_type": "cloud_object_storage"), de l'offre « IBM Cloud Logs » ("target_type": "cloud_logs") ou de « IBM Cloud App Configuration » ("target_type": "app_config")

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 :