Exemplos de uso da CLI com o Network Flow Monitor - Amazon CloudWatch
Criar um monitorVisualizar detalhes do monitorCriar um escopoExcluir um monitorExcluir um escopoObter informações sobre um monitorRecuperar dados de consultas específicasVer informações do escopoVer uma lista de monitores de uma contaVer uma lista de escopos de uma contaVer a lista de tags de um monitorIniciar e interromper consultasMarcar um monitorRemover uma tag de um monitorAtualizar um monitor existente

Exemplos de uso da CLI com o Network Flow Monitor

Esta seção inclui exemplos de uso da AWS Command Line Interface com operações do Network Flow Monitor.

Antes de começar, certifique-se de fazer login para usar a AWS CLI com a conta da AWS que fornece o escopo que você deseja usar para monitorar os fluxos de rede. Para obter mais informações sobre como usar ações de API com o Network Flow Monitor, consulte o Guia de referência de APIs do Network Flow Monitor.

Criar um monitor

Para criar um monitor com a AWS CLI, use o comando create-monitor. O exemplo a seguir cria um monitor denominado demo na conta especificada.

aws networkflowmonitor create-monitor \
        --monitor-name demo \
        --local-resources type="AWS::EC2::VPC",identifier="arn:aws:ec2:us-east-1:111122223333:vpc/vpc-11223344556677889"  \
        --scope-arn arn:aws:networkflowmonitor:us-east-1:111122223333:scope/sample-aaaa-bbbb-cccc-44556677889

Saída:

{
        "monitorArn": "arn:aws:networkflowmonitor:us-east-1:111122223333:monitor/demo",
        "monitorName": "demo",
        "monitorStatus": "ACTIVE",
        "tags": {}
    }

Para obter mais informações, consulte Criar um monitor no Network Flow Monitor.

Visualizar detalhes do monitor

Para visualizar informações sobre um monitor com a AWS CLI, use o comando get-monitor.

aws networkflowmonitor get-monitor --monitor-name "TestMonitor"

Saída:

{
    "ClientLocationType": "city",
    "CreatedAt": "2022-09-22T19:27:47Z",
    "ModifiedAt": "2022-09-22T19:28:30Z",
    "MonitorArn": "arn:aws:networkflowmonitor:us-east-1:111122223333:monitor/TestMonitor",
    "MonitorName": "TestMonitor",
    "ProcessingStatus": "OK",
    "ProcessingStatusInfo": "The monitor is actively processing data",
    "Resources": [
        "arn:aws:ec2:us-east-1:111122223333:vpc/vpc-11223344556677889"
    ],
    "MaxCityNetworksToMonitor": 10000,
    "Status": "ACTIVE"
}

Criar um escopo

O exemplo de create-scope a seguir cria um escopo que inclui um conjunto de recursos para os quais o Network Flow Monitor vai gerar métricas de tráfego de rede.

aws networkflowmonitor create-scope \
        --targets '[{"targetIdentifier":{"targetId":{"accountId":"111122223333"},"targetType":"ACCOUNT"},"region":"us-east-1"}]'

Saída:


    {
        "scopeId": "sample-aaaa-bbbb-cccc-11112222333",
        "status": "IN_PROGRESS",
        "tags": {}
    }

Para obter mais informações, consulte Componentes e recursos do Network Flow Monitor.

Excluir um monitor

O exemplo de delete-monitor a seguir exclui um monitor denominado Demo na sua conta.

aws networkflowmonitor delete-monitor \
        --monitor-name Demo

Este comando não produz saída.

Para obter mais informações, consulte Excluir um monitor no Network Flow Monitor.

Excluir um escopo

O exemplo de delete-scope a seguir exclui o escopo especificado.

aws networkflowmonitor delete-scope \
        --scope-id sample-aaaa-bbbb-cccc-44556677889

Este comando não produz saída.

Para obter mais informações, consulte Componentes e recursos do Network Flow Monitor.

Obter informações sobre um monitor

O exemplo de get-monitor a seguir exibe as informações sobre o painel chamado demo na conta especificada.

aws networkflowmonitor get-monitor \ 
        --monitor-name Demo

Saída:

{
        "monitorArn": "arn:aws:networkflowmonitor:us-east-1:111122223333:monitor/Demo",
        "monitorName": "Demo",
        "monitorStatus": "ACTIVE",
        "localResources": [
            {
                "type": "AWS::EC2::VPC",
                "identifier": "arn:aws:ec2:us-east-1:111122223333:vpc/vpc-11223344556677889"
            }
        ],
        "remoteResources": [],
        "createdAt": "2024-12-09T12:21:51.616000-06:00",
        "modifiedAt": "2024-12-09T12:21:55.412000-06:00",
        "tags": {}
    }

Para obter mais informações, consulte Componentes e recursos do Network Flow Monitor.

Recuperar dados de consultas específicas

As seções a seguir fornecem exemplos de comandos da CLI para recuperar os status das consultas.

get-query-results-workload-insights-top-contributors-data

O exemplo de get-query-results-workload-insights-top-contributors-data retorna os dados da consulta especificada.

