如何通过Python API启动附带启动脚本的GCP Compute Engine VM

之前代码报错的核心原因是属性挂载对象错误，完全不需要退而求其次用子进程调gcloud或者手写REST请求，新版GCP Python Compute SDK原生支持启动脚本配置，是Python环境下的官方推荐方案。

踩坑原因 #

尝试给instance_client赋值metadata属性的写法完全不对：instance_client是负责发起API调用的客户端实例，本身不承载虚拟机的配置参数，元数据属于虚拟机实例的配置属性，需要挂载到构造的实例资源对象上，而非调用客户端上。

正确代码实现 #

基于官方2022版创建实例示例修改，只需要在构造实例对象时加入元数据配置即可：

from google.cloud import compute_v1

# 1. 构造元数据配置
metadata = compute_v1.Metadata()
# 如果需要从本地文件加载启动脚本，提前读取文件内容赋值给value即可
# 效果和gcloud的--metadata-from-file参数完全一致
metadata.items = [
    {
        "key": "startup-script",
        "value": job_script  # 替换为启动脚本的完整文本内容
    }
]

# 2. 构造虚拟机实例对象时传入metadata
instance = compute_v1.Instance(
    name="你的虚拟机名称",
    machine_type=f"zones/{zone}/machineTypes/{machine_type}",
    # 磁盘、网络等其余配置完全照搬官方示例即可
    metadata=metadata
)

# 3. 后续发起创建请求的逻辑和官方示例无差异
instance_client = compute_v1.InstancesClient()
create_operation = instance_client.insert(
    project=project_id,
    zone=zone,
    instance_resource=instance
)

几种实现方案的对比 #

• 原生Python SDK调用：生产环境首选方案，不需要依赖本机安装gcloud CLI，鉴权、重试、错误处理逻辑和其他GCP服务SDK统一，适合集成到正式的运维系统、业务服务中。
• subprocess封装gcloud命令：适合快速编写一次性运维脚本，前提是运行环境已经预装并正确配置gcloud登录态，缺点是跨环境部署兼容性差，子进程的输出解析、异常捕获比原生SDK繁琐。
• 手写POST请求调用REST接口：完全不推荐，SDK已经封装了鉴权签名、重试、错误码解析等通用逻辑，手写请求属于重复造轮子，容易出兼容问题。

补充说明：不管是用SDK还是gcloud命令，传入启动脚本的底层逻辑完全一致，都是把脚本内容放到实例元数据的startup-script键中，由GCE内置的代理服务在虚拟机启动时拉取执行，不存在效果差异。

内容的提问来源于stack exchange，提问作者Max Power