Afficher et gérer les quotas à l'aide de la CLI gcloud alpha

Les sections suivantes contiennent des exemples de commandes gcloud alpha quotas info et gcloud alpha quotas preferences. Ces commandes vous permettent d'afficher et de gérer les ressources QuotaInfo et QuotaPreference.

Vous pouvez utiliser Google Cloud CLI (gcloud CLI) pour obtenir des quotas et des préférences de quota pour certaines API et services Google Cloud.

Limites

Cloud Quotas présente les limites suivantes :

Les ajustements d'augmentation de quota doivent être effectués au niveau du projet et sont soumis à l'approbation de Google Cloud.
Vous pouvez demander des ajustements de diminution de quota pour les quotas au niveau du project-, du folder-, et de l'organisation.
L'API Cloud Quotas n'accepte que les opérations au niveau du projet. Les opérations au niveau du dossier et de l'organisation ne sont pas prises en charge.

Avant de commencer

Avant de commencer, assurez-vous d'installer et d'initialiser la gcloud CLI.

Vous aurez peut-être également besoin de votre valeur QUOTA_ID. Si c'est le cas, consultez les instructions pour trouver votre ID de quota.

Installer et initialiser gcloud CLI

Pour utiliser la gcloud CLI, assurez-vous d'avoir installé et initialisé la dernière version de la gcloud CLI, y compris les commandes alpha. Si vous utilisez Cloud Shell pour interagir avec Google Cloud, Google Cloud CLI est installée automatiquement.

Trouver votre ID de quota

Plusieurs commandes de la gcloud CLI sur cette page font référence à votre ID de quota. Vous pouvez trouver l'ID de quota à l'aide de la console Google Cloud, de gcloud CLI, des bibliothèques clientes ou de l'API REST. Cette section explique comment trouver l'ID de quota à l'aide de la console Google Cloud ou de gcloud CLI.

Console

Accédez à la page Quotas et limites du système :
Accéder à la page Quotas et limites du système
Cliquez sur Filtrer pour filtrer les résultats par service.
Si la colonne Nom de la limite n'est pas visible, cliquez sur l'icône Options d'affichage des colonnes. Sélectionnez Nom de la limite, puis cliquez sur OK.
La colonne Nom de la limite indique l'ID de quota.

gcloud

Pour trouver la valeur de l'ID de quota à l'aide de gcloud CLI, exécutez la commande suivante pour lister les informations de quota pour le service spécifié :

Saisissez la commande gcloud CLI suivante dans une fenêtre de terminal :
```
gcloud alpha quotas info list --service=SERVICE_NAME --project=PROJECT_ID_OR_NUMBER \
--billing-project=BILLING_PROJECT_ID_OR_NUMBER
```
Remplacez les éléments suivants :
- SERVICE_NAME : nom du service avec les quotas que vous souhaitez afficher. Par exemple, le nom du service Compute Engine est compute.googleapis.com.
- PROJECT_ID_OR_NUMBER : ID ou numéro du projet
  
  Pour trouver l'ID de votre projet à l'aide de la console Google Cloud, accédez à la page de Resource Manager :
  Accédez au gestionnaire de ressources
- BILLING_PROJECT_ID_OR_NUMBER : ID ou numéro du projet utilisé pour les quotas et la facturation. L'exécution d'une commande gcloud affecte le quota comme si vous aviez effectué la requête équivalente directement via une API REST ou RPC.
  
  Spécifiez le projet dont vous souhaitez utiliser le quota. Il peut être différent du projet contenant le service pour lequel vous recherchez l'ID de quota.
  
  Si vous avez déjà défini le projet de facturation lors de la configuration de gcloud CLI, cette option est facultative. Sinon, son omission peut entraîner une erreur d'autorisation refusée. Pour en savoir plus, consultez Définir le projet de quota.

La sortie de la commande gcloud alpha quotas info list contient un texte semblable à l'exemple suivant :

