Compute Engine 客户端库

本页面介绍如何开始使用 Compute Engine API 的 Cloud 客户端库。通过客户端库，您可以更轻松地使用支持的语言访问Google Cloud API。虽然您可以通过向服务器发出原始请求来直接使用Google Cloud API，但客户端库可实现简化，从而显著减少您需要编写的代码量。

请参阅客户端库说明，详细了解 Cloud 客户端库和旧版 Google API 客户端库。

如需在 Google Cloud 控制台中直接遵循有关此任务的分步指导，请点击操作演示：

操作演示

安装客户端库

C++

请遵循 Quickstart。

C#

安装 NuGet 提供的 Google.Cloud.Compute.V1 软件包。

如需了解详情，请参阅设置 C# 开发环境。

Go

go get cloud.google.com/go/compute/apiv1

如需了解详情，请参阅设置 Go 开发环境。

Java

If you are using Maven, add the following to your pom.xml file. For more information about BOMs, see The Google Cloud Platform Libraries BOM.

<dependencyManagement>
  <dependencies>
    <dependency>
      <groupId>com.google.cloud</groupId>
      <artifactId>libraries-bom</artifactId>
      <version>26.53.0</version>
      <type>pom</type>
      <scope>import</scope>
    </dependency>
  </dependencies>
</dependencyManagement>

<dependencies>
  <dependency>
    <groupId>com.google.cloud</groupId>
    <artifactId>google-cloud-compute</artifactId>
  </dependency>
</dependencies>

If you are using Gradle, add the following to your dependencies:

implementation 'com.google.cloud:google-cloud-compute:1.66.0'

If you are using sbt, add the following to your dependencies:

libraryDependencies += "com.google.cloud" % "google-cloud-compute" % "1.66.0"

适用于 Compute Engine 的 Java 版 Cloud 客户端库的旧版本可用作 Maven 工件中的 0.120.x 版或更早版本。该库的 0.120.x 版及更早版本与更高版本向前不兼容。

如需了解详情，请参阅设置 Java 开发环境。

Node.js

npm install @google-cloud/compute

适用于 Compute Engine 的 Node.js 版 Cloud 客户端库的旧版本可用作 npm 软件包 中的 2.5.x 版或更早版本。该库的 2.5.x 版及更早版本与更高版本向前不兼容。

如需了解详情，请参阅设置 Node.js 开发环境。

PHP

composer require google/cloud-compute

如需了解详情，请参阅在 Google Cloud 上使用 PHP。

Python

pip install --upgrade google-cloud-compute

如需了解详情，请参阅设置 Python 开发环境。

Ruby

gem install google-cloud-compute-v1

如需了解详情，请参阅设置 Ruby 开发环境。

设置身份验证

为了对 Google Cloud API 的调用进行身份验证，客户端库支持应用默认凭据 (ADC)；这些库会在一组指定的位置查找凭据，并使用这些凭据对发送到 API 的请求进行身份验证。借助 ADC，您可以在各种环境（例如本地开发或生产环境）中为您的应用提供凭据，而无需修改应用代码。

对于生产环境，设置 ADC 的方式取决于服务和上下文。如需了解详情，请参阅设置应用默认凭据。

对于本地开发环境，您可以使用与您的 Google 账号关联的凭据设置 ADC：

  1. Install the Google Cloud CLI, then initialize it by running the following command: 

    gcloud init

  2. If you're using a local shell, then create local authentication credentials for your user account: 

    gcloud auth application-default login

    You don't need to do this if you're using Cloud Shell.

    登录屏幕随即出现。在您登录后，您的凭据会存储在 ADC 使用的本地凭据文件中。

使用客户端库

以下示例展示了如何使用客户端库列出特定可用区中的实例。如需查看更多示例，请参阅使用客户端库。

C#


using Google.Cloud.Compute.V1;
using System;
using System.Collections.Generic;
using System.Threading.Tasks;

