Requisitos previos

En este documento se explican los requisitos previos para usar la API Compute Engine.

Antes de empezar a programar tu primera aplicación cliente, tienes que llevar a cabo varias tareas (si aún no lo has hecho):

Crear una cuenta de Google

Para acceder a la API Compute Engine, necesitas una cuenta de Google. Si ya tienes una cuenta, ya tienes acceso.

También es recomendable tener otra cuenta de Google distinta con la que puedas hacer pruebas.

Registrarse y probar Compute Engine

Para empezar, puedes crear una instancia de VM en Compute Engine con una de las siguientes guías:

Antes de continuar, es importante que te familiarices con Compute Engine. La documentación de la API parte de la base de que ya has usado Compute Engine y de que tienes ciertos conocimientos sobre programación web y los formatos de datos web.

Información sobre la autenticación

Hay diferentes formas de autenticarte en Compute Engine en función de cómo accedas a la API. Para obtener más información, consulta Autenticarse en Compute Engine.

Información sobre REST

Hay dos formas de invocar la API:

Si prefieres no utilizar las bibliotecas cliente, tendrás que comprender los aspectos básicos de REST.

Conceptos básicos de REST

REST es un tipo de arquitectura de software que proporciona un método cómodo y uniforme para enviar peticiones y modificar datos.

El término REST es la abreviatura en inglés de "Representational State Transfer" (transferencia de estado representacional). En el contexto de las API de Google, hace referencia al uso de verbos HTTP para obtener y modificar representaciones de datos que ha almacenado Google.

En un sistema RESTful (es decir, que utiliza una arquitectura REST), los recursos se guardan en un almacén de datos. El cliente envía una petición para que el servidor realice una acción determinada (como crear, obtener, actualizar o eliminar un recurso) y este, tras llevarla a cabo, envía una respuesta, normalmente como una representación del recurso especificado.

En las API RESTful de Google, el cliente especifica una acción mediante un verbo HTTP como POST, GET, PUT o DELETE. El recurso se especifica globalmente mediante un URI exclusivo con el siguiente formato:

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

Como todos los recursos de la API tienen URI accesibles mediante HTTP, REST permite almacenar los datos en caché y está optimizado para funcionar con la infraestructura distribuida de la Web.

Pueden resultarte útiles las definiciones de métodos de la documentación del estándar HTTP 1.1, ya que incluyen las especificaciones de GET, POST, PUT y DELETE.

REST en la API Compute Engine

Las operaciones de la API de Compute Engine están directamente asociadas a verbos HTTP de REST.

La API de Compute Engine usa el siguiente formato para los URIs:

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

El URI contiene los siguientes valores:

  • API_VERSION: la versión de la API que quieres usar, que corresponde a la fase de lanzamiento de un recurso de Compute Engine, de la siguiente manera:
    • Para acceder a recursos en GA, haz lo siguiente: v1
    • En el caso de los recursos en Vista Previa Pública: beta
    • Para los recursos en vista previa privada: alpha
  • RESOURCE_PATH: la ruta al recurso específico de Compute Engine. Por ejemplo, projects/example-project/aggregated/instances. Para ver los recursos disponibles de cada versión de la API, consulte lo siguiente:

Si quiere incluir parámetros de consulta, añádalos al URI después de un signo de interrogación (?):

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

En el URI, QUERY_PARAMETERS es una lista de parámetros de consulta separados por el signo & (&). Por ejemplo, format=json&filter=zone=us-central1-a.

Información sobre el formato de datos JSON

La API de Compute Engine devuelve datos en formato JSON.

JSON (JavaScript Object Notation) es un formato de datos común e independiente del lenguaje que proporciona una representación de texto sencilla de estructuras de datos arbitrarias. Para obtener más información, consulta json.org.