...
"quotaInfos": [
    ...
    {
        "name": "projects/PROJECT_NUMBER/locations/global/services/compute.googleapis.com/quotaInfos/CPUS-per-project-region",
        "quotaId": "CPUS-per-project-region",
        "metric": "compute.googleapis.com/cpus",
        "containerType": "PROJECT",
        "dimensions": [
            "region"
        ],
        "dimensionsInfo": [
            {
                "details": {
                    "value": 20
                },
                "applicableLocations": [
                    "us-central1",
                    "us-central2",
                    "us-west1",
                    "us-east1"
                ]
                ...
            }
        ]
    },
    ...
]
...

Recherchez la valeur correspondant à quotaId et utilisez-la lorsque vous spécifiez QUOTA_ID dans les sections suivantes.

Exemples de commandes d'informations sur le quota gcloud

Cette section fournit des exemples qui montrent comment utiliser gcloud alpha quotas info pour afficher les informations sur les quotas d'un service particulier ou d'une organisation.

QuotaInfo est une ressource en lecture seule qui fournit des informations sur les métadonnées et les valeurs de quota d'un quota particulier pour un projet, un dossier ou une organisation spécifique.

Afficher les informations sur le quota d'un service spécifique

Pour afficher les informations sur les quotas d'un service particulier, exécutez la commande suivante :

gcloud alpha quotas info describe QUOTA_ID --service=SERVICE_NAME \
    --project=PROJECT_ID_OR_NUMBER --billing-project=BILLING_PROJECT_ID_OR_NUMBER

Remplacez les éléments suivants :

QUOTA_ID : valeur de l'ID de quota. Pour trouver cette valeur, consultez Trouver votre ID de quota.
SERVICE_NAME : nom du service avec les quotas que vous souhaitez afficher. Par exemple, le nom du service Compute Engine est compute.googleapis.com.
PROJECT_ID_OR_NUMBER : ID ou numéro du projet
BILLING_PROJECT_ID_OR_NUMBER : ID ou numéro du projet utilisé pour les quotas et la facturation. L'exécution d'une commande gcloud affecte le quota comme si vous aviez effectué la requête équivalente directement via une API REST ou RPC.

Spécifiez le projet dont vous souhaitez utiliser le quota. Il peut être différent du projet contenant le service pour lequel vous consultez les informations sur le quota.

Si vous avez déjà défini le projet de facturation lors de la configuration de gcloud CLI, cette option est facultative. Sinon, son omission peut entraîner une erreur d'autorisation refusée. Pour en savoir plus, consultez Définir le projet de quota.

Afficher les informations sur les quotas d'une organisation

Pour afficher les détails des quotas d'un même service pour une organisation, exécutez la commande suivante :

gcloud alpha quotas info list --service=SERVICE_NAME --organization=ORGANIZATION_ID \
    --billing-project=BILLING_PROJECT_ID_OR_NUMBER

Remplacez les éléments suivants :

SERVICE_NAME : nom du service avec les quotas que vous souhaitez afficher. Par exemple, le nom du service Compute Engine est compute.googleapis.com.
ORGANIZATION_ID : ID de votre organisation.
BILLING_PROJECT_ID_OR_NUMBER : ID ou numéro du projet utilisé pour les quotas et la facturation. L'exécution d'une commande gcloud affecte le quota comme si vous aviez effectué la requête équivalente directement via une API REST ou RPC.

Spécifiez le projet dont vous souhaitez utiliser le quota. Il peut être différent du projet contenant le service pour lequel vous consultez les informations sur le quota.

Si vous avez déjà défini le projet de facturation lors de la configuration de gcloud CLI, cette option est facultative. Sinon, son omission peut entraîner une erreur d'autorisation refusée. Pour en savoir plus, consultez Définir le projet de quota.

Exemples de commandes gcloud pour les préférences de quota

Cette section fournit des exemples qui montrent comment utiliser gcloud alpha quotas preferences pour vérifier les préférences de quota existantes et ajuster la valeur du quota.

La ressource QuotaPreference représente vos préférences de quota pour une combinaison de dimension particulière. Une dimension est un attribut qui représente une région ou une zone, ou une dimension propre à un service, telle que gpu_family ou network_id.

