Visualizar políticas de posicionamento

Este documento descreve como visualizar as políticas de posicionamento.

A visualização de políticas de posicionamento é útil para conferir todas as políticas de posicionamento em um projeto ou verificar os detalhes de configuração de uma política específica.

Antes de começar

  • Configure a autenticação, caso ainda não tenha feito isso. Com isso, você confirma sua identidade para acesso a Google Cloud serviços e APIs do. Para executar código ou exemplos em um ambiente de desenvolvimento local, faça a autenticação no Compute Engine com um destes métodos:

    Selecione a guia para como planeja usar as amostras nesta página:

    gcloud

    1. Instale a Google Cloud CLI. Após a instalação, inicialize a Google Cloud CLI executando o seguinte comando: 

      gcloud init

      Ao usar um provedor de identidade (IdP) externo, primeiro faça login na CLI gcloud com sua identidade federada.

  • Defina uma região e uma zona padrão.

    • REST

    Para usar as amostras da API REST desta página em um ambiente de desenvolvimento local, use as credenciais fornecidas para a CLI gcloud.

      Instale a Google Cloud CLI.

      Ao usar um provedor de identidade (IdP) externo, primeiro faça login na CLI gcloud com sua identidade federada.

    Saiba mais em Autenticar para usar REST na documentação de autenticação do Google Cloud .

Funções exigidas

Para receber as permissões necessárias para visualizar as políticas de posicionamento, peça ao administrador para conceder a você o papel do IAM de Administrador da instância do Compute (v1) (roles/compute.instanceAdmin.v1) no projeto. Para mais informações sobre a concessão de papéis, consulte Gerenciar o acesso a projetos, pastas e organizações.

Esse papel predefinido contém as permissões necessárias para visualizar as políticas de posicionamento. Para conferir as permissões exatas necessárias, expanda a seção Permissões necessárias:

Permissões necessárias

As seguintes permissões são necessárias para conferir as políticas de posicionamento:

  • Para conferir uma lista das políticas de posicionamento: compute.resourcePolicies.list no projeto
  • Para conferir os detalhes de uma política de posicionamento: compute.resourcePolicies.get no projeto

Essas permissões também podem ser concedidas com funções personalizadas ou outros papéis predefinidos.

Conferir suas políticas de posicionamento

Para acessar as políticas de posicionamento disponíveis em um projeto, selecione um dos seguintes métodos descritos neste documento:

Conferir uma lista das suas políticas de posicionamento

Para conferir uma lista de todas as políticas de posicionamento no seu projeto, selecione uma das seguintes opções:

gcloud

Para visualizar uma lista de políticas de posicionamento, use o comando gcloud compute resource-policies list com a flag --filter definida como groupPlacementPolicy:*.

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

O resultado será assim:

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

Para mais informações sobre como usar expressões de filtro para restringir uma lista de recursos do Compute Engine, consulte o comando gcloud topic filters.

REST

Para conferir uma lista de políticas de posicionamento localizadas em uma região específica, faça uma solicitação GET para o método resourcePolicies.list. No URL da solicitação, inclua o parâmetro de consulta filter e defina-o como groupPlacementPolicy%3A*.

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

Substitua:

  • PROJECT_ID: o ID do projeto em que você quer acessar uma lista de políticas de posicionamento.

  • REGION: a região onde uma ou mais políticas de posicionamento estão localizadas.

O resultado será assim:

{
  "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="
}

Para mais informações sobre como usar expressões de filtro para restringir uma lista de políticas de recursos usando codificação de URL, consulte o parâmetro de consulta filter.

Conferir detalhes de uma política de posicionamento

Para conferir os detalhes de uma política de posicionamento, selecione uma das seguintes opções:

gcloud

Para conferir os detalhes de uma política de posicionamento , use o comando gcloud compute resource-policies describe:

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

Substitua:

  • POLICY_NAME: o nome de uma política de posicionamento existente.

  • REGION: a região em que a política de posicionamento está localizada.

O resultado será assim:

  • Se você estiver vendo os detalhes de uma política de posicionamento compacto:

    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

  • Se você estiver vendo os detalhes de uma política de posicionamento distribuído:

    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

Para conferir detalhes de uma política de posicionamento, faça uma solicitação GET ao métodoresourcePolicies.get.

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

Substitua:

  • PROJECT_ID: o ID do projeto em que a política de posicionamento que você quer conferir os detalhes está localizado.

  • REGION: a região em que a política de posicionamento está localizada.

  • POLICY_NAME: o nome de uma política de posicionamento existente.

O resultado será assim:

  • Se você estiver vendo os detalhes de uma política de posicionamento compacto:

    {
  "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"
}

  • Se você estiver vendo os detalhes de uma política de posicionamento distribuído:

    {
  "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"
}

A seguir