Wiki Cloud Avenue
< All Topics

API

Aperçu

Deux types d’API sont disponibles :

Toutes ces API sont exposées sur internet et sur le BVPN.

Accès aux API

L’utilisation d’un compte « administrateur de l’organisation » est nécessaire pour accéder aux API. Ce compte peut être :

  • local (créé par un administrateur de l’organisation)
  • fédéré (créé par un référent du contrat dans l’Espace Client Cloud) et fonctionnant avec en SSO.

Documentations en ligne

Les API utilisables sur Cloud Avenue sont listées ci-dessous :

Composant Liens vers la documentation en ligne
API Cloud Director & NSX

https://github.com/ccouzens/vcloud-rest-openapi

https://vdc-download.vmware.com/vmwb-repository/dcr-public/772aa4c5-7e61-4d80-8432-b8e0d821c969/2747ec83-6aef-4560-b1d1-55ed9adc4e73/vcd-openapi-docs.html
API DraaS avec VCDA https://developer.vmware.com/apis/1173/vmware-cloud-director-availability#/ (mauvais lien Error 404)
API Kubernetes API avec CSE https://developer.vmware.com/apis/vmware-cloud-director/latest/cloudapi/1.0.0/tkgClusters/post/
API Cloud Avenue pour les clients Suivre le lien vers la page API Cloud Avenue (mauvais lien)
API vROPS Tenant https://github.com/bakingclouds/vRealize-Operations-Tenant-App/blob/main/TenantApp%20v8.6_swagger.json
API Backup API avec NSS https://backup3.flexible-computing-advanced.orange-business.com/NetBackupSelfServiceNetBackupPanels/Swagger/
API vCenter pour vCoD (si option WLD commandée) https://support.citrix.com/article/CTX214389
API UseItCloud v1.0 https://195.25.22.52/api/v1.0/docs/ (mauvais lien)

Outils recommandés

Postman

Cette application permet de construire et exécuter des requêtes HTTP, et bien plus !

A télécharger ici : https://www.postman.com/downloads/

Ansible

C’est la référence des logiciels d’automatisation basé sur les appels API.

Documentation et téléchargement ici : https://github.com/vmware/ansible-module-vcloud-director/blob/master/docs/index.md

Terraform

Terraform est très utilisé par les développeurs orientés « infra as code« . Terraform fonctionne avec des « provider », qui sont des traducteurs permettant d’interfacer les commandes standard Terraform aux API locales.

Nous avons développé un provider spécifique pour Cloud Avenue, qui fournit de nombreuses fonctionnalités supplémentaires (sauvegardes des VMs, stockage S3, etc.).

La documentation en ligne de notre provider Terraform se trouve ici : https://registry.terraform.io/providers/orange-cloudavenue/cloudavenue/latest/docs

VCD CLI

Voir la fiche pratique sur les API