Il existe différentes façons de s'authentifier auprès de Compute Engine selon la manière dont vous accédez à l'API. Pour en savoir plus, consultez la page S'authentifier auprès de Compute Engine.
Se familiariser avec REST
Il existe deux façons d'appeler l'API :
Si vous décidez de ne pas utiliser de bibliothèques clientes, vous devez comprendre les bases de l'architecture REST.
Principes de base de REST
REST est un style d'architecture logicielle qui permet de demander et modifier des données de manière pratique et cohérente.
Le terme REST est l'acronyme de REpresentational State Transfer. Dans le contexte des API Google, il désigne l'architecture utilisant des verbes HTTP pour récupérer et modifier les représentations des données stockées par Google.
Dans un système RESTful, les ressources sont stockées dans un datastore. Un client envoie une requête pour que le serveur exécute une action spécifique (par exemple la création, l'extraction, la mise à jour ou la suppression d'une ressource), et le serveur exécute l'action et envoie une réponse, souvent sous la forme d'une représentation de la ressource spécifiée.
Dans les API RESTful de Google, le client spécifie une action à l'aide d'un verbe HTTP comme POST, GET, PUT ou DELETE. La ressource est désignée par un URI unique au format suivant :
https://www.googleapis.com/apiName/apiVersion/resourcePath?parameters
Étant donné que toutes les ressources d'API possèdent des URI uniques accessibles via HTTP, REST permet la mise en cache des données, et son fonctionnement est optimisé pour l'infrastructure distribuée du Web.
Les définitions de méthode figurant dans la documentation du standard HTTP 1.1 peuvent s'avérer utiles, car elles incluent les spécifications pour GET, POST, PUT, et DELETE.
REST dans l'API Compute Engine
Les opérations de l'API Compute Engine correspondent exactement aux verbes HTTP REST.
L'API Compute Engine utilise le format suivant pour les URI:
https://www.googleapis.com/compute/API_VERSION/RESOURCE_PATH
L'URI contient les valeurs suivantes:
API_VERSION: version de l'API que vous souhaitez utiliser, qui correspond à l'étape de lancement d'une ressource Compute Engine comme suit :
- Pour les ressources dans GA:
v1
- Pour les ressources en version Preview publique:
beta
- Pour les ressources en version Preview privée:
alpha
RESOURCE_PATH: chemin d'accès à la ressource Compute Engine spécifique (par exemple, projects/example-project/aggregated/instances). Pour afficher les ressources disponibles pour chaque version d'API, consultez les documents suivants :
Si vous souhaitez inclure des paramètres de requête, ajoutez-les à l'URI après un point d'interrogation (?):
https://www.googleapis.com/compute/API_VERSION/RESOURCE_PATH?QUERY_PARAMETERS
Dans l'URI, QUERY_PARAMETERS est une liste de paramètres de requête, séparés par des esperluettes (&), par exemple format=json&filter=zone=us-central1-a.
