如何通过名称使用boto3获取指定RDS实例的状态

问题背景 #

你需要获取特定名称的RDS实例（例如d2-pipeline、d4-pipeline）的运行状态（可用/已停止），但不想通过遍历所有RDS实例的方式实现，目前你的代码是这样的：

rds = boto3.client('rds')
response = client.describe_db_instances()
for resp in response['DBInstances']:
    db_instance_id = resp['DBInstanceIdentifier']
    db_instance_status = resp['DBInstanceStatus']

解决方案 #

其实boto3的RDS客户端提供的describe_db_instances方法支持通过DBInstanceIdentifier参数直接指定单个或多个实例名称，这样就能精准查询目标实例的状态，省去遍历所有实例的开销。

1. 查询单个指定实例的状态

如果只需要查询一个实例，可以直接传入实例名称：

import boto3

rds_client = boto3.client('rds')

try:
    response = rds_client.describe_db_instances(
        DBInstanceIdentifier='d2-pipeline'
    )
    instance = response['DBInstances'][0]
    print(f"实例 {instance['DBInstanceIdentifier']} 的状态是: {instance['DBInstanceStatus']}")
except rds_client.exceptions.DBInstanceNotFoundFault:
    print("指定的RDS实例不存在")

2. 查询多个指定实例的状态

如果需要同时查询多个实例，可以传入实例名称的列表（注意：最多支持100个实例）：

import boto3

rds_client = boto3.client('rds')
target_instances = ['d2-pipeline', 'd4-pipeline']

try:
    response = rds_client.describe_db_instances(
        DBInstanceIdentifier=target_instances
    )
    for instance in response['DBInstances']:
        print(f"实例 {instance['DBInstanceIdentifier']} 的状态是: {instance['DBInstanceStatus']}")
except rds_client.exceptions.DBInstanceNotFoundFault as e:
    print(f"部分实例不存在: {e}")

注意事项 #

• 如果传入的多个实例中有不存在的，会抛出DBInstanceNotFoundFault异常，你可以根据异常信息判断哪些实例不存在，或者提前做好实例名称的校验。
• 该方法一次最多支持查询100个实例，如果你的目标实例超过这个数量，需要分批查询。

内容的提问来源于stack exchange，提问作者Margarita Kvaapagarrot