aws networkflowmonitor get-query-results-workload-insights-top-contributors-data \
        --scope-id sample-aaaa-bbbb-cccc-11112222333 \
        --query-id sample-dddd-eeee-ffff-44556677889

Saída:

{
        "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"
    }

get-query-results-workload-insights-top-contributors

O exemplo de get-query-results-workload-insights-top-contributors a seguir retorna os dados da consulta especificada.

aws networkflowmonitor get-query-results-workload-insights-top-contributors \
        --scope-id sample-aaaa-bbbb-cccc-11112222333 \
        --query-id sample-dddd-eeee-ffff-44556677889

Saída:

{
        "topContributors": [
            {
                "accountId": "111122223333",
                "localSubnetId": "subnet-SAMPLE1111",
                "localAz": "use1-az6",
                "localVpcId": "vpc-SAMPLE2222",
                "localRegion": "us-east-1",
                "remoteIdentifier": "",
                "value": 333333,
                "localSubnetArn": "arn:aws:ec2:us-east-1:111122223333:subnet/subnet-2222444455556666",
                "localVpcArn": "arn:aws:ec2:us-east-1:111122223333:vpc/vpc-11223344556677889"
            }
        ]
    }

get-query-status-monitor-top-contributors

O exemplo de get-query-status-monitor-top-contributors a seguir exibe o status atual da consulta na conta especificada.

aws networkflowmonitor get-query-status-monitor-top-contributors \
        --monitor-name Demo \
        --query-id sample-dddd-eeee-ffff-44556677889

Saída:

{
        "status": "SUCCEEDED"
    }

get-query-status-workload-insights-top-contributors-data

O exemplo de get-query-status-workload-insights-top-contributors-data a seguir exibe o status atual da consulta na conta especificada.

aws networkflowmonitor get-query-status-workload-insights-top-contributors-data \
        --scope-id sample-aaaa-bbbb-cccc-11112222333 \
        --query-id sample-dddd-eeee-ffff-44556677889

Saída:

{
        "status": "SUCCEEDED"
    }

get-query-results-workload-insights-top-contributors

O exemplo de get-query-results-workload-insights-top-contributors a seguir exibe o status atual da consulta na conta especificada.

aws networkflowmonitor get-query-status-workload-insights-top-contributors \
        --scope-id sample-aaaa-bbbb-cccc-11112222333 \
        --query-id sample-dddd-eeee-ffff-44556677889

Saída:

{
        "status": "SUCCEEDED"
    }

Para obter mais informações, consulte Avaliar fluxos de rede com insights de workloads.

Ver informações do escopo

O exemplo de get-scope a seguir exibe informações sobre um escopo, como status, tags, nome e detalhes do destino.

aws networkflowmonitor get-scope \
        --scope-id sample-aaaa-bbbb-cccc-11112222333

Saída:

{
        "scopeId": "sample-aaaa-bbbb-cccc-11112222333",
        "status": "SUCCEEDED",
        "scopeArn": "arn:aws:networkflowmonitor:us-east-1:111122223333:scope/sample-aaaa-bbbb-cccc-11112222333",
        "targets": [
            {
                "targetIdentifier": {
                    "targetId": {
                        "accountId": "111122223333"
                    },
                    "targetType": "ACCOUNT"
                },
                "region": "us-east-1"
            }
        ],
        "tags": {}
    }

Para obter mais informações, consulte Componentes e recursos do Network Flow Monitor.

Ver uma lista de monitores de uma conta

O exemplo de list-monitors a seguir retorna todos os monitores na conta especificada.

aws networkflowmonitor list-monitors

Saída:

{
        "monitors": [
            {
                "monitorArn": "arn:aws:networkflowmonitor:us-east-1:111122223333:monitor/Demo",
                "monitorName": "Demo",
                "monitorStatus": "ACTIVE"
            }
        ]
    }

Para obter mais informações, consulte Componentes e recursos do Network Flow Monitor.

Ver uma lista de escopos de uma conta

O exemplo de list-scopes a seguir lista todos os escopos na conta especificada.

aws networkflowmonitor list-scopes

Saída:

{
        "scopes": [
            {
                "scopeId": "sample-aaaa-bbbb-cccc-11112222333",
                "status": "SUCCEEDED",
                "scopeArn": "arn:aws:networkflowmonitor:us-east-1:111122223333:scope/sample-aaaa-bbbb-cccc-11112222333"
            }
        ]
    }

Para obter mais informações, consulte Componentes e recursos do Network Flow Monitor.

Ver a lista de tags de um monitor

O exemplo de list-tags-for-resource a seguir retorna as tags associadas ao recurso especificado.

aws networkflowmonitor list-tags-for-resource \
        --resource-arn arn:aws:networkflowmonitor:us-east-1:111122223333:monitor/Demo

Saída:

{
        "tags": {
            "Value": "Production",
            "Key": "stack"
        }
    }

Para obter mais informações, consulte Etiquetar recursos do Amazon CloudWatch.

Iniciar e interromper consultas

