Exemplos do Monitor de Rede do CloudWatch usando a AWS CLI

Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o AWS Command Line Interface com o Monitor de Rede do CloudWatch.

Ações são trechos de código de programas maiores e devem ser executadas em contexto. Embora as ações mostrem como chamar funções de serviço individuais, você pode ver as ações no contexto em seus cenários relacionados.

Cada exemplo inclui um link para o código-fonte completo, em que você pode encontrar instruções sobre como configurar e executar o código.

Tópicos

Ações

Ações

O código de exemplo a seguir mostra como usar create-monitor.

AWS CLI

Exemplo 1: criar um monitor de rede com um período de agregação

O exemplo create-monitor a seguir cria um monitor chamado Example_NetworkMonitor com um aggregationPeriod definido como 30 segundos. O state inicial do monitor será INACTIVE, porque não há sondas associadas a ele. O estado muda para ACTIVE somente quando as sondas são adicionadas. É possível usar os comandos update-monitor ou create-probe para adicionar sondas a esse monitor.


aws networkmonitor create-monitor \
     --monitor-name Example_NetworkMonitor \
     --aggregation-period 30

Saída:


{
    "monitorArn": "arn:aws:networkmonitor:region:111122223333:monitor/Example_NetworkMonitor",
    "monitorName": "Example_NetworkMonitor",
    "state": "INACTIVE",
    "aggregationPeriod": 30,
    "tags": {}
}

Para obter mais informações, consulte Como o Monitor de Rede do Amazon CloudWatch funciona no Guia do usuário do Amazon CloudWatch.

Exemplo 2: criar um monitor de rede com uma sonda usando TCP e também incluir tags

O exemplo create-monitor a seguir cria um monitor chamado Example_NetworkMonitor. O comando também cria uma sonda que usa o protocolo ICMP e inclui tags. Como nenhum aggregationPeriod é passado na solicitação, 60 segundos são definidos como padrão. O state do monitor com a sonda permanecerá como PENDING até que o monitor esteja ACTIVE. Isso pode levar alguns minutos, quando então state mudará para ACTIVE, e será possível visualizar as métricas do CloudWatch.


aws networkmonitor create-monitor \
    --monitor-name Example_NetworkMonitor \
    --probes sourceArn=arn:aws:ec2:region:111122223333:subnet/subnet-id,destination=10.0.0.100,destinationPort=80,protocol=TCP,packetSize=56,probeTags={Name=Probe1} \
    --tags Monitor=Monitor1

Saída:


{
    "monitorArn": "arn:aws:networkmonitor:region111122223333:monitor/Example_NetworkMonitor",
    "monitorName": "Example_NetworkMonitor",
    "state": "PENDING",
    "aggregationPeriod": 60,
    "tags": {
        "Monitor": "Monitor1"
    }
}

Para obter mais informações, consulte Como o Monitor de Rede do Amazon CloudWatch funciona no Guia do usuário do Amazon CloudWatch.

Exemplo 3: criar um monitor de rede com uma sonda usando ICMP e também incluir tags

O exemplo create-monitor a seguir cria um monitor chamado Example_NetworkMonitor com um aggregationPeriod definido como 30 segundos. O comando também cria uma sonda que usa o protocolo ICMP e inclui tags. Como nenhum aggregationPeriod é passado na solicitação, 60 segundos são definidos como padrão. O state do monitor com a sonda permanecerá como PENDING até que o monitor esteja ACTIVE. Isso pode levar alguns minutos, quando então state mudará para ACTIVE, e será possível visualizar as métricas do CloudWatch.


aws networkmonitor create-monitor \
     --monitor-name Example_NetworkMonitor \
     --aggregation-period 30 \
     --probes sourceArn=arn:aws:ec2:region111122223333:subnet/subnet-id,destination=10.0.0.100,protocol=ICMP,packetSize=56,probeTags={Name=Probe1} \
     --tags Monitor=Monitor1

Saída:


{
    "monitorArn": "arn:aws:networkmonitor:region:111122223333:monitor/Example_NetworkMonitor",
    "monitorName": "Example_NetworkMonitor",
    "state": "PENDING",
    "aggregationPeriod": 30,
    "tags": {
        "Monitor": "Monitor1"
    }
}

Para obter mais informações, consulte Como o Monitor de Rede do Amazon CloudWatch funciona no Guia do usuário do Amazon CloudWatch.

