Exemples d’utilisation de l’AWS CLI avec Network Flow Monitor
Les exemples de code suivants montrent comment réaliser des actions et mettre en œuvre des scénarios courants en utilisant l’AWS Command Line Interface avec Network Flow Monitor.
Les actions sont des extraits de code de programmes plus larges et doivent être exécutées dans leur contexte. Alors que les actions vous indiquent comment appeler des fonctions de service individuelles, vous pouvez les voir en contexte dans leurs scénarios associés.
Chaque exemple inclut un lien vers le code source complet, où vous trouverez des instructions sur la configuration et l’exécution du code en contexte.
Rubriques
Actions
L’exemple de code suivant montre comment utiliser create-monitor.
- AWS CLI
-
Pour créer un moniteur
L’exemple
create-monitorsuivant crée un moniteur nommédemodans le compte spécifié.aws networkflowmonitor create-monitor \ --monitor-namedemo\ --local-resources type="AWS::EC2::VPC",identifier="arn:aws:ec2:us-east-1:123456789012:vpc/vpc-03ea55eeda25adbb0" \ --scope-arnarn:aws:networkflowmonitor:us-east-1:123456789012:scope/e21cda79-30a0-4c12-9299-d8629d76d8cfSortie :
{ "monitorArn": "arn:aws:networkflowmonitor:us-east-1:123456789012:monitor/demo", "monitorName": "demo", "monitorStatus": "ACTIVE", "tags": {} }Pour plus d’informations, consultez Créer un moniteur dans Network Flow Monitor dans le Guide de l’utilisateur Amazon CloudWatch.
-
Pour plus de détails sur l’API, consultez CreateMonitor
dans la Référence des commandes de l’AWS CLI.
-
L’exemple de code suivant montre comment utiliser create-scope.
- AWS CLI
-
Pour créer une portée
L’exemple
create-scopesuivant crée une portée qui inclut un ensemble de ressources pour lesquelles Network Flow Monitor générera des métriques de trafic réseau.aws networkflowmonitor create-scope \ --targets '[{"targetIdentifier":{"targetId":{"accountId":"123456789012"},"targetType":"ACCOUNT"},"region":"us-east-1"}]'Sortie :
{ "scopeId": "97626f8d-8a21-4b5d-813a-1a0962dd4615", "status": "IN_PROGRESS", "tags": {} }Pour plus d’informations, consultez Composants et fonctionnalités de Network Flow Monitor dans le Guide de l’utilisateur Amazon CloudWatch.
-
Pour plus de détails sur l’API, consultez CreateScope
dans la Référence des commandes de l’AWS CLI.
-
L’exemple de code suivant montre comment utiliser delete-monitor.
- AWS CLI
-
Pour supprimer un moniteur
L’exemple
delete-monitorsuivant supprime un moniteur nommédemodans le compte spécifié.aws networkflowmonitor delete-monitor \ --monitor-namedemoCette commande ne produit aucune sortie.
Pour plus d’informations, consultez Supprimer un moniteur dans Network Flow Monitor dans le Guide de l’utilisateur Amazon CloudWatch.
-
Pour plus de détails sur l’API, consultez DeleteMonitor
dans la Référence des commandes de l’AWS CLI.
-
L’exemple de code suivant montre comment utiliser delete-scope.
- AWS CLI
-
Pour supprimer une portée
L’exemple
delete-scopesuivant supprime une portée spécifiée.aws networkflowmonitor delete-scope \ --scope-idfdc20616-6bb4-4242-a24e-a748e65ca7acCette commande ne produit aucune sortie.
Pour plus d’informations, consultez Composants et fonctionnalités de Network Flow Monitor dans le Guide de l’utilisateur Amazon CloudWatch.
-
Pour plus de détails sur l’API, consultez DeleteScope
dans la Référence des commandes de l’AWS CLI.
-
L’exemple de code suivant montre comment utiliser get-monitor.
- AWS CLI
-
Pour récupérer les informations sur un moniteur
L’exemple
get-monitorsuivant affiche les informations sur le moniteur nommédemodans le compte spécifié.aws networkflowmonitor get-monitor \ --monitor-nameDemoSortie :
{ "monitorArn": "arn:aws:networkflowmonitor:us-east-1:123456789012:monitor/Demo", "monitorName": "Demo", "monitorStatus": "ACTIVE", "localResources": [ { "type": "AWS::EC2::VPC", "identifier": "arn:aws:ec2:us-east-1:123456789012:vpc/vpc-03ea55eeda25adbb0" } ], "remoteResources": [], "createdAt": "2024-12-09T12:21:51.616000-06:00", "modifiedAt": "2024-12-09T12:21:55.412000-06:00", "tags": {} }Pour plus d’informations, consultez Composants et fonctionnalités de Network Flow Monitor dans le Guide de l’utilisateur Amazon CloudWatch.
-
Pour plus de détails sur l’API, consultez GetMonitor
dans la Référence des commandes de l’AWS CLI.
-
L’exemple de code suivant montre comment utiliser get-query-results-workload-insights-top-contributors-data.
- AWS CLI
-
Pour récupérer les données des meilleurs contributeurs sur les informations relatives à la charge de travail
L’exemple
get-query-results-workload-insights-top-contributors-datasuivant renvoie les données pour la requête spécifiée.aws networkflowmonitor get-query-results-workload-insights-top-contributors-data \ --scope-ide21cda79-30a0-4c12-9299-d8629d76d8cf\ --query-idcc4f4ab3-3103-33b8-80ff-d6597a0c6ceaSortie :
{ "datapoints": [ { "timestamps": [ "2024-12-09T19:00:00+00:00", "2024-12-09T19:05:00+00:00", "2024-12-09T19:10:00+00:00" ], "values": [ 259943.0, 194856.0, 216432.0 ], "label": "use1-az6" } ], "unit": "Bytes" }Pour plus d’informations, consultez Évaluer les flux réseau avec des informations sur la charge de travail dans le Guide de l’utilisateur Amazon CloudWatch.
-
Pour plus de détails sur l’API, consultez GetQueryResultsWorkloadInsightsTopContributorsData
dans la Référence des commandes de l’AWS CLI.
-
L’exemple de code suivant montre comment utiliser get-query-results-workload-insights-top-contributors.
- AWS CLI
-
Pour récupérer les meilleurs contributeurs sur les informations relatives à la charge de travail
L’exemple
get-query-results-workload-insights-top-contributorssuivant renvoie les données pour la requête spécifiée.aws networkflowmonitor get-query-results-workload-insights-top-contributors \ --scope-ide21cda79-30a0-4c12-9299-d8629d76d8cf\ --query-id1fc423d3-b144-37a6-80e6-e2c7d26eea0cSortie :
{ "topContributors": [ { "accountId": "123456789012", "localSubnetId": "subnet-0a5b30fb95dca2c14", "localAz": "use1-az6", "localVpcId": "vpc-03ea55eeda25adbb0", "localRegion": "us-east-1", "remoteIdentifier": "", "value": 908443, "localSubnetArn": "arn:aws:ec2:us-east-1:123456789012:subnet/subnet-0a5b30fb95dca2c14", "localVpcArn": "arn:aws:ec2:us-east-1:123456789012:vpc/vpc-03ea55eeda25adbb0" } ] }Pour plus d’informations, consultez Évaluer les flux réseau avec des informations sur la charge de travail dans le Guide de l’utilisateur Amazon CloudWatch.
-
Pour plus de détails sur l’API, consultez GetQueryResultsWorkloadInsightsTopContributors
dans la Référence des commandes de l’AWS CLI.
-
L’exemple de code suivant montre comment utiliser get-query-status-monitor-top-contributors.
- AWS CLI
-
Pour récupérer le statut de la requête
L’exemple
get-query-status-monitor-top-contributorssuivant affiche l’état actuel de la requête dans le compte spécifié.aws networkflowmonitor get-query-status-monitor-top-contributors \ --monitor-nameDemo\ --query-id5398eabd-bc40-3f5f-aba3-bcb639d3c7caSortie :
{ "status": "SUCCEEDED" }Pour plus d’informations, consultez Évaluer les flux réseau avec des informations sur la charge de travail dans le Guide de l’utilisateur Amazon CloudWatch.
-
Pour plus de détails sur l’API, consultez GetQueryStatusMonitorTopContributors
dans la Référence des commandes de l’AWS CLI.
-
L’exemple de code suivant montre comment utiliser get-query-status-workload-insights-top-contributors-data.
- AWS CLI
-
Pour récupérer le statut de la requête
L’exemple
get-query-status-workload-insights-top-contributors-datasuivant affiche l’état actuel de la requête dans le compte spécifié.aws networkflowmonitor get-query-status-workload-insights-top-contributors-data \ --scope-ide21cda79-30a0-4c12-9299-d8629d76d8cf\ --query-id4333754d-8ae1-3f29-b6b7-c36db2e7f8acSortie :
{ "status": "SUCCEEDED" }Pour plus d’informations, consultez Évaluer les flux réseau avec des informations sur la charge de travail dans le Guide de l’utilisateur Amazon CloudWatch.
-
Pour plus de détails sur l’API, consultez GetQueryStatusWorkloadInsightsTopContributorsData
dans la Référence des commandes de l’AWS CLI.
-
L’exemple de code suivant montre comment utiliser get-query-status-workload-insights-top-contributors.
- AWS CLI
-
Pour récupérer le statut de la requête
L’exemple
get-query-status-workload-insights-top-contributorssuivant affiche l’état actuel de la requête dans le compte spécifié.aws networkflowmonitor get-query-status-workload-insights-top-contributors \ --scope-ide21cda79-30a0-4c12-9299-d8629d76d8cf\ --query-idf2a87c70-3e5a-362e-8beb-4747d13d8419Sortie :
{ "status": "SUCCEEDED" }Pour plus d’informations, consultez Évaluer les flux réseau avec des informations sur la charge de travail dans le Guide de l’utilisateur Amazon CloudWatch.
-
Pour plus de détails sur l’API, consultez GetQueryStatusWorkloadInsightsTopContributors
dans la Référence des commandes de l’AWS CLI.
-
L’exemple de code suivant montre comment utiliser get-scope.
- AWS CLI
-
Pour récupérer les informations sur une portée
L’exemple
get-scopesuivant affiche les informations sur une portée, telles que l’état, les balises, le nom et les détails de la cible.aws networkflowmonitor get-scope \ --scope-ide21cda79-30a0-4c12-9299-d8629d76d8cfSortie :
{ "scopeId": "e21cda79-30a0-4c12-9299-d8629d76d8cf", "status": "SUCCEEDED", "scopeArn": "arn:aws:networkflowmonitor:us-east-1:123456789012:scope/e21cda79-30a0-4c12-9299-d8629d76d8cf", "targets": [ { "targetIdentifier": { "targetId": { "accountId": "123456789012" }, "targetType": "ACCOUNT" }, "region": "us-east-1" } ], "tags": {} }Pour plus d’informations, consultez Composants et fonctionnalités de Network Flow Monitor dans le Guide de l’utilisateur Amazon CloudWatch.
-
Pour plus de détails sur l’API, consultez GetScope
dans la Référence des commandes de l’AWS CLI.
-
L’exemple de code suivant montre comment utiliser list-monitors.
- AWS CLI
-
Pour récupérer une liste de moniteurs
L’exemple
list-monitorssuivant renvoie tous les moniteurs du compte spécifié.aws networkflowmonitor list-monitorsSortie :
{ "monitors": [ { "monitorArn": "arn:aws:networkflowmonitor:us-east-1:123456789012:monitor/Demo", "monitorName": "Demo", "monitorStatus": "ACTIVE" } ] }Pour plus d’informations, consultez Composants et fonctionnalités de Network Flow Monitor dans le Guide de l’utilisateur Amazon CloudWatch.
-
Pour plus de détails sur l’API, consultez ListMonitors
dans la Référence des commandes de l’AWS CLI.
-
L’exemple de code suivant montre comment utiliser list-scopes.
- AWS CLI
-
Pour récupérer une liste de portées
L’exemple
list-scopessuivant répertorie toutes les portées du compte spécifié.aws networkflowmonitor list-scopesSortie :
{ "scopes": [ { "scopeId": "fdc20616-6bb4-4242-a24e-a748e65ca7ac", "status": "SUCCEEDED", "scopeArn": "arn:aws:networkflowmonitor:us-east-1:123456789012:scope/fdc20616-6bb4-4242-a24e-a748e65ca7ac" } ] }Pour plus d’informations, consultez Composants et fonctionnalités de Network Flow Monitor dans le Guide de l’utilisateur Amazon CloudWatch.
-
Pour plus de détails sur l’API, consultez ListScopes
dans la Référence des commandes de l’AWS CLI.
-
L’exemple de code suivant montre comment utiliser list-tags-for-resource.
- AWS CLI
-
Pour répertorier les balises
L’exemple
list-tags-for-resourcesuivant renvoie toutes les balises associées à la ressource spécifiée.aws networkflowmonitor list-tags-for-resource \ --resource-arnarn:aws:networkflowmonitor:us-east-1:123456789012:monitor/DemoSortie :
{ "tags": { "Value": "Production", "Key": "stack" } }Pour plus d’informations, consultez Balisage de vos ressources Amazon CloudWatch dans le Guide de l’utilisateur Amazon CloudWatch.
-
Pour plus de détails sur l’API, consultez ListTagsForResource
dans la Référence des commandes de l’AWS CLI.
-
L’exemple de code suivant montre comment utiliser start-query-monitor-top-contributors.
- AWS CLI
-
Pour démarrer une requête
L’exemple
start-query-monitor-top-contributorssuivant lance la requête qui renvoie un ID de requête pour récupérer les meilleurs contributeurs.aws networkflowmonitor start-query-monitor-top-contributors \ --monitor-nameDemo\ --start-time2024-12-09T19:00:00Z\ --end-time2024-12-09T19:15:00Z\ --metric-nameDATA_TRANSFERRED\ --destination-categoryUNCLASSIFIEDSortie :
{ "queryId": "aecd3a88-0283-35b0-a17d-6e944dc8531d" }Pour plus d’informations, consultez Évaluer les flux réseau avec des informations sur la charge de travail dans le Guide de l’utilisateur Amazon CloudWatch.
-
Pour plus de détails sur l’API, consultez StartQueryMonitorTopContributors
dans la Référence des commandes de l’AWS CLI.
-
L’exemple de code suivant montre comment utiliser start-query-workload-insights-top-contributors-data.
- AWS CLI
-
Pour démarrer une requête
L’exemple
start-query-workload-insights-top-contributors-datasuivant lance la requête qui renvoie un ID de requête pour récupérer les meilleurs contributeurs.aws networkflowmonitor start-query-workload-insights-top-contributors-data \ --scope-ide21cda79-30a0-4c12-9299-d8629d76d8cf\ --start-time2024-12-09T19:00:00Z\ --end-time2024-12-09T19:15:00Z\ --metric-nameDATA_TRANSFERRED\ --destination-categoryUNCLASSIFIEDSortie :
{ "queryId": "cc4f4ab3-3103-33b8-80ff-d6597a0c6cea" }Pour plus d’informations, consultez Évaluer les flux réseau avec des informations sur la charge de travail dans le Guide de l’utilisateur Amazon CloudWatch.
-
Pour plus de détails sur l’API, consultez StartQueryWorkloadInsightsTopContributorsData
dans la Référence des commandes de l’AWS CLI.
-
L’exemple de code suivant montre comment utiliser start-query-workload-insights-top-contributors.
- AWS CLI
-
Pour démarrer une requête
L’exemple
start-query-workload-insights-top-contributorssuivant lance la requête qui renvoie un ID de requête pour récupérer les meilleurs contributeurs.aws networkflowmonitor start-query-workload-insights-top-contributors \ --scope-ide21cda79-30a0-4c12-9299-d8629d76d8cf\ --start-time2024-12-09T19:00:00Z\ --end-time2024-12-09T19:15:00Z\ --metric-nameDATA_TRANSFERRED\ --destination-categoryUNCLASSIFIEDSortie :
{ "queryId": "1fc423d3-b144-37a6-80e6-e2c7d26eea0c" }Pour plus d’informations, consultez Évaluer les flux réseau avec des informations sur la charge de travail dans le Guide de l’utilisateur Amazon CloudWatch.
-
Pour plus de détails sur l’API, consultez StartQueryWorkloadInsightsTopContributors
dans la Référence des commandes de l’AWS CLI.
-
L’exemple de code suivant montre comment utiliser stop-query-monitor-top-contributors.
- AWS CLI
-
Pour arrêter une requête
L’exemple
stop-query-monitor-top-contributorssuivant arrête la requête dans le compte spécifié.aws networkflowmonitor stop-query-monitor-top-contributors \ --monitor-nameDemo\ --query-idaecd3a88-0283-35b0-a17d-6e944dc8531dCette commande ne produit aucune sortie.
Pour plus d’informations, consultez Évaluer les flux réseau avec des informations sur la charge de travail dans le Guide de l’utilisateur Amazon CloudWatch.
-
Pour plus de détails sur l’API, consultez StopQueryMonitorTopContributors
dans la Référence des commandes de l’AWS CLI.
-
L’exemple de code suivant montre comment utiliser stop-query-workload-insights-top-contributors-data.
- AWS CLI
-
Pour arrêter une requête
L’exemple
stop-query-workload-insights-top-contributors-datasuivant arrête la requête dans le compte spécifié.aws networkflowmonitor stop-query-workload-insights-top-contributors-data \ --scope-ide21cda79-30a0-4c12-9299-d8629d76d8cf\ --query-idcc4f4ab3-3103-33b8-80ff-d6597a0c6ceaCette commande ne produit aucune sortie.
Pour plus d’informations, consultez Évaluer les flux réseau avec des informations sur la charge de travail dans le Guide de l’utilisateur Amazon CloudWatch.
-
Pour plus de détails sur l’API, consultez StopQueryWorkloadInsightsTopContributorsData
dans la Référence des commandes de l’AWS CLI.
-
L’exemple de code suivant montre comment utiliser stop-query-workload-insights-top-contributors.
- AWS CLI
-
Pour arrêter une requête
L’exemple
stop-query-workload-insights-top-contributorssuivant arrête la requête dans le compte spécifié.aws networkflowmonitor stop-query-workload-insights-top-contributors \ --scope-ide21cda79-30a0-4c12-9299-d8629d76d8cf\ --query-id1fc423d3-b144-37a6-80e6-e2c7d26eea0cCette commande ne produit aucune sortie.
Pour plus d’informations, consultez Évaluer les flux réseau avec des informations sur la charge de travail dans le Guide de l’utilisateur Amazon CloudWatch.
-
Pour plus de détails sur l’API, consultez StopQueryWorkloadInsightsTopContributors
dans la Référence des commandes de l’AWS CLI.
-
L’exemple de code suivant montre comment utiliser tag-resource.
- AWS CLI
-
Pour ajouter une balise à la ressource spécifiée
L’exemple
tag-resourcesuivant ajoute une balise au moniteur dans le compte spécifié.aws networkflowmonitor tag-resource \ --resource-arnarn:aws:networkflowmonitor:us-east-1:123456789012:monitor/Demo\ --tagsKey=stack,Value=ProductionCette commande ne produit aucune sortie.
Pour plus d’informations, consultez Balisage de vos ressources Amazon CloudWatch dans le Guide de l’utilisateur Amazon CloudWatch.
-
Pour plus de détails sur l’API, consultez TagResource
dans la Référence des commandes de l’AWS CLI.
-
L’exemple de code suivant montre comment utiliser untag-resource.
- AWS CLI
-
Pour supprimer une balise de la ressource spécifiée
L’exemple
untag-resourcesuivant supprime une balise du moniteur dans le compte spécifié.aws networkflowmonitor untag-resource \ --resource-arnarn:aws:networkflowmonitor:us-east-1:123456789012:monitor/Demo\ --tag-keysstackCette commande ne produit aucune sortie.
Pour plus d’informations, consultez Balisage de vos ressources Amazon CloudWatch dans le Guide de l’utilisateur Amazon CloudWatch.
-
Pour plus de détails sur l’API, consultez UntagResource
dans la Référence des commandes de l’AWS CLI.
-
L’exemple de code suivant montre comment utiliser update-monitor.
- AWS CLI
-
Pour mettre à jour un moniteur existant
L’exemple
update-monitorsuivant met à jour le moniteur nomméDemodans le compte spécifié.aws networkflowmonitor update-monitor \ --monitor-nameDemo\ --local-resources-to-add type="AWS::EC2::VPC",identifier="arn:aws:ec2:us-east-1:123456789012:vpc/vpc-048d08dfbec623f94"Sortie :
{ "monitorArn": "arn:aws:networkflowmonitor:us-east-1:123456789012:monitor/Demo", "monitorName": "Demo", "monitorStatus": "ACTIVE", "tags": { "Value": "Production", "Key": "stack" } }Pour plus d’informations, consultez Composants et fonctionnalités de Network Flow Monitor dans le Guide de l’utilisateur Amazon CloudWatch.
-
Pour plus de détails sur l’API, consultez UpdateMonitor
dans la Référence des commandes de l’AWS CLI.
-