Afficher les règles d'emplacement

Ce document explique comment afficher les stratégies d'emplacements. Il explique en particulier comment afficher les stratégies d'emplacement disponibles dans un projet spécifié ou les détails de configuration de l'une de ces stratégies.

Avant de commencer

  • Consultez les restrictions applicables aux stratégies d'emplacement.
  • Si ce n'est pas déjà fait, configurez l'authentification. L'authentification est le processus permettant de valider votre identité pour accéder aux services et aux API Google Cloud. Pour exécuter du code ou des exemples depuis un environnement de développement local, vous pouvez vous authentifier auprès de Compute Engine comme suit :

    Select the tab for how you plan to use the samples on this page:

    gcloud

    1. Install the Google Cloud CLI, then initialize it by running the following command: 

      gcloud init
    2. Set a default region and zone.

      3. REST

      Pour utiliser les exemples d'API REST de cette page dans un environnement de développement local, vous devez utiliser les identifiants que vous fournissez à gcloud CLI.

        Install the Google Cloud CLI, then initialize it by running the following command: 

        gcloud init

      Pour en savoir plus, consultez la section S'authentifier pour utiliser REST dans la documentation sur l'authentification Google Cloud.

Rôles requis

Pour obtenir les autorisations nécessaires pour afficher ou supprimer des stratégies d'emplacement, demandez à votre administrateur de vous accorder le rôle IAM administrateur d'instances Compute (v1) (roles/compute.instanceAdmin.v1) sur le projet. Pour en savoir plus sur l'attribution de rôles, consultez la section Gérer les accès.

Ce rôle prédéfini contient les autorisations requises pour afficher ou supprimer des stratégies d'emplacement. Pour connaître les autorisations exactes requises, développez la section Autorisations requises :

Autorisations requises

Vous devez disposer des autorisations suivantes pour afficher ou supprimer des stratégies d'emplacement :

  • Pour afficher la liste de vos stratégies d'emplacement : compute.resourcePolicies.list sur le projet
  • Pour afficher les détails d'une stratégie d'emplacement : compute.resourcePolicies.get sur le projet

Vous pouvez également obtenir ces autorisations avec des rôles personnalisés ou d'autres rôles prédéfinis.

Afficher les stratégies d'emplacement

Pour afficher les stratégies d'emplacement disponibles dans un projet spécifié, sélectionnez l'une des méthodes suivantes :

Afficher la liste de vos stratégies d'emplacement

Vous pouvez afficher la liste de toutes les stratégies d'emplacement dans un projet spécifié à l'aide de gcloud CLI et de REST.

gcloud

Pour afficher la liste des stratégies d'emplacement, utilisez la commande gcloud compute resource-policies list avec l'option --filter définie sur groupPlacementPolicy:*.

gcloud compute resource-policies list \
    --filter="groupPlacementPolicy:*"

Le résultat ressemble à ce qui suit :

NAME: policy-1
DESCRIPTION:
REGION: https://www.googleapis.com/compute/v1/projects/example-project/regions/us-central1
CREATION_TIMESTAMP: 2023-07-15T02:10:51.958-08:00

NAME: policy-2
DESCRIPTION:
REGION: https://www.googleapis.com/compute/v1/projects/example-project/regions/us-central1
CREATION_TIMESTAMP: 2023-07-15T02:11:16.826-08:00

Pour en savoir plus sur l'utilisation d'expressions de filtre pour affiner la liste des ressources Compute Engine, consultez la commande gcloud topic filters.

REST

Pour afficher la liste des stratégies d'emplacement situées dans une région spécifique, envoyez une requête GET à la méthode resourcePolicies.list. Dans l'URL de la requête, incluez le paramètre de requête filter et définissez-le sur groupPlacementPolicy%3A*.

GET https://compute.googleapis.com/compute/v1/projects/PROJECT_ID/regions/REGION/resourcePolicies?filter=groupPlacementPolicy%3A*

Remplacez les éléments suivants :

  • PROJECT_ID : ID du projet dans lequel vous souhaitez afficher la liste des stratégies d'emplacement.

  • REGION : région dans laquelle se trouvent une ou plusieurs règles d'emplacement.

