A propos des routes
You can manage routes in your account by using the IBM Cloud Metrics Routing UI, the IBM Cloud Metrics Routing CLI, the IBM Cloud Metrics Routing REST API, and the IBM Cloud Metrics Routing Terraform provider. Une route définit les règles qui indiquent quelles métriques sont acheminées 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® Metrics Routing est déployé.
-
Vous pouvez définir une route à partir de n'importe quel emplacement pris en charge où IBM Cloud Metrics Routing est disponible. Pour plus d'informations, voir Emplacements.
-
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 Metrics 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 métriques, ces données seront envoyées à plusieurs cibles.
-
Les règles d'une définition de route sont traitées dans l'ordre. La première règle de correspondance (par exemple,
location
) qui correspond aux données de métriques est utilisée pour traiter ces données. Lorsque des indicateurs sont traités, ils ne sont pas traités par une règle ultérieure dans la définition de cette route. Si vous souhaitez spécifier une règle par défaut pour toutes les mesures qui ne sont pas traitées par d'autres règles, vous devez spécifier la règle ("locations" : ["*"]
) comme règle finale dans votre définition derules
pourroute
. -
Si les données des métriques ne correspondent à aucune règle et qu'aucune cible par défaut n'est configurée, les métriques sont abandonnées et ne sont acheminées vers aucune cible.
-
Toute mise à jour d'une ou de plusieurs règles dans une définition de route supprime le jeu de règles existant et le remplace par la configuration spécifiée. Lorsque vous mettez à jour une route, vous devez définir toutes les règles existantes dans le jeu de règles qui ne changent pas et ajouter les modifications aux règles qui doivent être mises à jour.
-
Les informations sur les routes sont stockées sous forme de métadonnées dans l'emplacement principal que vous avez défini pour le compte IBM Cloud.
Si vous ne configurez pas d'emplacement de métadonnées principal, l'emplacement est celui où vous définissez votre première cible dans le compte. Pour plus d'informations, voir Configuration des paramètres de compte.
-
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 itinéraires à partir du réseau privé en utilisant un point de terminaison API avec le format suivant :
https://private.REGION.metrics-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://REGION.metrics-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 Application de noeuds finaux 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 inclure 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
Vérifiez que vous disposez des droits IAM appropriés pour configurer IBM Cloud Metrics Routing.
Autorisations IAM
Le tableau suivant répertorie les actions IAM, leur portée et les rôles requis pour gérer les routes.
Tâche | Action IAM | Portée de la règle IAM | Rôles IAM |
---|---|---|---|
Créer une route | metrics-router.route.create |
Compte | Administrator Editor |
Afficher la liste de toutes les routes | metrics-router.route.list |
Compte | Administrator Editor Operator Viewer |
Obtenir les détails d'un itinéraire | metrics-router.route.read |
Compte | Administrator Editor Operator Viewer |
Modification d'une route | metrics-router.route.update |
Compte | Administrator Editor |
Supprimer une route | metrics-router.route.delete |
Compte | Administrator Editor |
Audit des évènements
Le tableau suivant répertorie les actions IAM, leur portée et les rôles requis pour gérer les routes.
Tâche | Suivi de l'activité, audit, événement, action |
---|---|
Créer une route | metrics-router.route.create |
Afficher la liste de toutes les routes | metrics-router.route.list |
Obtenir les détails d'un itinéraire | metrics-router.route.read |
Modification d'une route | metrics-router.route.update |
Supprimer une route | metrics-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 la définition de votre itinéraire à l'aide de l'interface utilisateur IBM Cloud Metrics 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 metrics-router route create |
Mettre à jour une route | ibmcloud metrics-router route update |
Supprimer une route | ibmcloud metrics-router route rm |
Lire une route | ibmcloud metrics-router route get |
Afficher la liste de toutes les routes | ibmcloud metrics-router route ls |
Pour plus d'informations, voir Interface de ligne de commandeIBM Cloud Metrics Routing v3.
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>/api/v3/routes |
Update a route |
PATCH |
<ENDPOINT>/api/v3/routes/<ROUTE_ID> |
Delete a route |
DELETE |
<ENDPOINT>/api/v3/routes/<ROUTE_ID> |
Get information about a route |
GET |
<ENDPOINT>/api/v3/routes/<ROUTE_ID> |
List all routes |
GET |
<ENDPOINT>/api/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 Metrics 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 Metrics Routing. |