Rechercher des préférences existantes

Pour vérifier les préférences existantes, exécutez la commande suivante :

gcloud alpha quotas preferences list --project=PROJECT_ID_OR_NUMBER \
    --billing-project=BILLING_PROJECT_ID_OR_NUMBER

Remplacez les éléments suivants :

PROJECT_ID_OR_NUMBER : ID ou numéro du projet
BILLING_PROJECT_ID_OR_NUMBER : ID ou numéro du projet utilisé pour les quotas et la facturation. L'exécution d'une commande gcloud affecte le quota comme si vous aviez effectué la requête équivalente directement via une API REST ou RPC.

Spécifiez le projet dont vous souhaitez utiliser le quota. Il peut être différent du projet pour lequel vous vérifiez les préférences de quota.

Si vous avez déjà défini le projet de facturation lors de la configuration de gcloud CLI, cette option est facultative. Sinon, son omission peut entraîner une erreur d'autorisation refusée. Pour en savoir plus, consultez Définir le projet de quota.

Rechercher les préférences existantes avec des ajustements de quota en attente

Pour rechercher les préférences existantes avec des ajustements de quota en attente, ajoutez l'option --reconciling-only=true comme indiqué dans la commande suivante :

gcloud alpha quotas preferences list --project=PROJECT_ID_OR_NUMBER --reconciling-only=true \
    --billing-project=BILLING_PROJECT_ID_OR_NUMBER

Remplacez les éléments suivants :

PROJECT_ID_OR_NUMBER : ID ou numéro du projet
BILLING_PROJECT_ID_OR_NUMBER : ID ou numéro du projet utilisé pour les quotas et la facturation. L'exécution d'une commande gcloud affecte le quota comme si vous aviez effectué la requête équivalente directement via une API REST ou RPC.

Spécifiez le projet dont vous souhaitez utiliser le quota. Il peut être différent du projet pour lequel vous vérifiez les préférences de quota.

Si vous avez déjà défini le projet de facturation lors de la configuration de gcloud CLI, cette option est facultative. Sinon, son omission peut entraîner une erreur d'autorisation refusée. Pour en savoir plus, consultez Définir le projet de quota.

Demander une augmentation de quota lorsque vous n'avez pas encore défini de préférence de quota

Pour demander une augmentation de quota pour une région spécifique lorsqu'aucune préférence n'a encore été définie, exécutez la commande suivante :

gcloud alpha quotas preferences create --preferred-value=PREFERRED_VALUE \
    --quota-id=QUOTA_ID --service=SERVICE_NAME  --project=PROJECT_ID_OR_NUMBER \
    --billing-project=BILLING_PROJECT_ID_OR_NUMBER --email=EMAIL --preference-id=PREFERENCE_ID

Remplacez les éléments suivants :

PREFERRED_VALUE : valeur de quota souhaitée
QUOTA_ID : valeur de l'ID de quota. Pour trouver cette valeur, consultez Trouver votre ID de quota.
SERVICE_NAME : nom du service avec les quotas que vous souhaitez afficher. Par exemple, le nom du service Compute Engine est compute.googleapis.com.
PROJECT_ID_OR_NUMBER : ID ou numéro du projet
BILLING_PROJECT_ID_OR_NUMBER : ID ou numéro du projet utilisé pour les quotas et la facturation. L'exécution d'une commande gcloud affecte le quota comme si vous aviez effectué la requête équivalente directement via une API REST ou RPC.

Spécifiez le projet dont vous souhaitez utiliser le quota. Il peut être différent du projet pour lequel vous demandez un ajustement de quota.

Si vous avez déjà défini le projet de facturation lors de la configuration de gcloud CLI, cette option est facultative. Sinon, son omission peut entraîner une erreur d'autorisation refusée. Pour en savoir plus, consultez Définir le projet de quota.
EMAIL : adresse e-mail pouvant être utilisée comme contact, au cas où Google Cloud aurait besoin de plus d'informations pour prendre une décision avant d'accorder un quota supplémentaire
PREFERENCE_ID : ID de préférence facultatif. Si vous ne spécifiez pas d'ID de préférence, l'API génère un identifiant unique universel (UUID) automatiquement.

