如果您使用 aws（amazon web services），您可能需要定期与 ec2（弹性计算云）实例进行交互。无论您是管理大量虚拟机还是自动化某些基础设施任务，以编程方式检索 ec2 实例详细信息都可以为您节省大量时间。
在本文中，我们将介绍如何使用 python 和 boto3 sdk 来检索和打印特定 aws 区域中的 ec2 实例的详细信息。 boto3 是 aws 的 python 开发工具包，它提供了易于使用的 api 用于与 aws 服务交互。
先决条件
在我们深入研究代码之前，您需要以下一些东西：
- aws 账户：您需要一个活跃的 aws 账户以及在特定区域运行的 ec2 实例。
- 已配置 aws cli 或 sdk：您应该设置 aws 凭证。您可以使用 aws cli 配置这些凭证，或直接在代码中设置它们（不建议在生产环境中使用）。
- boto3 库：您需要在 python 环境中安装 boto3。如果您还没有安装它，请使用以下命令进行安装：
pip install boto3
代码演练
下面的代码片段演示了如何使用 python 和 boto3 检索和显示有关 us-east-1 区域中 ec2 实例的详细信息。
import boto3
def get_ec2_instances():
# create ec2 client for us-east-1 region
ec2_client = boto3.client('ec2', region_name='us-east-1')
try:
# get all instances
response = ec2_client.describe_instances()
# list to store instance details
instance_details = []
# iterate through reservations and instances
for reservation in response['reservations']:
for instance in reservation['instances']:
# get instance type
instance_type = instance['instancetype']
# get instance name from tags if it exists
instance_name = 'n/a'
if 'tags' in instance:
for tag in instance['tags']:
if tag['key'] == 'name':
instance_name = tag['value']
break
# get instance id
instance_id = instance['instanceid']
# get instance state
instance_state = instance['state']['name']
# add instance details to list
instance_details.append({
'instance id': instance_id,
'name': instance_name,
'type': instance_type,
'state': instance_state
})
# print instance details
if instance_details:
print("\nec2 instances in us-east-1:")
print("-" * 80)
for instance in instance_details:
print(f"instance id: {instance['instance id']}")
print(f"name: {instance['name']}")
print(f"type: {instance['type']}")
print(f"state: {instance['state']}")
print("-" * 80)
else:
print("no ec2 instances found in us-east-1 region")
except exception as e:
print(f"error retrieving ec2 instances: {str(e)}")
if __name__ == "__main__":
get_ec2_instances()
守则解释
- 创建 ec2 客户端：
ec2_client = boto3.client('ec2', region_name='us-east-1')
第一步是创建 boto3 ec2 客户端。此处我们指定区域 us-east-1，但您可以将其更改为运行 ec2 实例的任何 aws 区域。
立即学习“Python免费学习笔记（深入）”；
- 获取 ec2 实例：
response = ec2_client.describe_instances()
describe_instances() 方法检索有关指定区域中所有 ec2 实例的信息。响应包含有关实例的详细信息，包括它们的 id、类型、状态和标签。
-
提取实例详细信息：
返回的响应包含“保留”列表，每个保留都包含“实例”。对于每个实例，我们提取有用的信息：
- 实例id：实例的唯一标识符。
- 名称：实例的名称标签（如果有）。
- 类型：ec2 实例类型（例如 t2.micro、m5.large）。
- 状态：实例的当前状态（例如，正在运行、已停止）。
然后我们将这些详细信息存储在名为 instance_details 的列表中。
- 处理标签：
if 'tags' in instance:
for tag in instance['tags']:
if tag['key'] == 'name':
instance_name = tag['value']
break
ec2 实例可以有标签，包括通常用于识别实例的名称标签。如果名称标签存在，我们提取它的值。如果没有，我们将实例名称设置为“n/a”。
显示结果:
收集所有实例详细信息后，代码以可读格式打印它们。如果没有找到实例，它将打印一条消息来指示。错误处理:
整个过程被包装在一个 try-except 块中，以处理可能发生的任何异常，例如网络问题或权限不足。
运行脚本
要运行该脚本，只需在您的 python 环境中执行即可。如果一切设置正确，您将看到 us-east-1 区域中的 ec2 实例列表，显示它们的 id、名称、类型和状态。
示例输出：
EC2 Instances in us-east-1: -------------------------------------------------------------------------------- Instance ID: i-0123456789abcdef0 Name: MyFirstInstance Type: t2.micro State: running -------------------------------------------------------------------------------- Instance ID: i-0987654321fedcba0 Name: N/A Type: m5.large State: stopped --------------------------------------------------------------------------------
结论
这个简单的脚本是使用 python 和 boto3 与 aws ec2 实例交互的绝佳起点。只需几行代码，您就可以检索有关 ec2 实例的重要信息、自动执行监控任务，甚至可以将此功能集成到更大的基础设施管理工具中。
您可以将此脚本扩展为：
- 根据某些标签或状态过滤实例。
- 以编程方式启动、停止或终止实例。
- 收集其他详细信息，例如公共 ip 地址、安全组等。
boto3 和 python 的强大功能使您能够高效地自动执行各种 aws 任务。