As seções a seguir fornecem exemplos de comandos da CLI para iniciar e interromper consultas no Network Flow Monitor.

start-query-monitor-top-contributors

O exemplo de start-query-monitor-top-contributors a seguir inicia a consulta que retorna um queryId para recuperar os principais colaboradores.

aws networkflowmonitor start-query-monitor-top-contributors \
        --monitor-name Demo \
        --start-time 2024-12-09T19:00:00Z \
        --end-time 2024-12-09T19:15:00Z \
        --metric-name DATA_TRANSFERRED \
        --destination-category UNCLASSIFIED

Saída:

{
        "queryId": "sample-dddd-eeee-ffff-44556677889"
    }

Para obter mais informações, consulte Avaliar fluxos de rede com insights de workloads.

start-query-workload-insights-top-contributors-data

O exemplo de start-query-workload-insights-top-contributors-data a seguir inicia a consulta que retorna um queryId para recuperar os principais colaboradores.

aws networkflowmonitor start-query-workload-insights-top-contributors-data \
        --scope-id sample-aaaa-bbbb-cccc-11112222333 \
        --start-time 2024-12-09T19:00:00Z \
        --end-time 2024-12-09T19:15:00Z \
        --metric-name DATA_TRANSFERRED \
        --destination-category UNCLASSIFIED

Saída:

{
        "queryId": "sample-dddd-eeee-ffff-44556677889"
    }

Para obter mais informações, consulte Avaliar fluxos de rede com insights de workloads.

start-query-workload-insights-top-contributors

O exemplo de start-query-workload-insights-top-contributors a seguir inicia a consulta que retorna um queryId para recuperar os principais colaboradores.

aws networkflowmonitor start-query-workload-insights-top-contributors \
        --scope-id sample-aaaa-bbbb-cccc-11112222333 \
        --start-time 2024-12-09T19:00:00Z \
        --end-time 2024-12-09T19:15:00Z \
        --metric-name DATA_TRANSFERRED \
        --destination-category UNCLASSIFIED

Saída:

{
        "queryId": "sample-dddd-eeee-ffff-44556677889"
    }

Para obter mais informações, consulte Avaliar fluxos de rede com insights de workloads.

stop-query-monitor-top-contributors

O exemplo de stop-query-monitor-top-contributors a seguir interrompe a consulta na conta especificada.

aws networkflowmonitor stop-query-monitor-top-contributors \
        --monitor-name Demo \
        --query-id sample-dddd-eeee-ffff-44556677889

Este comando não produz saída.

Para obter mais informações, consulte Avaliar fluxos de rede com insights de workloads.

stop-query-workload-insights-top-contributors-data

O comando stop-query-workload-insights-top-contributors-data a seguir interrompe a consulta na conta especificada.

aws networkflowmonitor stop-query-workload-insights-top-contributors-data \ 
        --scope-id sample-aaaa-bbbb-cccc-11112222333 \
        --query-id sample-dddd-eeee-ffff-44556677889

Este comando não produz saída.

Para obter mais informações, consulte Avaliar fluxos de rede com insights de workloads.

stop-query-workload-insights-top-contributors

O exemplo de stop-query-workload-insights-top-contributors a seguir interrompe a consulta na conta especificada.

aws networkflowmonitor stop-query-workload-insights-top-contributors \ 
        --scope-id sample-aaaa-bbbb-cccc-11112222333 \
        --query-id sample-dddd-eeee-ffff-44556677889

Este comando não produz saída.

Para obter mais informações, consulte Avaliar fluxos de rede com insights de workloads.

Marcar um monitor

O comando tag-resource a seguir adiciona uma tag ao monitor na conta especificada.

aws networkflowmonitor tag-resource \
        --resource-arn arn:aws:networkflowmonitor:us-east-1:111122223333:monitor/Demo \
        --tags Key=stack,Value=Production

Este comando não produz saída.

Para obter mais informações, consulte Etiquetar recursos do Amazon CloudWatch.

Remover uma tag de um monitor

O exemplo de untag-resource a seguir remove uma tag do monitor na conta especificada.

aws networkflowmonitor untag-resource \
        --resource-arn arn:aws:networkflowmonitor:us-east-1:111122223333:monitor/Demo \
        --tag-keys stack

Este comando não produz saída.

Para obter mais informações, consulte Etiquetar recursos do Amazon CloudWatch.

Atualizar um monitor existente

O exemplo de update-monitor a seguir atualiza o monitor denominado “Demo” na conta especificada.

aws networkflowmonitor update-monitor \
        --monitor-name Demo \
        --local-resources-to-add type="AWS::EC2::VPC",identifier="arn:aws:ec2:us-east-1:111122223333:vpc/vpc-11223344556677889"

Saída:

{
        "monitorArn": "arn:aws:networkflowmonitor:us-east-1:111122223333:monitor/Demo",
        "monitorName": "Demo",
        "monitorStatus": "ACTIVE",
        "tags": {
            "Value": "Production",
            "Key": "stack"
        }
    }

Para obter mais informações, consulte Componentes e recursos do Network Flow Monitor.