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.39.0</version>
      <type>pom</type>
      <scope>import</scope>
    </dependency>
  </dependencies>
</dependencyManagement>

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

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

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

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

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

이전 버전의 Compute Engine용 자바용 Cloud 클라이언트 라이브러리는 Maven 아티팩트에서 0.120.x 이하 버전으로 제공됩니다. 이 라이브러리의 0.120.x 이전 버전은 이후 버전과 호환되지 않습니다.

자세한 내용은 자바 개발 환경 설정을 참조하세요.

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. gcloud CLI를 설치하고 초기화합니다.

   gcloud CLI를 초기화할 때 애플리케이션에 필요한 리소스에 액세스할 수 있는 권한이 있는 Google Cloud 프로젝트를 지정해야 합니다.

2. 사용자 인증 정보 파일을 만듭니다.

   gcloud auth application-default login

   로그인 화면이 표시됩니다. 로그인 후 사용자 인증 정보는 ADC에 사용하는 로컬 사용자 인증 정보 파일에 저장됩니다.

클라이언트 라이브러리 사용

다음 예시에서는 클라이언트 라이브러리를 사용하여 특정 영역의 인스턴스를 나열하는 방법을 보여줍니다. 더 많은 예시는 클라이언트 라이브러리 사용을 참조하세요.

C#

compute/api/Compute.Samples/ListZoneInstancesAsync.cs

GitHub에서 보기 의견 보내기

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

compute/list_instances.go

GitHub에서 보기 의견 보내기

import (
	"context"
	"fmt"
	"io"

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

// 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

compute/cloud-client/src/main/java/compute/ListInstance.java

GitHub에서 보기 의견 보내기

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

compute/listInstances.js

GitHub에서 보기 의견 보내기

/**
 * 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

compute/instances/src/list_instances.php

GitHub에서 보기 의견 보내기

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

compute/client_library/snippets/instances/list.py

GitHub에서 보기 의견 보내기

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

google-cloud-compute-v1/samples/quickstart.rb

GitHub에서 보기 의견 보내기

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++용 클라이언트 라이브러리와 관련된 추가 리소스에 대한 링크가 포함되어 있습니다.

• API 참조
• 클라이언트 라이브러리 권장사항
• Issue Tracker
• Stack Overflow용 google-compute-engine
• 소스 코드

C#

다음 목록에는 C#용 클라이언트 라이브러리와 관련된 추가 리소스에 대한 링크가 포함되어 있습니다.

• API 참조
• 클라이언트 라이브러리 권장사항
• Issue Tracker
• Stack Overflow용 google-compute-engine
• 소스 코드

Go

다음 목록에는 Go용 클라이언트 라이브러리와 관련된 추가 리소스에 대한 링크가 포함되어 있습니다.

• API 참조
• 클라이언트 라이브러리 권장사항
• Issue Tracker
• Stack Overflow용 google-compute-engine
• 소스 코드

Java

다음 목록에는 자바용 클라이언트 라이브러리와 관련된 추가 리소스에 대한 링크가 포함되어 있습니다.

• API 참조
• 클라이언트 라이브러리 권장사항
• Issue Tracker
• Stack Overflow용 google-compute-engine
• 소스 코드

Node.js

다음 목록에는 Node.js용 클라이언트 라이브러리와 관련된 추가 리소스에 대한 링크가 포함되어 있습니다.

• API 참조
• 클라이언트 라이브러리 권장사항
• Issue Tracker
• Stack Overflow용 google-compute-engine
• 소스 코드

PHP

다음 목록에는 PHP용 클라이언트 라이브러리와 관련된 추가 리소스에 대한 링크가 포함되어 있습니다.

• API 참조
• 클라이언트 라이브러리 권장사항
• Issue Tracker
• Stack Overflow용 google-compute-engine
• 소스 코드

Python

다음 목록에는 Python용 클라이언트 라이브러리와 관련된 추가 리소스에 대한 링크가 포함되어 있습니다.

• API 참조
• 클라이언트 라이브러리 권장사항
• Issue Tracker
• Stack Overflow용 google-compute-engine
• 소스 코드

Ruby

다음 목록에는 Ruby용 클라이언트 라이브러리와 관련된 추가 리소스의 링크가 포함되어 있습니다.

• API 참조
• 클라이언트 라이브러리 권장사항
• Issue Tracker
• Stack Overflow용 google-compute-engine
• 소스 코드

이전 클라이언트 라이브러리

Cloud 클라이언트 라이브러리는 최신 클라이언트 라이브러리 모델을 사용하며 프로그래매틱 방식으로 Cloud API에 액세스하는 데 권장되는 옵션입니다.

Cloud 클라이언트 라이브러리를 사용할 수 없는 경우 다음 Google API 클라이언트 라이브러리를 사용할 수 있습니다.

언어	라이브러리	리소스
Go	Google API Go 클라이언트 라이브러리	문서
자바	Google API 자바 클라이언트 라이브러리	문서
자바스크립트	Google API 자바스크립트 클라이언트 라이브러리	문서
.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는 단일 통합 API를 통해 여러 클라우드 서비스 제공업체와 상호작용하는 데 사용되는 Python 라이브러리입니다.

Apache libcloud API 프로젝트는 2013년 7월부터 Compute Engine에 대한 지원과 업데이트를 받고 왔습니다. 인스턴스, 디스크, 네트워크, 부하 분산기 등 다양한 Compute Engine 기능을 지원합니다. 시작하기 데모에서는 libcloud 및 Compute Engine을 함께 사용하는 방법의 코드 예시를 제공합니다.

• 시작하기
• 블로그 게시물
• GitHub

jclouds

오픈소스 라이브러리인 jclouds를 사용하면 여러 클라우드 제공업체에서 Java 및 Clojure를 사용할 수 있습니다.

jclouds Cloud API는 Compute Engine을 지원하며 가상 머신, 디스크 및 네트워크 같은 리소스를 관리할 수 있게 해줍니다. 버전 1.9부터 Compute Engine이 jclouds 코어로 승급되었습니다.

• 시작하기
• GitHub

fog.io

오픈소스 Ruby 라이브러리인 fog.io를 사용하면 API 하나를 통해 여러 클라우드 서비스와 상호작용할 수 있습니다.

fog.io 클라우드 API는 2013년 5월 버전 1.11.0부터 Compute Engine을 지원해 왔습니다. 디스크, 네트워크, 부하 분산기 등 기타 리소스에 대한 관리 작업과 함께 만들기 및 삭제와 같은 인스턴스 작업을 지원합니다.

• GitHub
• 코드 샘플