Le résultat ressemble à ce qui suit :

{
  "kind": "compute#resourcePolicyList",
  "id": "projects/example-project/regions/us-central1/resourcePolicies",
  "items": [
    {
      "kind": "compute#resourcePolicy",
      "id": "637231102400797797",
      "creationTimestamp": "2023-07-28T04:12:11.072-07:00",
      "selfLink": "https://www.googleapis.com/compute/v1/projects/example-project/regions/us-central1/resourcePolicies/policy-1",
      "region": "https://www.googleapis.com/compute/v1/projects/example-project/regions/us-central1",
      "name": "policy-1",
      "groupPlacementPolicy": {
        "collocation": "COLLOCATED"
      },
      "status": "READY"
    },
    {
      "kind": "compute#resourcePolicy",
      "id": "1228789480840827204",
      "creationTimestamp": "2023-07-15T02:10:51.958-08:00",
      "selfLink": "https://www.googleapis.com/compute/v1/projects/example-project/regions/us-central1/resourcePolicies/policy-2",
      "region": "https://www.googleapis.com/compute/v1/projects/example-project/regions/us-central1",
      "name": "policy-2",
      "groupPlacementPolicy": {
        "availabilityDomainCount": 2
      },
      "status": "READY"
    }
  ],
  "selfLink": "https://www.googleapis.com/compute/v1/projects/example-project/regions/us-central1/resourcePolicies",
  "etag": "-L7XCupTQ5V9__TOJ8G5RDcR2cY=/g_xt0udkOM_tU7jSL0z9I2Sivis="
}

Pour plus d'informations sur l'utilisation d'expressions de filtre pour affiner une liste de stratégies de ressources à l'aide de l'encodage d'URL, consultez le paramètre de requête filter

Afficher les détails d'une stratégie d'emplacement

Vous pouvez afficher les détails d'une stratégie d'emplacement dans un projet spécifié à l'aide de gcloud CLI et de REST.

gcloud

Pour afficher les détails d'une stratégie d'emplacement, utilisez la commande gcloud compute resource-policies describe.

gcloud compute resource-policies describe POLICY_NAME \
    --region=REGION

Remplacez les éléments suivants :

  • POLICY_NAME : nom d'une stratégie d'emplacement existante

  • REGION : région où se trouve la stratégie.

Le résultat ressemble à ce qui suit :

creationTimestamp: '2023-07-15T02:10:51.958-08:00'
groupPlacementPolicy:
  availabilityDomainCount: 2
id: '1228789480840827204'
kind: compute#resourcePolicy
name: pp2
region: https://www.googleapis.com/compute/v1/projects/example-project/regions/us-central1
selfLink: https://www.googleapis.com/compute/v1/projects/example-project/regions/us-central1/resourcePolicies/example-policy
status: READY

REST

Pour afficher les détails d'une stratégie d'emplacement, envoyez une requête GET à la méthode resourcePolicies.get.

GET https://compute.googleapis.com/compute/v1/projects/PROJECT_ID/regions/REGION/resourcePolicies/POLICY_NAME

Remplacez les éléments suivants :

  • PROJECT_ID : ID du projet dans lequel se trouve la stratégie d'emplacement dont vous souhaitez afficher les détails.

  • REGION : région où se trouve la stratégie.

  • POLICY_NAME : nom d'une stratégie d'emplacement existante

Le résultat ressemble à ce qui suit :

{
  "kind": "compute#resourcePolicy",
  "id": "637231102400797797",
  "creationTimestamp": "2023-07-28T04:12:11.072-07:00",
  "selfLink": "https://www.googleapis.com/compute/v1/projects/example-project/regions/us-central1/resourcePolicies/example-policy",
  "region": "https://www.googleapis.com/compute/v1/projects/example-project/regions/us-central1",
  "name": "policy-1",
  "groupPlacementPolicy": {
      "availabilityDomainCount": 2
  },
  "status": "READY"
}

Étape suivante