À propos des itinéraires
Vous pouvez gérer les routes de votre compte en utilisant l'interface utilisateur IBM Cloud Logs Routing, le CLI IBM Cloud Logs Routing, l'API REST IBM Cloud Logs Routing V3, et le fournisseur Terraform IBM Cloud Logs Routing. Un itinéraire définit les règles qui indiquent quels journaux de plate-forme sont acheminés dans une région et où les acheminer.
Comprendre comment les routes fonctionnent dans votre compte
Notez les informations suivantes à propos des routes :
-
Les itinéraires sont globaux sous un compte et sont évalués dans toutes les régions où IBM Cloud Logs Routing est déployé.
-
Il est possible d'accéder aux itinéraires à partir de n'importe quel point d'accès régional de l'API IBM Cloud Logs Routing.
-
Vous pouvez définir jusqu'à 30 routes pour un compte.
-
Par défaut, le compte n'a aucune route configurée.
-
Vous pouvez configurer jusqu'à 10 règles pour chaque route.
-
Vous pouvez configurer jusqu'à 8 emplacements pour chaque règle.
-
Vous pouvez configurer jusqu'à 3 cibles (
{ "targets": [{ "id": ID1 },{ "id": ID2 },{ "id": ID3 }] }) pour chaque règle. -
Les routes sont traitées de façon indépendante. Si vous avez plusieurs itinéraires avec des règles qui correspondent aux mêmes données d'enregistrement de la plate-forme, ces données seront envoyées à plusieurs cibles.
-
Les règles d'une même définition d'itinéraire sont traitées dans l'ordre. La première règle de correspondance (par exemple,
location) qui correspond aux données d'enregistrement de la plate-forme est utilisée pour traiter ces données. Lorsque les journaux de plate-forme sont traités, ils ne seront pas traités par une règle ultérieure dans la définition de cet itinéraire. -
Les règles correspondent à un journal de plate-forme si l'emplacement du journal de plate-forme se trouve à l'intérieur de l'emplacement d'une règle. Par exemple, l'emplacement de la règle
eu-decorrespondra aux emplacements des journaux de la plate-forme :eu-de,eu-de-1,eu-de-2, eteu-de-3. Ou la règle locationjpcorrespondra à tous les journaux de plate-forme au Japon. Lancezibmcloud catalog locationspour voir les hiérarchies d'emplacements du nuage. -
Si les données des journaux de la plate-forme ne correspondent à aucune règle et qu'aucune cible par défaut n'est configurée, les journaux de la plate-forme sont abandonnés et ne sont pas acheminés vers une cible.
-
Toute mise à jour d'une ou plusieurs règles dans une définition d'itinéraire annule l'ensemble de règles existant et le remplace par la configuration spécifiée. Lorsque vous mettez à jour un itinéraire, vous devez définir toutes les règles existantes de l'ensemble de règles qui ne changent pas et ajouter les modifications aux règles qui doivent être mises à jour.
-
Les informations sur les itinéraires sont stockées sous forme de métadonnées dans l'emplacement principal que vous avez défini pour le compte IBM Cloud.
-
Vous pouvez utiliser des noeuds finaux privés et publics pour gérer les routes. Pour plus d'informations sur la liste des
ENDPOINTSdisponibles, voir Noeuds finaux.-
Vous pouvez gérer des itinéraires à partir du réseau privé en utilisant un point de terminaison API avec le format suivant :
https://api.private.REGION.logs-router.cloud.ibm.com -
Vous pouvez gérer des itinéraires à partir du réseau public en utilisant un point de terminaison API avec le format suivant :
https://api.REGION.logs-router.cloud.ibm.com -
Vous pouvez désactiver les noeuds finaux publics en mettant à jour les paramètres du compte. Pour plus d'informations, voir Renforcer les points de terminaison privés.
-
-
Le nom de l'itinéraire ne doit pas dépasser 1000 caractères et ne peut inclure aucun caractère spécial autre que l'espace, le tiret
-, le point., le trait de soulignement_et les deux points:.Le nom ne doit pas comporter d'informations d'identification personnelle (PII).
Après avoir configuré une route, il peut s'écouler jusqu'à une heure avant que la configuration ne soit activée.
Accès IAM
Assurez-vous que vous disposez des autorisations IAM correctes pour configurer IBM Cloud Logs Routing
Autorisations IAM
Le tableau suivant répertorie les actions IAM, leur portée et les rôles requis pour gérer les itinéraires.
| Tâche | Action IAM | Champ d'application de la politique IAM | Rôles IAM |
|---|---|---|---|
| Créer une route | logs-router.route.create |
Compte | AdministratorEditor |
| Afficher la liste de toutes les routes | logs-router.route.list |
Compte | AdministratorEditorOperatorViewer |
| Obtenir les détails d'un itinéraire | logs-router.route.read |
Compte | AdministratorEditorOperatorViewer |
| Modifier un itinéraire | logs-router.route.update |
Compte | AdministratorEditor |
| Supprimer une route | logs-router.route.delete |
Compte | AdministratorEditor |
Audit des évènements
Le tableau suivant répertorie les actions IAM, leur portée et les rôles requis pour gérer les itinéraires.
| Tâche | Suivi de l'activité, audit, action événementielle |
|---|---|
| Créer une route | logs-router.route.create |
| Afficher la liste de toutes les routes | logs-router.route.list |
| Obtenir les détails d'un itinéraire | logs-router.route.read |
| Modifier un itinéraire | logs-router.route.update |
| Supprimer une route | logs-router.route.delete |
Prérequis pour l'interface de ligne de commande (CLI)
Avant d'utiliser la CLI pour gérer les itinéraires, effectuez les étapes suivantes :
Gestion des itinéraires à l'aide de l'interface utilisateur
Vous pouvez gérer votre définition d'itinéraire à l'aide de l'interface utilisateur IBM Cloud Logs Routing. Pour plus d'informations, voir Gestion des itinéraires.
Commandes de l'interface de ligne de commande
Le tableau suivant répertorie les actions que vous pouvez exécuter pour gérer les routes :
| Action | Commande |
|---|---|
| Créer une route | ibmcloud logs-router route create |
| Mettre à jour une route | ibmcloud logs-router route update |
| Supprimer une route | ibmcloud logs-router route delete |
| Lire une route | ibmcloud logs-router route get |
| Afficher la liste de toutes les routes | ibmcloud logs-router route list |
Pour plus d'informations, voir IBM Cloud Logs Routing v3 CLI.
Prérequis de l'API
Avant d'utiliser l'API pour gérer les itinéraires, effectuez les étapes suivantes :
- Obtenez un jeton d'accès IAM. Pour plus d'informations, voir Extraction des jetons d'accès IAM.
- 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.
Méthodes d'API
Le tableau suivant répertorie les actions que vous pouvez exécuter pour gérer les routes :
| Action | Méthode d'API REST | URL d'API |
|---|---|---|
Create a route |
POST |
<ENDPOINT>/v3/routes |
Update a route |
PATCH |
<ENDPOINT>/v3/routes/<ROUTE_ID> |
Delete a route |
DELETE |
<ENDPOINT>/v3/routes/<ROUTE_ID> |
Get information about a route |
GET |
<ENDPOINT>/v3/routes/<ROUTE_ID> |
List all routes |
GET |
<ENDPOINT>/v3/routes |
Pour plus d'informations sur l'API REST, voir Routes.
Codes de réponse HTTP
Lorsque vous utilisez l'API REST IBM Cloud Logs 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 :
| Code d'état | Statut | Description |
|---|---|---|
200 |
OK | La demande a abouti. |
201 |
OK | La demande a abouti. Une ressource est créée. |
204 |
OK | L'itinéraire a été supprimé avec succès. |
400 |
Demande incorrecte | La demande n'a pas abouti. Il vous manque peut-être un paramètre obligatoire. |
401 |
Non autorisé | Le jeton IAM utilisé dans la demande d'API n'est pas valide ou est arrivé à expiration. |
403 |
Interdit | L'opération est interdite en raison de droits insuffisants. |
404 |
Introuvable | La ressource demandée n'existe pas ou est déjà supprimée. |
429 |
Trop de demandes | Trop de demandes parviennent trop rapidement à l'API. |
500 |
Erreur de serveur interne | Une erreur s'est produite lors du traitement d'IBM Cloud Logs Routing. |