Para ver detalhes da API, consulte CreateMonitor na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar create-probe.

AWS CLI

Exemplo 1: criar uma sonda que usa TCP e adicioná-la a um monitor de rede

O exemplo create-probe a seguir cria uma sonda que usa o protocol TCP e adiciona a sonda a um monitor chamado Example_NetworkMonitor. Uma vez criado, o state do monitor com a sonda permanecerá como PENDING até que o monitor esteja ACTIVE. Isso pode levar alguns minutos, quando então state mudará para ACTIVE, e será possível visualizar as métricas do CloudWatch.


aws networkmonitor create-probe \
    --monitor-name Example_NetworkMonitor \
    --probe sourceArn=arn:aws:ec2:region:111122223333:subnet/subnet-id,destination=10.0.0.100,destinationPort=80,protocol=TCP,packetSize=56,tags={Name=Probe1}

Saída:


{
    "probeId": "probe-12345",
    "probeArn": "arn:aws:networkmonitor:region:111122223333:probe/probe-12345",
    "destination": "10.0.0.100",
    "destinationPort": 80,
    "packetSize": 56,
    "addressFamily": "IPV4",
    "vpcId": "vpc-12345",
    "state": "PENDING",
    "createdAt": "2024-03-29T12:41:57.314000-04:00",
    "modifiedAt": "2024-03-29T12:41:57.314000-04:00",
    "tags": {
        "Name": "Probe1"
    }
}

Exemplo 2: criar uma sonda que usa ICMP e adicioná-la a um monitor de rede

O exemplo create-probe a seguir cria uma sonda que usa o protocol ICMP e adiciona a sonda a um monitor chamado Example_NetworkMonitor. Uma vez criado, o state do monitor com a sonda permanecerá como PENDING até que o monitor esteja ACTIVE. Isso pode levar alguns minutos, quando então state mudará para ACTIVE, e será possível visualizar as métricas do CloudWatch.


aws networkmonitor create-probe \
    --monitor-name Example_NetworkMonitor \
    --probe sourceArn=arn:aws:ec2:region:012345678910:subnet/subnet-id,destination=10.0.0.100,protocol=ICMP,packetSize=56,tags={Name=Probe1}

Saída:


{
    "probeId": "probe-12345",
    "probeArn": "arn:aws:networkmonitor:region:111122223333:probe/probe-12345",
    "destination": "10.0.0.100",
    "packetSize": 56,
    "addressFamily": "IPV4",
    "vpcId": "vpc-12345",
    "state": "PENDING",
    "createdAt": "2024-03-29T12:44:02.452000-04:00",
    "modifiedAt": "2024-03-29T12:44:02.452000-04:00",
    "tags": {
        "Name": "Probe1"
    }
}

Para obter mais informações, consulte Como o Monitor de Rede do Amazon CloudWatch funciona no Guia do usuário do Amazon CloudWatch.

Para ver detalhes da API, consulte CreateProbe na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar delete-monitor.

AWS CLI

Para excluir um monitor

O exemplo delete-monitor a seguir exclui um monitor chamado Example_NetworkMonitor.


aws networkmonitor delete-monitor \
    --monitor-name Example_NetworkMonitor

Este comando não produz saída.

Para obter mais informações, consulte Como o Monitor de Rede do Amazon CloudWatch funciona no Guia do usuário do Amazon CloudWatch.

Para ver detalhes da API, consulte DeleteMonitor na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar delete-probe.

AWS CLI

Para excluir uma sonda

O exemplo delete-probe a seguir exclui uma sonda com o ID probe-12345 de um monitor de rede chamado Example_NetworkMonitor.


aws networkmonitor delete-probe \
    --monitor-name Example_NetworkMonitor \
    --probe-id probe-12345

Este comando não produz saída.

Para obter mais informações, consulte Como o Monitor de Rede do Amazon CloudWatch funciona no Guia do usuário do Amazon CloudWatch.

Para ver detalhes da API, consulte DeleteProbe na Referência de comandos AWS CLI.

O código de exemplo a seguir mostra como usar get-monitor.

AWS CLI

Para obter informações sobre o monitor

O exemplo get-monitor a seguir obtém informações sobre o monitor chamado Example_NetworkMonitor.


aws networkmonitor get-monitor \
    --monitor-name Example_NetworkMonitor

Saída:


{
    "monitorArn": "arn:aws:networkmonitor:region:012345678910:monitor/Example_NetworkMonitor",
    "monitorName": "Example_NetworkMonitor",
    "state": "ACTIVE",
    "aggregationPeriod": 60,
    "tags": {},
    "probes": [],
    "createdAt": "2024-04-01T17:58:07.211000-04:00",
    "modifiedAt": "2024-04-01T17:58:07.211000-04:00"
}

Para obter mais informações, consulte Como o Monitor de Rede do Amazon CloudWatch funciona no Guia do usuário do Amazon CloudWatch.

Para ver detalhes da API, consulte GetMonitor na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar get-probe.

AWS CLI

Como visualizar os detalhes da sonda

O exemplo get-probe a seguir retorna detalhes sobre uma sonda associada ao probeID probe-12345, que está associado a um monitor chamado Example_NetworkMonitor.


aws networkmonitor get-probe \
    --monitor-name Example_NetworkMonitor \
    --probe-id probe-12345

Saída:


{
    "probeId": "probe-12345",
    "probeArn": "arn:aws:networkmonitor:region:012345678910:probe/probe-12345",
    "sourceArn": "arn:aws:ec2:region:012345678910:subnet/subnet-12345",
    "destination": "10.0.0.100",
    "destinationPort": 80,
    "protocol": "TCP",
    "packetSize": 56,
    "addressFamily": "IPV4",
    "vpcId": "vpc-12345",
    "state": "ACTIVE",
    "createdAt": "2024-03-29T12:41:57.314000-04:00",
    "modifiedAt": "2024-03-29T12:42:28.610000-04:00",
    "tags": {
        "Name": "Probe1"
    }
}

Para obter mais informações, consulte Como o Monitor de Rede do Amazon CloudWatch funciona no Guia do usuário do Amazon CloudWatch.

Para ver detalhes da API, consulte GetProbe na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar list-monitors.

AWS CLI

Exemplo 1: listar todos os monitores (monitor único)

O exemplo list-monitors a seguir retorna uma lista de apenas um único monitor. O monitor state está ACTIVE e tem um aggregationPeriod de 60 segundos.


aws networkmonitor list-monitors

Saída:


{
    "monitors": [{
            "monitorArn": "arn:aws:networkmonitor:region:012345678910:monitor/Example_NetworkMonitor",
            "monitorName": "Example_NetworkMonitor",
            "state": "ACTIVE",
            "aggregationPeriod": 60,
            "tags": {
                "Monitor": "Monitor1"
            }
        }
    ]
}

Para obter mais informações, consulte Como o Monitor de Rede do Amazon CloudWatch funciona no Guia do usuário do Amazon CloudWatch.

Exemplo 2: listar todos os monitores (vários monitores)

O exemplo list-monitors a seguir retorna uma lista com três monitores. O state de um monitor é ACTIVE, e ele está gerando métricas do CloudWatch. O estado dos outros dois monitores é INACTIVE, e eles não geram métricas do CloudWatch. Os três monitores usam um aggregationPeriod de 60 segundos.


aws networkmonitor list-monitors

Saída:


{
    "monitors": [
        {
            "monitorArn": "arn:aws:networkmonitor:us-east-1:111122223333:monitor/Example_NetworkMonitor",
            "monitorName": "Example_NetworkMonitor",
            "state": "INACTIVE",
            "aggregationPeriod": 60,
            "tags": {}
        },
        {
            "monitorArn": "arn:aws:networkmonitor:us-east-1:111122223333:monitor/Example_NetworkMonitor2",
            "monitorName": "Example_NetworkMonitor2",
            "state": "ACTIVE",
            "aggregationPeriod": 60,
            "tags": {
                "Monitor": "Monitor1"
            }
        },
        {
            "monitorArn": "arn:aws:networkmonitor:us-east-1:111122223333:monitor/TestNetworkMonitor_CLI",
            "monitorName": "TestNetworkMonitor_CLI",
            "state": "INACTIVE",
            "aggregationPeriod": 60,
            "tags": {}
        }
    ]
}

Para obter mais informações, consulte Como o Monitor de Rede do Amazon CloudWatch funciona no Guia do usuário do Amazon CloudWatch.

Para ver detalhes da API, consulte ListMonitors na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar list-tags-for-resource.

AWS CLI

Para listar as tags para um recurso