Demander une augmentation de quota lorsque vous avez défini une préférence de quota

Pour demander une augmentation de quota pour une région spécifique et qu'il existe déjà une préférence, exécutez la commande suivante :

gcloud alpha quotas preferences update PREFERENCE_ID --preferred-value=PREFERRED_VALUE \
    --quota-id=QUOTA_ID --service=SERVICE_NAME --project=PROJECT_ID_OR_NUMBER \
    --email=EMAIL --billing-project=BILLING_PROJECT_ID_OR_NUMBER

Remplacez les éléments suivants :

PREFERENCE_ID : ID de préférence, qui est requis en tant que premier argument lorsque vous utilisez la commande gcloud alpha quotas preferences update.
PREFERRED_VALUE : valeur de quota souhaitée
QUOTA_ID : valeur de l'ID de quota. Pour trouver cette valeur, consultez Trouver votre ID de quota.
SERVICE_NAME : nom du service avec les quotas que vous souhaitez afficher. Par exemple, le nom du service Compute Engine est compute.googleapis.com.
PROJECT_ID_OR_NUMBER : ID ou numéro du projet
EMAIL : adresse e-mail pouvant être utilisée comme contact, au cas où Google Cloud aurait besoin de plus d'informations pour prendre une décision avant d'accorder un quota supplémentaire
BILLING_PROJECT_ID_OR_NUMBER : ID ou numéro du projet utilisé pour les quotas et la facturation. L'exécution d'une commande gcloud affecte le quota comme si vous aviez effectué la requête équivalente directement via une API REST ou RPC.

Spécifiez le projet dont vous souhaitez utiliser le quota. Il peut être différent du projet pour lequel vous demandez un ajustement de quota.

Si vous avez déjà défini le projet de facturation lors de la configuration de gcloud CLI, cette option est facultative. Sinon, son omission peut entraîner une erreur d'autorisation refusée. Pour en savoir plus, consultez Définir le projet de quota.

Demander une augmentation de quota à l'aide d'une dimension

Pour demander un ajustement d'augmentation de quota à l'aide d'une dimension, exécutez la commande suivante :

gcloud alpha quotas preferences create --preferred-value=PREFERRED_VALUE \
    --quota-id=QUOTA_ID --service=SERVICE_NAME --project=PROJECT_ID_OR_NUMBER \
    --dimensions=KEY1=VALUE1,KEY2=VALUE2,... --billing-project=BILLING_PROJECT_ID_OR_NUMBER \
    --email=EMAIL --justification=JUSTIFICATION --preference-id=PREFERENCE_ID

Remplacez les éléments suivants :

PREFERRED_VALUE : valeur de quota souhaitée
QUOTA_ID : valeur de l'ID de quota. Pour trouver cette valeur, consultez Trouver votre ID de quota.
SERVICE_NAME : nom du service avec les quotas que vous souhaitez afficher. Par exemple, le nom du service Compute Engine est compute.googleapis.com.
PROJECT_ID_OR_NUMBER : ID ou numéro du projet
KEY1=VALUE1,KEY2=VALUE2,... : liste facultative qui spécifie votre dimension sous la forme d'une liste de paires clé/valeur séparées par une virgule. Par exemple, votre dimension peut spécifier les valeurs Compute Engine suivantes :
- KEY1=VALUE1 : region=us-east4
- KEY2=VALUE2 : gpu_family=NVIDIA_H100
BILLING_PROJECT_ID_OR_NUMBER : ID ou numéro du projet utilisé pour les quotas et la facturation. L'exécution d'une commande gcloud affecte le quota comme si vous aviez effectué la requête équivalente directement via une API REST ou RPC.

Spécifiez le projet dont vous souhaitez utiliser le quota. Il peut être différent du projet pour lequel vous demandez un ajustement de quota.

