使用 AWS CLI 的網路流量監視器範例

下列程式碼範例示範如何使用 AWS Command Line Interface 搭配網路流量監視器來執行動作，並實作常見案例。

Actions 是大型程式的程式碼摘錄，必須在內容中執行。雖然動作會告訴您如何呼叫個別服務函數，但您可以在其相關情境中查看內容中的動作。

每個範例均包含完整原始程式碼的連結，您可在連結中找到如何在內容中設定和執行程式碼的相關指示。

主題

動作

動作

以下程式碼範例顯示如何使用 create-monitor。

AWS CLI

建立監視器

下列 create-monitor 範例在指定的帳戶中建立名為 demo 的監視器。


aws networkflowmonitor create-monitor \
    --monitor-name demo \
    --local-resources type="AWS::EC2::VPC",identifier="arn:aws:ec2:us-east-1:123456789012:vpc/vpc-03ea55eeda25adbb0"  \
    --scope-arn arn:aws:networkflowmonitor:us-east-1:123456789012:scope/e21cda79-30a0-4c12-9299-d8629d76d8cf

輸出：


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

如需詳細資訊，請參閱《Amazon CloudWatch 使用者指南》中的在網路流量監視器中建立監視器。

如需 API 詳細資訊，請參閱《AWS CLI 命令參考》中的 CreateMonitor。

以下程式碼範例顯示如何使用 create-scope。

AWS CLI

建立範圍

下列 create-scope 範例會建立範圍，其中包含一組資源，網路流量監視器會針對這些資源產生網路流量指標。


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

輸出：


{
    "scopeId": "97626f8d-8a21-4b5d-813a-1a0962dd4615",
    "status": "IN_PROGRESS",
    "tags": {}
}

如需詳細資訊，請參閱《Amazon CloudWatch 使用者指南》中的網路流量監視器的元件和功能。

如需 API 詳細資訊，請參閱《AWS CLI 命令參考》中的 CreateScope。

以下程式碼範例顯示如何使用 delete-monitor。

AWS CLI

刪除監視器

下列 delete-monitor 範例會刪除指定帳戶中名為 demo 的監視器。


aws networkflowmonitor delete-monitor \
    --monitor-name demo

此命令不會產生輸出。

如需詳細資訊，請參閱《Amazon CloudWatch 使用者指南》中的在網路流量監視器中刪除監視器。

如需 API 詳細資訊，請參閱《AWS CLI 命令參考》中的 DeleteMonitor。

以下程式碼範例顯示如何使用 delete-scope。

AWS CLI

刪除範圍

下列 delete-scope 範例會刪除指定的範圍。


aws networkflowmonitor delete-scope \
    --scope-id fdc20616-6bb4-4242-a24e-a748e65ca7ac

此命令不會產生輸出。

如需詳細資訊，請參閱《Amazon CloudWatch 使用者指南》中的網路流量監視器的元件和功能。

如需 API 詳細資訊，請參閱《AWS CLI 命令參考》中的 DeleteScope。

以下程式碼範例顯示如何使用 get-monitor。

AWS CLI

擷取監視器相關資訊

下列 get-monitor 範例會顯示指定帳戶中名為 demo 的監視器相關資訊。


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

輸出：


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

如需詳細資訊，請參閱《Amazon CloudWatch 使用者指南》中的網路流量監視器的元件和功能。

如需 API 詳細資訊，請參閱《AWS CLI 命令參考》中的 GetMonitor。

以下程式碼範例顯示如何使用 get-query-results-workload-insights-top-contributors-data。

AWS CLI

擷取工作負載洞見的最佳貢獻因子資料

下列 get-query-results-workload-insights-top-contributors-data 範例會傳回指定查詢的資料。


aws networkflowmonitor get-query-results-workload-insights-top-contributors-data \
    --scope-id e21cda79-30a0-4c12-9299-d8629d76d8cf \
    --query-id cc4f4ab3-3103-33b8-80ff-d6597a0c6cea

輸出：


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