O exemplo list-tags-for-resource a seguir retorna uma lista das tags do monitor chamado Example_NetworkMonitor.


aws networkmonitor list-tags-for-resource \
    --resource-arn arn:aws:networkmonitor:region:012345678910:monitor/Example_NetworkMonitor

Saída:


{
    "tags": {
        "Environment": "Dev",
        "Application": "PetStore"
    }
}

Para obter mais informações, consulte Como o Monitor de Rede do Amazon CloudWatch funciona no Guia do usuário do Amazon CloudWatch.

Para ver detalhes sobre a API, consulte ListTagsForResource na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar tag-resource.

AWS CLI

Como marcar um recurso

O exemplo tag-resource a seguir marca um monitor chamado Example_NetworkMonitor com as tags Environment=Dev e Application=PetStore.


aws networkmonitor tag-resource \
    --resource-arn arn:aws:networkmonitor:region:012345678910:monitor/Example_NetworkMonitor \
    --tags Environment=Dev,Application=PetStore

Este comando não produz saída.

Para obter mais informações, consulte Como o Monitor de Rede do Amazon CloudWatch funciona no Guia do usuário do Amazon CloudWatch.

Para obter detalhes da API, consulte TagResource na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar untag-resource.

AWS CLI

Como desmarcar um recurso

O exemplo untag-resource a seguir remove um parâmetro tag-keys com o par de chave-valor Environment Application de sua associação com um monitor chamado Example_NetworkMonitor.


aws networkmonitor untag-resource \
    --resource-arn arn:aws:networkmonitor:region:012345678910:monitor/Example_NetworkMonitor \
    --tag-keys Environment Application

Este comando não produz saída.

Para obter mais informações, consulte Como o Monitor de Rede do Amazon CloudWatch funciona no Guia do usuário do Amazon CloudWatch.

Para obter detalhes sobre a API, consulte UntagResource na AWS CLI Command Reference.

O código de exemplo a seguir mostra como usar update-monitor.

AWS CLI

Para atualizar um monitor

O exemplo update-monitor a seguir altera o aggregationPeriod de um monitor de 60 segundos para 30 segundos.


aws networkmonitor update-monitor \
    --monitor-name Example_NetworkMonitor \
    --aggregation-period 30

Saída:


{
    "monitorArn": "arn:aws:networkmonitor:region:012345678910:monitor/Example_NetworkMonitor",
    "monitorName": "Example_NetworkMonitor",
    "state": "PENDING",
    "aggregationPeriod": 30,
    "tags": {
        "Monitor": "Monitor1"
    }
}

Para obter mais informações, consulte Como o Monitor de Rede do Amazon CloudWatch funciona no Guia do usuário do Amazon CloudWatch.

Para ver detalhes da API, consulte UpdateMonitor na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar update-probe.

AWS CLI

Para atualizar uma sonda

O exemplo update-probe a seguir atualiza o endereço IP de destination original de uma sonda e também atualiza o packetSize para 60.


aws networkmonitor update-probe \
    --monitor-name Example_NetworkMonitor \
    --probe-id probe-12345 \
    --destination 10.0.0.150 \
    --packet-size 60

Saída:


{
    "probeId": "probe-12345",
    "probeArn": "arn:aws:networkmonitor:region:012345678910:probe/probe-12345",
    "sourceArn": "arn:aws:ec2:region:012345678910:subnet/subnet-12345",
    "destination": "10.0.0.150",
    "destinationPort": 80,
    "protocol": "TCP",
    "packetSize": 60,
    "addressFamily": "IPV4",
    "vpcId": "vpc-12345",
    "state": "PENDING",
    "createdAt": "2024-03-29T12:41:57.314000-04:00",
    "modifiedAt": "2024-03-29T13:52:23.115000-04:00",
    "tags": {
        "Name": "Probe1"
    }
}

Para obter mais informações, consulte Como o Monitor de Rede do Amazon CloudWatch funciona no Guia do usuário do Amazon CloudWatch.

Para ver detalhes da API, consulte UpdateProbe na Referência de comandos da AWS CLI.

Atenção O Javascript está desativado ou não está disponível no seu navegador.

Para usar a documentação da AWS, o Javascript deve estar ativado. Consulte as páginas de Ajuda do navegador para obter instruções.

Convenções do documento

CloudWatch Logs

CodeArtifact