public class ListZoneInstancesAsyncSample
{
    public async Task<IList<Instance>> ListZoneInstancesAsync(
        // TODO(developer): Set your own default values for these parameters or pass different values when calling this method.
        string projectId = "your-project-id", 
        string zone = "us-central1-a")
    {
        // Initialize client that will be used to send requests. This client only needs to be created
        // once, and can be reused for multiple requests.
        InstancesClient client = await InstancesClient.CreateAsync();
        IList<Instance> allInstances = new List<Instance>();

        // Make the request to list all VM instances in the given zone in the specified project.
        await foreach(var instance in client.ListAsync(projectId, zone))
        {
            // The result is an Instance collection.
            Console.WriteLine($"Instance: {instance.Name}");
            allInstances.Add(instance);
        }

        return allInstances;
    }
}

Go

import (
	"context"
	"fmt"
	"io"

	compute "cloud.google.com/go/compute/apiv1"
	computepb "cloud.google.com/go/compute/apiv1/computepb"
	"google.golang.org/api/iterator"
)

// listInstances prints a list of instances created in given project in given zone.
func listInstances(w io.Writer, projectID, zone string) error {
	// projectID := "your_project_id"
	// zone := "europe-central2-b"
	ctx := context.Background()
	instancesClient, err := compute.NewInstancesRESTClient(ctx)
	if err != nil {
		return fmt.Errorf("NewInstancesRESTClient: %w", err)
	}
	defer instancesClient.Close()

	req := &computepb.ListInstancesRequest{
		Project: projectID,
		Zone:    zone,
	}

	it := instancesClient.List(ctx, req)
	fmt.Fprintf(w, "Instances found in zone %s:\n", zone)
	for {
		instance, err := it.Next()
		if err == iterator.Done {
			break
		}
		if err != nil {
			return err
		}
		fmt.Fprintf(w, "- %s %s\n", instance.GetName(), instance.GetMachineType())
	}
	return nil
}

Java


import com.google.cloud.compute.v1.Instance;
import com.google.cloud.compute.v1.InstancesClient;
import java.io.IOException;

public class ListInstance {

  public static void main(String[] args) throws IOException {
    // TODO(developer): Replace these variables before running the sample
    String project = "your-project-id";
    String zone = "zone-name";
    listInstances(project, zone);
  }

  // List all instances in the given zone in the specified project ID.
  public static void listInstances(String project, String zone) throws IOException {
    // Initialize client that will be used to send requests. This client only needs to be created
    // once, and can be reused for multiple requests. After completing all of your requests, call
    // the `instancesClient.close()` method on the client to 
    // safely clean up any remaining background resources.
    try (InstancesClient instancesClient = InstancesClient.create()) {
      // Set the project and zone to retrieve instances present in the zone.
      System.out.printf("Listing instances from %s in %s:", project, zone);
      for (Instance zoneInstance : instancesClient.list(project, zone).iterateAll()) {
        System.out.println(zoneInstance.getName());
      }
      System.out.println("####### Listing instances complete #######");
    }
  }
}

Node.js

/**
 * TODO(developer): Uncomment and replace these variables before running the sample.
 */
// const projectId = 'YOUR_PROJECT_ID';
// const zone = 'europe-central2-b'

const compute = require('@google-cloud/compute');

// List all instances in the given zone in the specified project.
async function listInstances() {
  const instancesClient = new compute.InstancesClient();

  const [instanceList] = await instancesClient.list({
    project: projectId,
    zone,
  });

  console.log(`Instances found in zone ${zone}:`);

  for (const instance of instanceList) {
    console.log(` - ${instance.name} (${instance.machineType})`);
  }
}

listInstances();

PHP

use Google\Cloud\Compute\V1\Client\InstancesClient;
use Google\Cloud\Compute\V1\ListInstancesRequest;

/**
 * List all instances for a particular Cloud project and zone.
 *
 * @param string $projectId Your Google Cloud project ID.
 * @param string $zone Zone to list instances for (like "us-central1-a").
 *
 * @throws \Google\ApiCore\ApiException if the remote call fails.
 */
function list_instances(string $projectId, string $zone)
{
    // List Compute Engine instances using InstancesClient.
    $instancesClient = new InstancesClient();
    $request = (new ListInstancesRequest())
        ->setProject($projectId)
        ->setZone($zone);
    $instancesList = $instancesClient->list($request);

    printf('Instances for %s (%s)' . PHP_EOL, $projectId, $zone);
    foreach ($instancesList as $instance) {
        printf(' - %s' . PHP_EOL, $instance->getName());
    }
}