如需詳細資訊，請參閱《Amazon CloudWatch 使用者指南》中的使用工作負載洞見評估網路流程。

如需 API 詳細資訊，請參閱《AWS CLI 命令參考》中的 GetQueryResultsWorkloadInsightsTopContributorsData。

以下程式碼範例顯示如何使用 get-query-results-workload-insights-top-contributors。

AWS CLI

擷取工作負載洞見的最佳貢獻因子

下列 get-query-results-workload-insights-top-contributors 範例會傳回指定查詢的資料。


aws networkflowmonitor get-query-results-workload-insights-top-contributors \
    --scope-id e21cda79-30a0-4c12-9299-d8629d76d8cf \
    --query-id 1fc423d3-b144-37a6-80e6-e2c7d26eea0c

輸出：


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

如需詳細資訊，請參閱《Amazon CloudWatch 使用者指南》中的使用工作負載洞見評估網路流程。

如需 API 詳細資訊，請參閱《AWS CLI 命令參考》中的 GetQueryResultsWorkloadInsightsTopContributors。

以下程式碼範例顯示如何使用 get-query-status-monitor-top-contributors。

AWS CLI

擷取查詢的狀態

下列 get-query-status-monitor-top-contributors 範例會顯示指定帳戶中查詢的目前狀態。


aws networkflowmonitor get-query-status-monitor-top-contributors \
    --monitor-name Demo \
    --query-id 5398eabd-bc40-3f5f-aba3-bcb639d3c7ca

輸出：


{
    "status": "SUCCEEDED"
}

如需詳細資訊，請參閱《Amazon CloudWatch 使用者指南》中的使用工作負載洞見評估網路流程。

如需 API 詳細資訊，請參閱《AWS CLI 命令參考》中的 GetQueryStatusMonitorTopContributors。

以下程式碼範例顯示如何使用 get-query-status-workload-insights-top-contributors-data。

AWS CLI

擷取查詢的狀態

下列 get-query-status-workload-insights-top-contributors-data 範例會顯示指定帳戶中查詢的目前狀態。


aws networkflowmonitor get-query-status-workload-insights-top-contributors-data \
    --scope-id e21cda79-30a0-4c12-9299-d8629d76d8cf \
    --query-id 4333754d-8ae1-3f29-b6b7-c36db2e7f8ac

輸出：


{
    "status": "SUCCEEDED"
}

如需詳細資訊，請參閱《Amazon CloudWatch 使用者指南》中的使用工作負載洞見評估網路流程。

如需 API 詳細資訊，請參閱《AWS CLI 命令參考》中的 GetQueryStatusWorkloadInsightsTopContributorsData。

以下程式碼範例顯示如何使用 get-query-status-workload-insights-top-contributors。

AWS CLI

擷取查詢的狀態

下列 get-query-status-workload-insights-top-contributors 範例會顯示指定帳戶中查詢的目前狀態。


aws networkflowmonitor get-query-status-workload-insights-top-contributors \
    --scope-id e21cda79-30a0-4c12-9299-d8629d76d8cf \
    --query-id f2a87c70-3e5a-362e-8beb-4747d13d8419

輸出：


{
    "status": "SUCCEEDED"
}

如需詳細資訊，請參閱《Amazon CloudWatch 使用者指南》中的使用工作負載洞見評估網路流程。

如需 API 詳細資訊，請參閱《AWS CLI 命令參考》中的 GetQueryStatusWorkloadInsightsTopContributors。

以下程式碼範例顯示如何使用 get-scope。

AWS CLI

擷取範圍相關資訊

下列 get-scope 範例顯示範圍的相關資訊，例如狀態、標籤、名稱和目標詳細資訊。


aws networkflowmonitor get-scope \
    --scope-id e21cda79-30a0-4c12-9299-d8629d76d8cf

輸出：


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

如需詳細資訊，請參閱《Amazon CloudWatch 使用者指南》中的網路流量監視器的元件和功能。

如需 API 詳細資訊，請參閱《AWS CLI 命令參考》中的 GetScope。

