Pré-requisitos

Este documento explica os pré-requisitos para usar a API Compute Engine.

Antes de começar a programar seu primeiro aplicativo cliente, há algumas coisas que você precisa fazer, se ainda não tiver feito.

Criar uma Conta do Google

Você precisa de uma Conta do Google para acessar a API Compute Engine. Se você já tiver uma conta, já terá acesso.

Para fins de teste, utilize uma Conta do Google separada.

Inscrever-se e testar o Compute Engine

Para começar, crie uma instância de VM no Compute Engine usando um dos seguintes guias:

Antes de continuar, é importante conhecer o Compute Engine. Na documentação da API, presumimos que você já usou o Compute Engine e conhece os conceitos de programação e formatos de dados da Web.

Aprenda sobre autenticação

Há maneiras diferentes de fazer a autenticação no Compute Engine, dependendo de como você acessa a API. Para mais informações, consulte Autenticar no Compute Engine.

Como funciona o REST

Há duas maneiras de invocar a API:

Se você não quer usar as bibliotecas de cliente, precisa entender os fundamentos da REST.

Fundamentos do REST

REST é um estilo de arquitetura de software que fornece uma abordagem conveniente e consistente para solicitar e modificar dados.

O termo REST é a abreviação de "Representational State Transfer (Transferência de Estado Representacional)". No contexto das APIs do Google, ele se refere ao uso de verbos HTTP para recuperar e modificar representações de dados armazenados pelo Google.

Em um sistema RESTful, os recursos são mantidos em um armazenamento de dados. Um cliente envia uma solicitação para que uma ação específica seja executada no servidor, como a criação, recuperação, atualização ou exclusão de um recurso. Essa ação é executada e uma resposta é enviada, geralmente no formato de uma representação do recurso especificado.

Nas APIs RESTful do Google, uma ação é especificada no cliente usando um verbo HTTP como POST, GET, PUT ou DELETE. Um recurso é definido por meio de um URI global exclusivo no seguinte formato:

https://www.googleapis.com/apiName/apiVersion/resourcePath?parameters

Como todos os recursos da API têm URIs exclusivos acessíveis por HTTP, a REST permite o armazenamento em cache dos dados e é otimizada para funcionar na infraestrutura distribuída da Web.

As definições de método (em inglês) encontradas na documentação dos padrões HTTP 1.1 podem ser úteis. Nelas estão incluídas as especificações GET, POST, PUT e DELETE.

REST na API Compute Engine

As operações da API Compute Engine estão mapeadas diretamente nos verbos HTTP do REST.

A API Compute Engine usa o seguinte formato para URIs:

https://www.googleapis.com/compute/API_VERSION/RESOURCE_PATH

O URI contém os seguintes valores:

  • API_VERSION: a versão da API que você quer usar, que corresponde ao estágio de lançamento de um recurso do Compute Engine da seguinte maneira:
    • Para recursos no GA: v1
    • Para recursos no Acesso antecipado: beta
    • Para recursos na visualização particular: alpha
  • RESOURCE_PATH: o caminho para o recurso específico do Compute Engine, por exemplo, projects/example-project/aggregated/instances. Para conferir os recursos disponíveis para cada versão da API, consulte:

Se você quiser incluir parâmetros de consulta, inclua-os no URI após um ponto de interrogação (?):

https://www.googleapis.com/compute/API_VERSION/RESOURCE_PATH?QUERY_PARAMETERS

No URI, QUERY_PARAMETERS é uma lista de parâmetros de consulta, separados por "e comercial" (&), por exemplo, format=json&filter=zone=us-central1-a.

Como funciona o formato de dados JSON

A API Compute Engine retorna dados no formato JSON.

JSON (JavaScript Object Notation) é um formato de dados comum e independente de linguagem que oferece uma representação de texto simples das estruturas de dados arbitrárias. Para mais informações, acesse json.org (em inglês).