Python

from __future__ import annotations

from collections.abc import Iterable

from google.cloud import compute_v1


def list_instances(project_id: str, zone: str) -> Iterable[compute_v1.Instance]:
    """
    List all instances in the given zone in the specified project.

    Args:
        project_id: project ID or project number of the Cloud project you want to use.
        zone: name of the zone you want to use. For example: “us-west3-b”
    Returns:
        An iterable collection of Instance objects.
    """
    instance_client = compute_v1.InstancesClient()
    instance_list = instance_client.list(project=project_id, zone=zone)

    print(f"Instances found in zone {zone}:")
    for instance in instance_list:
        print(f" - {instance.name} ({instance.machine_type})")

    return instance_list

Ruby


require "google/cloud/compute/v1"

# Lists all instances in the given zone in the specified project.
#
# @param [String] project project ID or project number of the Cloud project you want to use.
# @param [String] zone name of the zone you want to use. For example: "us-west3-b"
# @return [Array<::Google::Cloud::Compute::V1::Instance>] Array of instances.
def list_instances project:, zone:
  # Initialize client that will be used to send requests. This client only needs to be created
  # once, and can be reused for multiple requests.
  client = ::Google::Cloud::Compute::V1::Instances::Rest::Client.new

  # Send the request to list all VM instances in the given zone in the specified project.
  instance_list = client.list project: project, zone: zone

  puts "Instances found in zone #{zone}:"
  instances = []
  instance_list.each do |instance|
    puts " - #{instance.name} (#{instance.machine_type})"
    instances << instance
  end
  instances
end

其他资源

C++

以下列表包含与 C++ 版客户端库相关的更多资源的链接：

C#

以下列表包含与 C# 版客户端库相关的更多资源的链接：

Go

以下列表包含与 Go 版客户端库相关的更多资源的链接：

Java

以下列表包含与 Java 版客户端库相关的更多资源的链接：

Node.js

以下列表包含与 Node.js 版客户端库相关的更多资源的链接：

PHP

以下列表包含与 PHP 版客户端库相关的更多资源的链接：

Python

以下列表包含与 Python 版客户端库相关的更多资源的链接：

Ruby

以下列表包含与 Ruby 版客户端库相关的更多资源的链接：

旧版客户端库

Cloud 客户端库使用我们最新的客户端库模型，推荐通过它以编程方式访问 Cloud API。

如果您无法使用 Cloud 客户端库，可以使用以下 Google API 客户端库：

语言 库 资源
Go Google API Go 客户端库 文档
Java Google API Java 客户端库 文档
JavaScript Google API JavaScript 客户端库 文档
.NET Google API .NET 客户端库 文档
Node.js Google API Node.js 客户端库 文档
Objective-C Google API Objective-C 客户端库 文档
PHP Google API PHP 客户端库 文档
Python Google API Python 客户端库 文档
Ruby Google API Ruby 客户端库 文档
Dart Google API Dart 客户端库 文档

第三方 Compute Engine API 客户端库

libcloud

libcloud 是一个 Python 库，用于通过一个统一的 API 与多个云服务提供商进行交互。

自 2013 年 7 月以来，Apache libcloud API 项目获得了对 Compute Engine 的支持和更新。它支持广泛的 Compute Engine 功能，包括实例、磁盘、网络和负载均衡器。使用入门演示提供了一个如何将 libcloud 和 Compute Engine 结合使用的代码示例。

jclouds

jclouds 是一个开源库，可让您跨多个云提供商使用 Java 和 Clojure。

jclouds cloud API 支持 Compute Engine，可让您管理虚拟机、磁盘和网络等资源。从 1.9 版开始，Compute Engine 已提升至 jclouds 核心。

fog.io

fog.io 是一个开源 Ruby 库，可让您通过一个 API 与多个云服务进行交互。

自 2013 年 5 月的 1.11.0 版起，fog.io cloud API 可支持 Compute Engine。它支持创建和删除等实例操作，以及磁盘、网络和负载均衡器等其他资源的管理操作。