以下程式碼範例顯示如何使用 list-monitors。

AWS CLI

擷取監視器清單

下列 list-monitors 範例會傳回指定帳戶中的所有監視器。


aws networkflowmonitor list-monitors

輸出：


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

如需詳細資訊，請參閱《Amazon CloudWatch 使用者指南》中的網路流量監視器的元件和功能。

如需 API 詳細資訊，請參閱《AWS CLI 命令參考》中的 ListMonitors。

以下程式碼範例顯示如何使用 list-scopes。

AWS CLI

擷取範圍清單

下列 list-scopes 範例會列出指定帳戶中的所有範圍。


aws networkflowmonitor list-scopes

輸出：


{
    "scopes": [
        {
            "scopeId": "fdc20616-6bb4-4242-a24e-a748e65ca7ac",
            "status": "SUCCEEDED",
            "scopeArn": "arn:aws:networkflowmonitor:us-east-1:123456789012:scope/fdc20616-6bb4-4242-a24e-a748e65ca7ac"
        }
    ]
}

如需詳細資訊，請參閱《Amazon CloudWatch 使用者指南》中的網路流量監視器的元件和功能。

如需 API 詳細資訊，請參閱《AWS CLI 命令參考》中的 ListScopes。

以下程式碼範例顯示如何使用 list-tags-for-resource。

AWS CLI

列出標籤

下列 list-tags-for-resource 範例會傳回與指定資源相關聯的所有標籤。


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

輸出：


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

如需詳細資訊，請參閱《Amazon CloudWatch 使用者指南》中的標記 Amazon CloudWatch 資源。

如需 API 詳細資訊，請參閱《AWS CLI 命令參考》中的 ListTagsForResource。

以下程式碼範例顯示如何使用 start-query-monitor-top-contributors。

AWS CLI

開始查詢

下列 start-query-monitor-top-contributors 範例會開始查詢，其會傳回查詢 ID 以擷取最佳貢獻因子。


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

輸出：


{
    "queryId": "aecd3a88-0283-35b0-a17d-6e944dc8531d"
}

如需詳細資訊，請參閱《Amazon CloudWatch 使用者指南》中的使用工作負載洞見評估網路流程。

如需 API 詳細資訊，請參閱《AWS CLI 命令參考》中的 StartQueryMonitorTopContributors。

以下程式碼範例顯示如何使用 start-query-workload-insights-top-contributors-data。

AWS CLI

開始查詢

下列 start-query-workload-insights-top-contributors-data 範例會開始查詢，其會傳回查詢 ID 以擷取最佳貢獻因子。


aws networkflowmonitor start-query-workload-insights-top-contributors-data \
    --scope-id e21cda79-30a0-4c12-9299-d8629d76d8cf \
    --start-time 2024-12-09T19:00:00Z \
    --end-time 2024-12-09T19:15:00Z \
    --metric-name DATA_TRANSFERRED \
    --destination-category UNCLASSIFIED

輸出：


{
    "queryId": "cc4f4ab3-3103-33b8-80ff-d6597a0c6cea"
}

如需詳細資訊，請參閱《Amazon CloudWatch 使用者指南》中的使用工作負載洞見評估網路流程。

如需 API 詳細資訊，請參閱《AWS CLI 命令參考》中的 StartQueryWorkloadInsightsTopContributorsData。

以下程式碼範例顯示如何使用 start-query-workload-insights-top-contributors。

AWS CLI

開始查詢

下列 start-query-workload-insights-top-contributors 範例會開始查詢，其會傳回查詢 ID 以擷取最佳貢獻因子。


aws networkflowmonitor start-query-workload-insights-top-contributors \
    --scope-id e21cda79-30a0-4c12-9299-d8629d76d8cf \
    --start-time 2024-12-09T19:00:00Z \
    --end-time 2024-12-09T19:15:00Z \
    --metric-name DATA_TRANSFERRED \
    --destination-category UNCLASSIFIED

輸出：


{
    "queryId": "1fc423d3-b144-37a6-80e6-e2c7d26eea0c"
}

