Afficher les règles d'emplacement

Ce document explique comment afficher les stratégies d'emplacement.

L'affichage des stratégies d'emplacement est utile pour afficher toutes les stratégies d'emplacement existantes d'un projet ou pour vérifier les détails de configuration d'une stratégie d'emplacement spécifique.

Avant de commencer

  • 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 Google Cloud services et aux API. Pour exécuter du code ou des exemples depuis un environnement de développement local, vous pouvez vous authentifier auprès de Compute Engine en sélectionnant l'une des options suivantes:

    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 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 votre projet. Pour en savoir plus sur l'attribution de rôles, consultez la page Gérer l'accès aux projets, aux dossiers et aux organisations.

Ce rôle prédéfini contient les autorisations requises pour afficher les 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 les stratégies d'emplacement:

  • Afficher la liste de vos stratégies d'emplacement: compute.resourcePolicies.list on the project
  • Afficher les détails d'une stratégie d'emplacement: compute.resourcePolicies.get on the project

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, sélectionnez l'une des méthodes décrites dans ce document:

Afficher la liste de vos stratégies d'emplacement

Pour afficher la liste de toutes les stratégies d'emplacement de votre projet, sélectionnez l'une des options suivantes:

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: example-compact-policy
DESCRIPTION:
REGION: https://www.googleapis.com/compute/v1/projects/example-project/regions/us-central1
CREATION_TIMESTAMP: 2024-05-09T02:09:24.588-07:00

NAME: example-spread-policy
DESCRIPTION:
REGION: https://www.googleapis.com/compute/v1/projects/example-project/regions/us-central1
CREATION_TIMESTAMP: 2024-05-09T02:08:13.404-07: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": "5587673659722509355",
      "creationTimestamp": "2024-05-09T02:09:24.588-07:00",
      "selfLink": "https://www.googleapis.com/compute/v1/projects/example-project/regions/us-central1/resourcePolicies/example-compact-policy",
      "region": "https://www.googleapis.com/compute/v1/projects/example-project/regions/us-central1",
      "name": "example-compact-policy",
      "groupPlacementPolicy": {
        "collocation": "COLLOCATED"
      },
      "status": "READY"
    },
    {
      "kind": "compute#resourcePolicy",
      "id": "5970772604948130963",
      "creationTimestamp": "2024-05-09T02:08:13.404-07:00",
      "selfLink": "https://www.googleapis.com/compute/v1/projects/example-project/regions/us-central1/resourcePolicies/example-spread-policy",
      "region": "https://www.googleapis.com/compute/v1/projects/example-project/regions/us-central1",
      "name": "example-spread-policy",
      "groupPlacementPolicy": {
        "availabilityDomainCount": 5
      },
      "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

Pour afficher les détails d'une stratégie d'emplacement, sélectionnez l'une des options suivantes:

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 :

  • Si vous consultez les détails d'une stratégie d'emplacement compact:

    creationTimestamp: '2024-05-09T02:09:24.588-07:00'
groupPlacementPolicy:
  collocation: COLLOCATED
id: '5587673659722509355'
kind: compute#resourcePolicy
name: example-compact-policy
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-compact-policy
status: READY

  • Si vous consultez les détails d'une stratégie d'emplacement par répartition:

    creationTimestamp: '2024-05-09T02:08:13.404-07:00'
groupPlacementPolicy:
  availabilityDomainCount: 5
id: '5970772604948130963'
kind: compute#resourcePolicy
name: example-spread-policy
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-spread-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 :

  • Si vous consultez les détails d'une stratégie d'emplacement compact:

    {
  "kind": "compute#resourcePolicy",
  "id": "5587673659722509355",
  "creationTimestamp": "2024-05-09T02:09:24.588-07:00",
  "selfLink": "https://www.googleapis.com/compute/v1/projects/example-project/regions/us-central1/resourcePolicies/example-compact-policy",
  "region": "https://www.googleapis.com/compute/v1/projects/example-project/regions/us-central1",
  "name": "example-compact-policy",
  "groupPlacementPolicy": {
    "collocation": "COLLOCATED"
  },
  "status": "READY"
}

  • Si vous consultez les détails d'une stratégie d'emplacement par répartition:

    {
  "kind": "compute#resourcePolicy",
  "id": "5970772604948130963",
  "creationTimestamp": "2024-05-09T02:08:13.404-07:00",
  "selfLink": "https://www.googleapis.com/compute/v1/projects/example-project/regions/us-central1/resourcePolicies/example-spread-policy",
  "region": "https://www.googleapis.com/compute/v1/projects/example-project/regions/us-central1",
  "name": "example-spread-policy",
  "groupPlacementPolicy": {
    "availabilityDomainCount": 5
  },
  "status": "READY"
}

Étape suivante