Manuels d'intégration › Manuel de référence de l'API de service Web › Objets valides › Objet quota › Méthode put (objet quota)

Méthode put (objet quota)

Description

Définit des informations de quota pour un utilisateur ou un groupe.

Syntaxe

/api/v2/quota/put?principal=a-principal&vdc=nom_contrôleur 

Arguments

vdc

Nom du centre de données virtuel cible

principal

Utilisateur ou groupe pour lequel des informations de quota doivent être définies. Les spécifications principales sont les suivantes :

<name>

Utilisateur ou groupe local

/<name>

Utilisateur ou groupe global.

<scope>:<type>:<name>

Nom complet de principal

où :

• <scope> a la valeur global ou local.
• <type> correspond à group ou user.
• <name> est le nom du groupe ou de l'utilisateur.

description

Chaîne de caractère ASCII imprimable arbitraire. Remplace des caractères comme les espaces par leur représentation hexadécimale (%hh), selon la syntaxe de l'URL.

tags=tag1,tag2,…,tagN

Liste de balises séparée par des virgules, parfois utilisée à des fins de facturation.

parent=group-name

Référence au quota de groupe parent. Les utilisateurs ayant leur groupe parent défini sur leur groupe principal, vous pouvez uniquement définir cet argument pour un groupe.

cpu=value

Limites d'utilisation des ressources pour des processeurs.

mem=value

Limites d'utilisation des ressources pour la mémoire (octets).

bw=value

Limites d'utilisation des ressources pour la bande passante (octets par seconde).

disk=value

Limites d'utilisation des ressources pour de l'espace disque (octets).

warn=percentage

Avertissement pour le seuil de consommation (en tant que pourcentage des ressources totales disponibles), pour le principal considéré.

burst=percentage

Eclatement pour le seuil de consommation des ressources (en tant que pourcentage des ressources totales disponibles), pour le principal considéré.

Type de transaction

Synchrone

Type de requête

GET

Exemples

Pour définir des valeurs de quota pour l'utilisateur local john de la grille mygrid :

Get http://192.168.123.200/api/v2/quota/put?principal=local:user:john&vdc=mygrid&cpu=4&mem=200000000&bw=1000&disk=100000000000

Exemple de sortie

XML

En cas de réussite :

<message></message>
En cas de dépassement du quota :

<opt>
  <error>404.1</error>
  <message>Entité introuvable - Erreur : l'utilisateur Daniel a atteint son quota de bande passante de 100 Mbits/s.</message>
</opt>

JSON

{
   "message" : ""
}

Codes d'erreur HTTP

404

L'entité vdc mygrid est introuvable - Le nom de VDC spécifié n'est pas configuré dans l'application WS_API.

400.7

Valeur value non valide spécifiée pour le paramètre de ressource. La valeur affectée au paramètre d'avertissement ou d'éclatement est hors de portée.

404.1

Entité introuvable. Aucune correspondance de nom de principal n'a été trouvée pour principal.

400.4

Syntaxe de demande incorrecte (URL) : argument requis manquant (principal).