如需詳細資訊，請參閱《Amazon CloudWatch 使用者指南》中的使用工作負載洞見評估網路流程。

如需 API 詳細資訊，請參閱《AWS CLI 命令參考》中的 StartQueryWorkloadInsightsTopContributors。

以下程式碼範例顯示如何使用 stop-query-monitor-top-contributors。

AWS CLI

停止查詢

下列 stop-query-monitor-top-contributors 範例會停止指定帳戶中的查詢。


aws networkflowmonitor stop-query-monitor-top-contributors \
    --monitor-name Demo \
    --query-id aecd3a88-0283-35b0-a17d-6e944dc8531d

此命令不會產生輸出。

如需詳細資訊，請參閱《Amazon CloudWatch 使用者指南》中的使用工作負載洞見評估網路流程。

如需 API 詳細資訊，請參閱《AWS CLI 命令參考》中的 StopQueryMonitorTopContributors。

以下程式碼範例顯示如何使用 stop-query-workload-insights-top-contributors-data。

AWS CLI

停止查詢

下列 stop-query-workload-insights-top-contributors-data 範例會停止指定帳戶中的查詢。


aws networkflowmonitor stop-query-workload-insights-top-contributors-data \
    --scope-id e21cda79-30a0-4c12-9299-d8629d76d8cf \
    --query-id cc4f4ab3-3103-33b8-80ff-d6597a0c6cea

此命令不會產生輸出。

如需詳細資訊，請參閱《Amazon CloudWatch 使用者指南》中的使用工作負載洞見評估網路流程。

如需 API 詳細資訊，請參閱《AWS CLI 命令參考》中的 StopQueryWorkloadInsightsTopContributorsData。

以下程式碼範例顯示如何使用 stop-query-workload-insights-top-contributors。

AWS CLI

停止查詢

下列 stop-query-workload-insights-top-contributors 範例會停止指定帳戶中的查詢。


aws networkflowmonitor stop-query-workload-insights-top-contributors \
    --scope-id e21cda79-30a0-4c12-9299-d8629d76d8cf \
    --query-id 1fc423d3-b144-37a6-80e6-e2c7d26eea0c

此命令不會產生輸出。

如需詳細資訊，請參閱《Amazon CloudWatch 使用者指南》中的使用工作負載洞見評估網路流程。

如需 API 詳細資訊，請參閱《AWS CLI 命令參考》中的 StopQueryWorkloadInsightsTopContributors。

以下程式碼範例顯示如何使用 tag-resource。

AWS CLI

將標籤新增至指定的資源

下列 tag-resource 範例會將標籤新增至指定帳戶中的監視器。


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

此命令不會產生輸出。

如需詳細資訊，請參閱《Amazon CloudWatch 使用者指南》中的標記 Amazon CloudWatch 資源。

如需 API 詳細資訊，請參閱《AWS CLI 命令參考》中的 TagResource。

以下程式碼範例顯示如何使用 untag-resource。

AWS CLI

從指定的資源移除標籤

下列 untag-resource 範例會從指定帳戶中的監視器移除標籤。


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

此命令不會產生輸出。

如需詳細資訊，請參閱《Amazon CloudWatch 使用者指南》中的標記 Amazon CloudWatch 資源。

如需 API 詳細資訊，請參閱《AWS CLI 命令參考》中的 UntagResource。

以下程式碼範例顯示如何使用 update-monitor。

AWS CLI

更新現有的監視器

下列 update-monitor 範例會更新指定帳戶中名為 Demo 的監視器。


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

輸出：


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

如需詳細資訊，請參閱《Amazon CloudWatch 使用者指南》中的網路流量監視器的元件和功能。

如需 API 詳細資訊，請參閱《AWS CLI 命令參考》中的 UpdateMonitor。

您的瀏覽器已停用或無法使用 Javascript。

您必須啟用 Javascript，才能使用 AWS 文件。請參閱您的瀏覽器說明頁以取得說明。

文件慣用形式

Amazon MSK

Network Manager