を使用した CloudWatch Network Monitoring の例 AWS CLI

次のコード例は、 CloudWatch Network Monitoring AWS Command Line Interface でを使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。

アクションはより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。

各例には、完全なソースコードへのリンクが含まれています。ここでは、コンテキストでコードを設定および実行する方法の手順を確認できます。

トピック

アクション

アクション

次の例は、create-monitor を使用する方法を説明しています。

AWS CLI

例 1: 集約期間を使用してネットワークモニターを作成するには

次のcreate-monitor例では、という名前Example_NetworkMonitorのモニターを作成し、を 30 秒aggregationPeriodに設定します。モニターstateのイニシャルは、関連するプローブINACTIVEがないためです。状態は、プローブが追加されたACTIVE場合にのみに変わります。update-monitor コマンドまたは create-probe コマンドを使用して、このモニターにプローブを追加できます。


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

出力:


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

詳細については、「Amazon CloudWatch ユーザーガイド」の「AmazonWord Network Monitor の仕組み」を参照してください。 CloudWatch

例 2: TCP を使用してプローブを使用してネットワークモニターを作成し、タグを含めるには

次のcreate-monitor例では、という名前のモニターを作成しますExample_NetworkMonitor。コマンドは、ICMPプロトコルを使用し、タグを含む 1 つのプローブも作成します。リクエストで aggregationPeriodが渡されないため、60秒がデフォルトとして設定されます。プローブを含むモニターstateのは、モニターが PENDINGになるまでになりますACTIVE。これには数分かかる場合があります。その時点で、 stateはに変わりACTIVE、 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

出力:


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

詳細については、「Amazon CloudWatch ユーザーガイド」の「AmazonWord Network Monitor の仕組み」を参照してください。 CloudWatch

例 3: ICMP を使用してプローブを使用してネットワークモニターを作成し、タグを含めるには

次のcreate-monitor例では、という名前Example_NetworkMonitorのモニターを 30秒aggregationPeriodで作成します。コマンドは、ICMPプロトコルを使用し、タグを含む 1 つのプローブも作成します。リクエストで aggregationPeriodが渡されないため、60秒がデフォルトとして設定されます。プローブを含むモニターstateのは、モニターが PENDINGになるまでになりますACTIVE。これには数分かかる場合があります。その時点で、 stateはに変わりACTIVE、 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

出力:


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

詳細については、「Amazon CloudWatch ユーザーガイド」の「AmazonWord Network Monitor の仕組み」を参照してください。 CloudWatch

API の詳細については、 AWS CLI コマンドリファレンスの CreateMonitor を参照してください。

次の例は、create-probe を使用する方法を説明しています。

AWS CLI

例 1: TCP を使用してプローブを作成し、ネットワークモニターに追加するには

次のcreate-probe例では、を使用するプローブを作成しTCPprotocol、プローブをという名前のモニターに追加しますExample_NetworkMonitor。作成されると、プローブを含むモニターstateのは、モニターが PENDINGになるまでになりますACTIVE。これには数分かかる場合があります。その時点で状態はに変わりACTIVE、 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}

出力:


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

例 2: ICMP を使用してプローブを使用するプローブを作成し、ネットワークモニターに追加するには

次のcreate-probe例では、を使用するプローブを作成しICMPprotocol、プローブをという名前のモニターに追加しますExample_NetworkMonitor。作成されると、プローブを含むモニターstateのは、モニターが PENDINGになるまでになりますACTIVE。これには数分かかる場合があります。その時点で状態はに変わりACTIVE、 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}

出力:


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

詳細については、「Amazon CloudWatch ユーザーガイド」の「AmazonWord Network Monitor の仕組み」を参照してください。 CloudWatch

API の詳細については、AWS CLI 「コマンドリファレンス」のCreateProbe」を参照してください。

次のコード例は、delete-monitor を使用する方法を示しています。

AWS CLI

モニターを削除するには

次のdelete-monitor例では、という名前のモニターを削除しますExample_NetworkMonitor。


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

このコマンドでは何も出力されません。

詳細については、「Amazon CloudWatch ユーザーガイド」の「AmazonWord Network Monitor の仕組み」を参照してください。 CloudWatch

API の詳細については、AWS CLI 「コマンドリファレンス」のDeleteMonitor」を参照してください。

次の例は、delete-probe を使用する方法を説明しています。

AWS CLI

プローブを削除するには

次のdelete-probe例では、という名前のネットワークモニターprobe-12345から ID を持つプローブを削除しますExample_NetworkMonitor。


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

このコマンドでは何も出力されません。

詳細については、「Amazon CloudWatch ユーザーガイド」の「AmazonWord Network Monitor の仕組み」を参照してください。 CloudWatch

API の詳細については、AWS CLI 「コマンドリファレンス」のDeleteProbe」を参照してください。

次の例は、get-monitor を使用する方法を説明しています。

AWS CLI

モニター情報を取得するには

