Répertorier les services

Ce document explique comment répertorier les API et les services activés ou disponibles dans un Google Cloud projet, un dossier ou une organisation. La liste des API et services disponibles ou activés peut contenir à la fois des services publics Google Cloud tels que Pub/Sub, et toutes les API et services partagés en privé avec vous, tels que les services créés en utilisant Cloud Endpoints. Pour en savoir plus sur les différences entre les API et les services publics et privés, consultez Services publics et privés.

Pour programmer à l'aide de l'API Service Usage, vous pouvez également utiliser l'une des bibliothèques clientes Service Usage.

Avant de commencer

Pour répertorier les API et les services activés et disponibles, vous avez besoin des éléments suivants :

  • Un Google Cloud projet. Pour savoir comment créer un Google Cloud projet, consultez Créer des projets.
  • Les autorisations de gestion de l'authentification et des accès (IAM) appropriées. Pour en savoir plus sur les exigences IAM pour Service Usage, consultez Contrôle des accès avec IAM.
  • Si vous prévoyez d'utiliser les instructions Google Cloud CLI ou API REST sur cette page, vous devez également installer Google Cloud CLI.

Répertorier les services activés dans une organisation ou un dossier

Pour répertorier les services activés dans une organisation ou un dossier, procédez comme suit :

gcloud

Pour répertorier les API et les services activés pour une organisation ou un dossier, utilisez la gcloud beta services list commande :

gcloud beta services list RESOURCE_TYPE=RESOURCE_ID

Remplacez les éléments suivants :

  • RESOURCE_TYPE: utilisez --organization ou --folder pour répertorier respectivement les services activés pour une organisation ou un dossier.

  • RESOURCE_ID: saisissez l'ID de l'organisation ou du dossier pour lequel vous souhaitez répertorier les services activés.

API REST

Pour répertorier les services activés pour une organisation ou un dossier, appelez la consumerPolicies.get méthode :

curl -H "Authorization: Bearer $(gcloud auth print-access-token)" "https://serviceusage.googleapis.com/v2beta/RESOURCE_TYPE/RESOURCE_ID/consumerPolicies/default?filter=state:ENABLED"

Remplacez les éléments suivants :

  • RESOURCE_TYPE: utilisez organizations ou folders pour répertorier respectivement les services activés pour une organisation ou un dossier.

  • RESOURCE_ID: saisissez l'ID de l'organisation ou du dossier pour lequel vous souhaitez répertorier les services activés.

Si l'opération réussit, le corps de la réponse contient un ConsumerPolicy, qui contient une liste des API activées :

{
  "name": "organizations/organization-name/consumerPolicies/default",
  ...
  "enableRules": [
    {
    "services": [
      "services/apphub.googleapis.com",
      "services/appoptimize.googleapis.com",
      "services/artifactregistry.googleapis.com",
      ...
      ]
    }
  ]
}

Répertorier les services activés dans un projet

Pour répertorier les services activés dans un projet, procédez comme suit :

Console

Pour répertorier les API et les services activés dans un projet :

  1. Dans la Google Cloud console, accédez à la page API et services.

    Accéder à "API et services"

  2. Sélectionnez le Google Cloud projet en effectuant l'une des opérations suivantes :

    • Sélectionnez un projet récent dans la liste disponible.

    • Cliquez sur Sélectionner un projet, recherchez votre projet, puis cliquez sur le nom du projet.

    La page API et services s'ouvre et affiche la liste des API activées dans votre Google Cloud projet.

gcloud

Pour répertorier les API et les services activés dans votre projet actuel, utilisez la gcloud services list commande :

gcloud services list

Le résultat ressemble à ce qui suit :

NAME: analyticshub.googleapis.com
TITLE: Analytics Hub API

NAME: appoptimize.googleapis.com
TITLE: App Optimize API

NAME: artifactregistry.googleapis.com
TITLE: Artifact Registry API

NAME: bigquery.googleapis.com
TITLE: BigQuery API
...

API REST

Pour répertorier les services activés pour votre projet, appelez la services.list méthode avec le state:ENABLED filtre :

curl -H "Authorization: Bearer $(gcloud auth print-access-token)" "https://serviceusage.googleapis.com/v1/projects/PROJECT_ID/services?filter=state:ENABLED"

Remplacez PROJECT_ID par votre Google Cloud ID du projet ou numéro.

Répertorier les services disponibles dans un projet

Pour répertorier les services disponibles dans un projet, procédez comme suit. L'ensemble des services disponibles change rarement et peut être mis en cache pendant de longues périodes.

Console

Pour répertorier les API et les services disponibles dans un projet :

  1. Dans la Google Cloud console, accédez à la page Bibliothèque d'API.

    Accéder à la bibliothèque d'API

  2. Sélectionnez le Google Cloud projet en effectuant l'une des opérations suivantes :

    • Sélectionnez un projet récent dans la liste disponible.

    • Cliquez sur Sélectionner un projet, recherchez votre projet, puis cliquez sur le nom du projet.

    La page Bibliothèque d'API s'ouvre. Vous pouvez rechercher ou parcourir les API disponibles.

gcloud

Pour répertorier les API et les services disponibles dans votre projet actuel, utilisez la commande gcloud services list avec l'indicateur --available :

gcloud services list --available

Les résultats incluent tous les services déjà activés, ainsi que les services disponibles pour activation dans le projet en cours. Le résultat ressemble à ce qui suit :

NAME: places-backend.googleapis.com
TITLE: Google Places API Web Service

NAME: clouderrorreporting.googleapis.com
TITLE: Stackdriver Error Reporting API

NAME: analyticsreporting.googleapis.com
TITLE: Google Analytics Reporting API

NAME: youtube.googleapis.com
TITLE: YouTube Data API v3
...

API REST

Pour répertorier les services disponibles pour votre projet, appelez la services.list méthode :

curl -H "Authorization: Bearer $(gcloud auth print-access-token)" "https://serviceusage.googleapis.com/v1/projects/PROJECT_ID/services"

Remplacez PROJECT_ID par votre Google Cloud ID du projet ou numéro.

Le résultat inclut tous les services publics, tous les services pour lesquels l'utilisateur appelant possède l'autorisation servicemanagement.services.bind et tous les services qui ont déjà été activés sur le projet.

Vous pouvez filtrer les résultats pour exclure les services activés sur le projet en incluant le paramètre de requête ?filter=state:DISABLED dans la requête.

Étape suivante