Esta sección incluye ejemplos de uso de la AWS Command Line Interface con las operaciones de Network Flow Monitor.
Antes de comenzar, asegúrese de iniciar sesión para usar la AWS CLI con la cuenta de AWS que proporciona el ámbito que desea utilizar para supervisor los flujos de red. Para obtener más información sobre el uso de acciones de la API con Network Flow Monitor, consulte la Guía de referencia de la API de Network Flow Monitor.
Temas
Creación de un monitor
Para crear un monitor con la AWS CLI, use el comando create-monitor. En el siguiente ejemplo, se crea un monitor llamado demo en la cuenta 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
Salida:
{
"monitorArn": "arn:aws:networkflowmonitor:us-east-1:111122223333:monitor/demo",
"monitorName": "demo",
"monitorStatus": "ACTIVE",
"tags": {}
}Para obtener más información, consulte Creación de un monitor en Network Flow Monitor.
Consultar detalles de supervisión
Para ver información sobre un monitor con la AWS CLI, utilice el comando get-monitor.
aws networkflowmonitor get-monitor --monitor-name "TestMonitor"
{
"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"
}Creación de un ámbito
En el siguiente ejemplo de create-scope, se crea un ámbito que define el conjunto de recursos para los cuales Network Flow Monitor generará métricas de tráfico de red.
aws networkflowmonitor create-scope \ --targets '[{"targetIdentifier":{"targetId":{"accountId":"111122223333"},"targetType":"ACCOUNT"},"region":"us-east-1"}]'
Salida:
{
"scopeId": "sample-aaaa-bbbb-cccc-11112222333",
"status": "IN_PROGRESS",
"tags": {}
}
Para obtener más información, consulte Componentes y características de Network Flow Monitor.
Eliminación de un monitor
En el siguiente ejemplo de delete-monitor, se elimina un monitor llamado Demo en la cuenta.
aws networkflowmonitor delete-monitor \ --monitor-name Demo
Este comando no genera ninguna salida.
Para obtener más información, consulte Eliminación de un monitor en Network Flow Monitor.
Eliminar un alcance
En el siguiente ejemplo de delete-scope, se elimina el ámbito especificado.
aws networkflowmonitor delete-scope \ --scope-id sample-aaaa-bbbb-cccc-44556677889
Este comando no genera ninguna salida.
Para obtener más información, consulte Componentes y características de Network Flow Monitor.
Cómo obtener información sobre un monitor
En el siguiente ejemplo de get-monitor, se muestra información acerca del monitor denominado demo en la cuenta especificada.
aws networkflowmonitor get-monitor \ --monitor-name Demo
Salida:
{ "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 obtener más información, consulte Componentes y características de Network Flow Monitor.
Cómo recuperar datos sobre consultas específicas
En las siguientes secciones se ofrecen ejemplos de comandos de la CLI para recuperar los estados de las consultas.
get-query-results-workload-insights-top-contributors-data
En el ejemplo de get-query-results-workload-insights-top-contributors-data, se devuelven los datos de la 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
Salida:
{ "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
En el siguiente ejemplo de get-query-results-workload-insights-top-contributors, se devuelven los datos de la 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
Salida:
{ "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
En el siguiente ejemplo de get-query-status-monitor-top-contributors, se muestra el estado actual de la consulta en la cuenta especificada.
aws networkflowmonitor get-query-status-monitor-top-contributors \ --monitor-name Demo \ --query-id sample-dddd-eeee-ffff-44556677889
Salida:
{ "status": "SUCCEEDED" }
get-query-status-workload-insights-top-contributors-data
En el siguiente ejemplo de get-query-status-workload-insights-top-contributors-data, se muestra el estado actual de la consulta en la cuenta 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
Salida:
{ "status": "SUCCEEDED" }
get-query-results-workload-insights-top-contributors
En el siguiente ejemplo de get-query-results-workload-insights-top-contributors, se muestra el estado actual de la consulta en la cuenta especificada.
aws networkflowmonitor get-query-status-workload-insights-top-contributors \ --scope-id sample-aaaa-bbbb-cccc-11112222333 \ --query-id sample-dddd-eeee-ffff-44556677889
Salida:
{ "status": "SUCCEEDED" }
Para obtener más información, consulte Evaluación de los flujos de red con información sobre la carga de trabajo.
Cómo consultar información sobre el ámbito
En el siguiente ejemplo de get-scope, se muestra información sobre un ámbito, como el estado, las etiquetas, el nombre y los detalles del destino.
aws networkflowmonitor get-scope \ --scope-id sample-aaaa-bbbb-cccc-11112222333
Salida:
{ "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 obtener más información, consulte Componentes y características de Network Flow Monitor.
Cómo consultar una lista de los monitores de una cuenta
En el ejemplo de list-monitors, se devuelven todos los monitores de la cuenta especificada.
aws networkflowmonitor list-monitors
Salida:
{ "monitors": [ { "monitorArn": "arn:aws:networkflowmonitor:us-east-1:111122223333:monitor/Demo", "monitorName": "Demo", "monitorStatus": "ACTIVE" } ] }
Para obtener más información, consulte Componentes y características de Network Flow Monitor.
Cómo consultar una lista de los ámbitos de una cuenta
En el siguiente ejemplo de list-scopes, se enumeran todos los ámbitos de la cuenta especificada.
aws networkflowmonitor list-scopes
Salida:
{ "scopes": [ { "scopeId": "sample-aaaa-bbbb-cccc-11112222333", "status": "SUCCEEDED", "scopeArn": "arn:aws:networkflowmonitor:us-east-1:111122223333:scope/sample-aaaa-bbbb-cccc-11112222333" } ] }
Para obtener más información, consulte Componentes y características de Network Flow Monitor.
Cómo consultar la lista de etiquetas de un monitor
En el siguiente ejemplo de list-tags-for-resource, se devuelven todas las etiquetas asociadas al recurso especificado.
aws networkflowmonitor list-tags-for-resource \ --resource-arn arn:aws:networkflowmonitor:us-east-1:111122223333:monitor/Demo
Salida:
{ "tags": { "Value": "Production", "Key": "stack" } }
Para obtener más información, consulte Etiquetado de los recursos de Amazon CloudWatch.
Cómo iniciar y detener consultas
Las siguientes secciones proporcionan ejemplos de comandos de la CLI para iniciar y detener consultas en Network Flow Monitor.
start-query-monitor-top-contributors
En el siguiente ejemplo de start-query-monitor-top-contributors, se inicia la consulta que devuelve un ID de consulta para recuperar los colaboradores principales.
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
Salida:
{ "queryId": "sample-dddd-eeee-ffff-44556677889" }
Para obtener más información, consulte Evaluación de los flujos de red con información sobre la carga de trabajo.
start-query-workload-insights-top-contributors-data
En el siguiente ejemplo de start-query-workload-insights-top-contributors-data, se inicia la consulta que devuelve un ID de consulta para recuperar los colaboradores principales.
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
Salida:
{ "queryId": "sample-dddd-eeee-ffff-44556677889" }
Para obtener más información, consulte Evaluación de los flujos de red con información sobre la carga de trabajo.
start-query-workload-insights-top-contributors
En el siguiente ejemplo de start-query-workload-insights-top-contributors, se inicia la consulta que devuelve un ID de consulta para recuperar los colaboradores principales.
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
Salida:
{ "queryId": "sample-dddd-eeee-ffff-44556677889" }
Para obtener más información, consulte Evaluación de los flujos de red con información sobre la carga de trabajo.
stop-query-monitor-top-contributors
En el siguiente ejemplo de stop-query-monitor-top-contributors, se detiene la consulta en la cuenta especificada.
aws networkflowmonitor stop-query-monitor-top-contributors \ --monitor-name Demo \ --query-id sample-dddd-eeee-ffff-44556677889
Este comando no genera ninguna salida.
Para obtener más información, consulte Evaluación de los flujos de red con información sobre la carga de trabajo.
stop-query-workload-insights-top-contributors-data
El siguiente stop-query-workload-insights-top-contributors-data detiene la consulta en la cuenta 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 no genera ninguna salida.
Para obtener más información, consulte Evaluación de los flujos de red con información sobre la carga de trabajo.
stop-query-workload-insights-top-contributors
En el siguiente ejemplo de stop-query-workload-insights-top-contributors, se detiene la consulta en la cuenta 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 no genera ninguna salida.
Para obtener más información, consulte Evaluación de los flujos de red con información sobre la carga de trabajo.
Cómo etiquetar un monitor
El siguiente tag-resource agrega una etiqueta al monitor en la cuenta especificada.
aws networkflowmonitor tag-resource \ --resource-arn arn:aws:networkflowmonitor:us-east-1:111122223333:monitor/Demo \ --tags Key=stack,Value=Production
Este comando no genera ninguna salida.
Para obtener más información, consulte Etiquetado de los recursos de Amazon CloudWatch.
Cómo eliminar una etiqueta de un monitor
En el siguiente ejemplo de untag-resource, se elimina una etiqueta del monitor en la cuenta especificada.
aws networkflowmonitor untag-resource \ --resource-arn arn:aws:networkflowmonitor:us-east-1:111122223333:monitor/Demo \ --tag-keys stack
Este comando no genera ninguna salida.
Para obtener más información, consulte Etiquetado de los recursos de Amazon CloudWatch.
Actualización de un monitor existente
En el siguiente ejemplo de update-monitor, se actualiza el monitor denominado “Demo” en la cuenta 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"
Salida:
{ "monitorArn": "arn:aws:networkflowmonitor:us-east-1:111122223333:monitor/Demo", "monitorName": "Demo", "monitorStatus": "ACTIVE", "tags": { "Value": "Production", "Key": "stack" } }
Para obtener más información, consulte Componentes y características de Network Flow Monitor.