次のget-monitor例では、という名前のモニターに関する情報を取得しますExample_NetworkMonitor。


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

出力:


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

詳細については、「Amazon CloudWatch ユーザーガイド」の「AmazonWord Network Monitor の仕組み」を参照してください。 CloudWatch

API の詳細については、AWS CLI 「コマンドリファレンス」のGetMonitor」を参照してください。

次のコード例は、get-probe を使用する方法を示しています。

AWS CLI

プローブの詳細を表示するには

次のget-probe例では、という名前のモニターprobeIDprobe-12345に関連付けられているを持つプローブの詳細を返しますExample_NetworkMonitor。


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

出力:


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

詳細については、「Amazon CloudWatch ユーザーガイド」の「AmazonWord Network Monitor の仕組み」を参照してください。 CloudWatch

API の詳細については、AWS CLI 「コマンドリファレンス」のGetProbe」を参照してください。

次の例は、list-monitors を使用する方法を説明しています。

AWS CLI

例 1: すべてのモニターを一覧表示するには (単一モニター）

次のlist-monitors例では、1 つのモニターのみのリストを返します。モニターstateは ACTIVEで、は 60 秒aggregationPeriodです。


aws networkmonitor list-monitors

出力:


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

詳細については、「Amazon CloudWatch ユーザーガイド」の「AmazonWord Network Monitor の仕組み」を参照してください。 CloudWatch

例 2: すべてのモニターを一覧表示するには (複数のモニター）

次のlist-monitors例では、3 つのモニターのリストを返します。1 つのモニターstateのは ACTIVEであり、 CloudWatch メトリクスを生成します。他の 2 つのモニターの状態は INACTIVEであり、 CloudWatch メトリクスを生成しません。3 つのモニターはすべて 60 秒aggregationPeriodのを使用します。


aws networkmonitor list-monitors

出力:


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

詳細については、「Amazon CloudWatch ユーザーガイド」の「AmazonWord Network Monitor の仕組み」を参照してください。 CloudWatch

API の詳細については、 AWS CLI コマンドリファレンスの ListMonitors を参照してください。

次のコード例は、list-tags-for-resource を使用する方法を示しています。

AWS CLI

リソースのタグを一覧表示するには

次のlist-tags-for-resource例では、という名前のモニターのタグのリストを返しますExample_NetworkMonitor。


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

出力:


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

詳細については、「Amazon CloudWatch ユーザーガイド」の「AmazonWord Network Monitor の仕組み」を参照してください。 CloudWatch

API の詳細については、AWS CLI 「コマンドリファレンス」のListTagsForResource」を参照してください。

次のコード例は、tag-resource を使用する方法を示しています。

AWS CLI

リソースにタグを付けるには

次のtag-resource例では、とタグExample_NetworkMonitorでという名前のモニターにApplication=PetStoreタグを付けEnvironment=Devます。


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

このコマンドでは何も出力されません。

詳細については、「Amazon CloudWatch ユーザーガイド」の「AmazonWord Network Monitor の仕組み」を参照してください。 CloudWatch

API の詳細については、AWS CLI 「コマンドリファレンス」のTagResource」を参照してください。

次の例は、untag-resource を使用する方法を説明しています。

AWS CLI

リソースのタグを解除するには

次のuntag-resource例では、という名前のモニターとの関連付けEnvironment Applicationから、のキーと値のペアを持つ tag-keysパラメータを削除しますExample_NetworkMonitor。


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

このコマンドでは何も出力されません。

詳細については、「Amazon CloudWatch ユーザーガイド」の「AmazonWord Network Monitor の仕組み」を参照してください。 CloudWatch

API の詳細については、AWS CLI 「コマンドリファレンス」のUntagResource」を参照してください。

次のコード例は、update-monitor を使用する方法を示しています。

AWS CLI

モニターを更新するには

次のupdate-monitor例では、モニターのを60秒aggregationPeriodから30秒に変更します。


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

出力:


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

詳細については、「Amazon CloudWatch ユーザーガイド」の「AmazonWord Network Monitor の仕組み」を参照してください。 CloudWatch

API の詳細については、AWS CLI 「コマンドリファレンス」のUpdateMonitor」を参照してください。

次のコード例は、update-probe を使用する方法を示しています。

AWS CLI

プローブを更新するには

次のupdate-probe例では、プローブの元の destination IP アドレスを更新し、を packetSizeに更新します60。


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

出力:


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

詳細については、「Amazon CloudWatch ユーザーガイド」の「AmazonWord Network Monitor の仕組み」を参照してください。 CloudWatch

API の詳細については、 AWS CLI コマンドリファレンスの UpdateProbe を参照してください。

ブラウザで JavaScript が無効になっているか、使用できません。

AWS ドキュメントを使用するには、JavaScript を有効にする必要があります。手順については、使用するブラウザのヘルプページを参照してください。

ドキュメントの表記規則

CloudWatch ログ

CodeArtifact