Pré-requisitos

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

Antes de poder começar a programar a sua primeira aplicação cliente, tem de fazer algumas coisas, se ainda não as tiver feito.

Obtenha uma Conta Google

Precisa de uma Conta Google para aceder à API Compute Engine. Se tiver uma conta existente, já tem acesso.

Também pode querer uma Conta Google separada para fins de teste.

Inscreva-se e experimente o Compute Engine

Para começar, pode criar uma instância de VM no Compute Engine através de um dos seguintes guias:

Antes de continuar, é importante familiarizar-se com o Compute Engine. A documentação da API pressupõe que usou o Compute Engine e que está familiarizado com os conceitos de programação Web e os formatos de dados Web.

Saiba mais acerca da autenticação

Existem diferentes formas de se autenticar no Compute Engine, consoante a forma como acede à API. Para mais informações, consulte o artigo Autentique-se no Compute Engine.

Saiba mais sobre a REST

Existem duas formas de invocar a API:

Se decidir não usar bibliotecas de cliente, tem de compreender os princípios básicos da REST.

Noções básicas de REST

REST é um estilo de arquitetura de software que oferece uma abordagem prática e consistente para pedir e modificar dados.

O termo REST é a abreviatura de "Representational State Transfer". No contexto das APIs Google, refere-se à utilização de verbos HTTP para obter e modificar representações de dados armazenados pela Google.

Num sistema RESTful, os recursos são armazenados num repositório de dados; um cliente envia um pedido para que o servidor execute uma ação específica (como criar, obter, atualizar ou eliminar um recurso), e o servidor executa a ação e envia uma resposta, muitas vezes sob a forma de uma representação do recurso especificado.

Nas APIs RESTful da Google, o cliente especifica uma ação através de um verbo HTTP, como POST, GET, PUT ou DELETE. Especifica um recurso através de um URI globalmente exclusivo do seguinte formulário:

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

Uma vez que todos os recursos da API têm URIs acessíveis por HTTP exclusivos, o REST permite o armazenamento em cache de dados e está otimizado para funcionar com a infraestrutura distribuída da Web.

Pode achar as definições de métodos na documentação das normas HTTP 1.1 úteis. Estas incluem especificações para GET, POST, PUT e DELETE.

REST na API Compute Engine

As operações da API Compute Engine são mapeadas diretamente para verbos HTTP 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 quer usar, que corresponde à fase de lançamento de um recurso do Compute Engine da seguinte forma:
    • Para recursos no GA: v1
    • Para recursos na Pré-visualização pública: beta
    • Para recursos na pré-visualização privada: alpha
  • RESOURCE_PATH: o caminho para o recurso específico do Compute Engine, por exemplo, projects/example-project/aggregated/instances. Para ver os recursos disponíveis para cada versão da API, consulte o seguinte:

Se 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 símbolos de "E" comercial (&). Por exemplo, format=json&filter=zone=us-central1-a.

Saiba mais sobre o formato de dados JSON

A API Compute Engine devolve dados no formato JSON.

O JSON (JavaScript Object Notation) é um formato de dados comum e independente do idioma que oferece uma representação de texto simples de estruturas de dados arbitrárias. Para mais informações, consulte json.org.