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

Avant d'utiliser l'interface de ligne de commande pour gérer les paramètres de compte Activity Tracker Event Routing, installez l'interface de ligne de commande IBM Cloud Activity Tracker Event Routing.

Vérifiez que vous disposez des autorisations IAM pour lire ou mettre à jour les paramètres du compte Activity Tracker Event Routing

Obtention des paramètres de compte à l'aide de l'interface CLI

Utilisez cette commande pour obtenir les paramètres de configuration du compte IBM Cloud Activity Tracker Event Routing

ibmcloud atracker setting get [--output FORMAT]

Atracker settings
Metadata region primary:     us-south
Metadata region backup:      us-east
Default targets:             []
Permitted target regions:    []
Private api endpoint only:   false
API version:                 2

Mise à jour des paramètres à l'aide de la CLI

Cette commande permet de modifier les paramètres de compte en cours tels que les cibles par défaut, les régions cibles autorisées et la région principale des métadonnées.

ibmcloud atracker setting update [--metadata-region-primary REGION] [--metadata-region-backup REGION] [--default-targets TARGET] [--permitted-target-regions REGIONS] [--private-api-endpoint-only ( TRUE | FALSE )] [--output FORMAT] [--force]

Paramètres et actions de l'API

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

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

• Par défaut, vous pouvez gérer les paramètres du réseau privé. Vous devez utiliser un nœud final d'interface de programmation au format suivant :https://private.<region>.atracker.cloud.ibm.com

• Vous pouvez également activer des noeuds finaux publics dans une région pour gérer les paramètres. Pour plus d'informations, voir Gestion des noeuds finaux.

Pour plus d'informations sur l'API REST, voir l 'API des paramètres.

Prérequis de l'API

Pour effectuer des appels d'API pour gérer les paramètres, 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 les paramètres. Pour plus d'informations, voir Nœuds finaux.

Obtention des paramètres à l'aide de l'API

Vous pouvez utiliser la commande cURL suivante pour obtenir des informations sur les paramètres existants :

curl -X GET  ENDPOINT/api/v2/settings   -H "Authorization:  $ACCESS_TOKEN"

Où :

ENDPOINT

Est le noeud final de l'API dans 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 utiliser les paramètres de demande cURL suivants dans la région États-Unis Sud :

curl -X GET   https://private.us-south.atracker.cloud.ibm.com/api/v2/settings   -H "Authorization:  $ACCESS_TOKEN"

Une réponse similaire à la suivante est renvoyée :

{
 "default_targets": ["50375218-0000-4234-bbb4-171bebab8408", "c7519d8a-5f97-498b-0000-8542f60955cd"],
 "permitted_target_regions": ["us-south", "us-east"],
 "metadata_region_primary": "us-south",
 "metadata_region_backup": "eu-de",
 "private_api_endpoint_only": false
}

Où :

default_targets

Est une liste d'ID cible. Si aucune règle de routage ne provoque l'envoi d'événements à d'autres cibles, ces cibles reçoivent les événements.

permitted_target_regions

Liste des régions pouvant être utilisées pour définir une cible. Un maximum de deux régions cibles permises sont autorisées.

metadata_region_primary

Est la région où les métadonnées associées aux définitions de route et de cible sont stockées.

metadata_region_backup

Est la région où les métadonnées associées aux définitions d'itinéraires et de cibles sont stockées en tant qu'emplacement de sauvegarde.

private_api_endpoint_only

Indique si un noeud final privé peut être utilisé. Si true seul un noeud final privé peut être utilisé.

Mise à jour des paramètres via l'API

Lorsque vous mettez à jour les paramètres, vous devez inclure les informations de paramètres 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 les paramètres :

curl -X PUT  <ENDPOINT>/api/v2/settings
-H "Authorization:  $ACCESS_TOKEN"
-H "content-type: application/json"
-d '{
   "default_targets": ["IDs"],
   "permitted_target_regions": ["REGIONS"],
   "metadata_region_primary": "REGION",
   "metadata_region_backup": "REGION",
   "private_api_endpoint_only": false
}'

Où :

ENDPOINT

Est le noeud final de l'API dans la région où vous prévoyez de configurer ou de gérer une cible Pour plus d'informations, voir Nœuds finaux.

default_targets

Est une liste d'ID cible. Si aucune règle de routage ne provoque l'envoi d'événements à d'autres cibles, ces cibles reçoivent les événements.

permitted_target_regions

Liste des régions pouvant être utilisées pour définir une cible. Un maximum de deux régions cibles autorisées peut être spécifié.

metadata_region_primary

Est la région où les métadonnées associées aux définitions de route et de cible sont stockées.

metadata_region_backup

Est la région où les métadonnées associées aux définitions d'itinéraires et de cibles sont stockées en tant qu'emplacement de sauvegarde.

private_api_endpoint_only

Indique si un noeud final privé peut être utilisé. Si true seul un noeud final privé peut être utilisé.

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 :

Obtenir les paramètres du compte à l'aide de l'interface utilisateur

1. Connectez-vous à votre compte IBM Cloud.
2. Cliquez sur l'icône de Menu > Observabilité.
3. Sélectionnez Activity Tracker.
4. Sélectionnez Routage.
5. Sélectionnez Paramètres.

Sur cette page, vous pouvez afficher les paramètres suivants:

• Emplacement des métadonnées: affiche la région de métadonnées principale et la région de métadonnées de sauvegarde.
• Régions cibles autorisées. Affiche les régions cibles dans lesquelles les événements peuvent être envoyés.
• Cibles par défaut: affiche les cibles par défaut configurées.
• Noeuds finaux publics: indique si les noeuds finaux publics sont activés. Lorsqu'elle est désactivée, l'interface utilisateur Activity Tracker Event Routing est inaccessible.
• Rapports: Affiche la configuration au format JSON.

Mise à jour des paramètres à l'aide de l'interface utilisateur

1. Connectez-vous à votre compte IBM Cloud.
2. Cliquez sur l'icône de Menu > Observabilité.
3. Sélectionnez Activity Tracker.
4. Sélectionnez Routage.
5. Sélectionnez Paramètres.

Cliquez sur Editer en regard du paramètre à modifier. Vous pouvez modifier les paramètres suivants :

• Emplacement des métadonnées: Sélectionnez la région de métadonnées principale et la région de métadonnées de sauvegarde de votre choix.
• Régions cible autorisées: Sélectionnez la région dans laquelle les cibles peuvent être créées. Si aucune région n'est sélectionnée, toutes les régions peuvent recevoir des événements.
• Cibles par défaut: Sélectionnez la cible qui sera utilisée par défaut lorsque les règles de routage n'existent pas ou ne sont pas mises en correspondance.