relaysh/aws-ec2-step-instances-describe

aws-ec2-step-instances-describe

镜像概述和主要用途

该Docker镜像是一个AWS EC2步骤容器，用于列出指定AWS区域中的EC2实例，并将实例信息以数组形式设置为instances输出。支持通过过滤器按特定条件缩小返回的实例范围，便于在自动化工作流或脚本中获取和处理EC2实例信息。

核心功能和特性

• EC2实例列表获取：查询指定AWS区域内的EC2实例，返回完整的实例信息集合
• 结构化输出：将实例信息格式化为JSON数组，包含实例ID、类型、状态、网络信息等详细属性
• 灵活筛选：支持通过多种过滤器条件缩小实例范围，如实例类型、状态、可用区等
• AWS集成：与AWS EC2 API无缝对接，获取实时实例数据

使用场景和适用范围

• AWS资源管理自动化：在CI/CD流程或运维脚本中动态获取EC2实例信息
• 实例监控与审计：定期收集特定状态或类型的EC2实例信息
• 工作流编排：作为自动化工作流中的步骤，为后续操作提供实例数据
• 多环境管理：在跨区域部署中筛选和获取不同环境的EC2实例

使用方法和配置说明

前提条件

• 拥有AWS账户及访问权限（需具备ec2:DescribeInstances权限）
• 已配置AWS凭证（Access Key ID和Secret Access Key）
• 目标AWS区域已启用EC2服务

环境变量配置

过滤器说明

可通过FILTERS环境变量指定筛选条件，常见过滤器包括：

• affinity：实例在专用主机上的亲和性设置（default|host）
• architecture：实例架构（i386|x86_64|arm64）
• availabilityZone：实例所在可用区
• dnsName：实例的公共DNS名称
• blockDeviceMapping.volumeId：EBS卷ID
• instanceId：实例ID
• instanceLifecycle：实例生命周期类型（spot|scheduled）
• instanceType：实例类型（如t2.micro）
• instanceStateName：实例状态（pending|running|shutting-down|terminated|stopping|stopped）
• vpcId：实例所在VPC的ID

完整过滤器列表请参考https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInstances.html%EF%BC%8C%E6%B3%A8%E6%84%8F%E5%9C%A8%E9%85%8D%E7%BD%AE%E6%97%B6%E8%BF%87%E6%BB%A4%E5%99%A8%E5%90%8D%E7%A7%B0%E9%9C%80%E4%BD%BF%E7%94%A8%E9%A9%BC%E5%B3%B0%E5%BC%8F%E5%91%BD%E5%90%8D%E3%80%82

使用示例

基础使用（无过滤器）

bash
docker run -e AWS_ACCESS_KEY_ID="your_access_key" \
           -e AWS_SECRET_ACCESS_KEY="your_secret_key" \
           -e AWS_REGION="us-east-1" \
           docker.xuanyuan.run/aws-ec2-step-instances-describe

使用过滤器筛选运行中的t2.micro实例

bash
docker run -e AWS_ACCESS_KEY_ID="your_access_key" \
           -e AWS_SECRET_ACCESS_KEY="your_secret_key" \
           -e AWS_REGION="us-east-1" \
           -e FILTERS='{"instanceType": "t2.micro", "instanceStateName": "running"}' \
           docker.xuanyuan.run/aws-ec2-step-instances-describe

输出示例

instances输出为包含实例详细信息的JSON数组，示例如下：

json
[
   {
      "AmiLaunchIndex": 0,
      "ImageId": "ami-0323c3dd2da7fb37d",
      "InstanceId": "i-0d7ce1cc8568040ba",
      "InstanceType": "t2.micro",
      "KeyName": "my-keypair1",
      "LaunchTime": "2020-05-18T23:50:14+00:00",
      "Monitoring": {
         "State": "disabled"
      },
      "Placement": {
         "AvailabilityZone": "us-east-1c",
         "Tenancy": "default"
      },
      "PrivateIpAddress": "172.31.50.221",
      "PublicIpAddress": "3.89.89.90",
      "State": {
         "Code": 16,
         "Name": "running"
      },
      "SubnetId": "subnet-b0be609d",
      "VpcId": "vpc-98b2a6ff",
      "Architecture": "x86_64",
      "CpuOptions": {
         "CoreCount": 1,
         "ThreadsPerCore": 1
      }
      // ... 其他实例属性
   }
]