Si vous avez déjà défini le projet de facturation lors de la configuration de gcloud CLI, cette option est facultative. Sinon, son omission peut entraîner une erreur d'autorisation refusée. Pour en savoir plus, consultez Définir le projet de quota.
EMAIL : adresse e-mail pouvant être utilisée comme contact, au cas où Google Cloud aurait besoin de plus d'informations pour prendre une décision avant d'accorder un quota supplémentaire
JUSTIFICATION : chaîne facultative expliquant votre requête
PREFERENCE_ID : ID de préférence facultatif. Si vous ne spécifiez pas d'ID de préférence, l'API génère un identifiant unique universel (UUID) automatiquement.

La sortie contient des données spécifiques à votre configuration et ressemble à l'exemple suivant :

{
    "createTime":"CREATE_TIME",
    "dimensions":{
        "gpu_family":"NVIDIA_H100",
        "region":"us-east4"
    },
    "etag":"ETAG_VALUE",
    "name":"projects/12345/locations/global/quotaPreferences/PREFERENCE_ID",
    "quotaConfig":{
        "grantedValue":"0",
        "preferredValue":"128",
        "traceId":"TRACE_ID"
    },
    "quotaId":"GPUS-PER-GPU-FAMILY-per-project-region",
    "reconciling":true,
    "service":"compute.googleapis.com",
    "updateTime":"UPDATE_TIME",
}

Afficher une préférence de quota existante

Pour afficher les détails de la préférence de quota que vous venez de créer, exécutez la commande suivante :

gcloud alpha quotas preferences describe PREFERENCE_ID \
    --project=PROJECT_ID_OR_NUMBER \
    --billing-project=BILLING_PROJECT_ID_OR_NUMBER

Remplacez les éléments suivants :

PREFERENCE_ID : ID de préférence, qui est requis en tant que premier argument lorsque vous utilisez la commande gcloud alpha quotas preferences describe.
PROJECT_ID_OR_NUMBER : ID ou numéro du projet
BILLING_PROJECT_ID_OR_NUMBER : ID ou numéro du projet utilisé pour les quotas et la facturation. L'exécution d'une commande gcloud affecte le quota comme si vous aviez effectué la requête équivalente directement via une API REST ou RPC.

Spécifiez le projet dont vous souhaitez utiliser le quota. Il peut être différent du projet pour lequel vous consultez la préférence de quota.

Si vous avez déjà défini le projet de facturation lors de la configuration de gcloud CLI, cette option est facultative. Sinon, son omission peut entraîner une erreur d'autorisation refusée. Pour en savoir plus, consultez Définir le projet de quota.

La sortie contient des données spécifiques à votre configuration et ressemble à l'exemple suivant :

createTime: 'CREATE_TIME'
dimensions:
  gpu_family: NVIDIA_H100
  region: us-east4
etag: ETAG_VALUE
name: projects/12345/locations/global/quotaPreferences/PREFERENCE_ID
quotaConfig:
  grantedValue: '0'
  preferredValue: '128'
  traceId: TRACE_ID
quotaId: GPUS-PER-GPU-FAMILY-per-project-region
reconciling: true
service: compute.googleapis.com
updateTime: 'UPDATE_TIME'

Autres services avec des commandes de la gcloud CLI liées aux quotas

En plus de gcloud alpha quotas, certains services disposent de leur propre accès en ligne de commande aux informations sur l'utilisation des quotas et des ressources.

Par exemple, Compute Engine vous permet d'accéder aux informations sur les quotas. Pour en savoir plus, consultez les sections Compute Engine suivantes :

Les quotas d'allocation
Présentation de la gcloud CLI compute
Section gcloud CLI compute de la documentation de référence du SDK Google Cloud

Étape suivante

Pour en savoir plus sur les commandes et les options gcloud alpha quotas, consultez la section Quotas de gcloud alpha de la documentation de référence de Google Cloud CLI.

Pour en savoir plus sur la terminologie des quotas, consultez Comprendre les valeurs de quota et les limites du système.