Chaves de metadados predefinidas

Cada entrada de metadados é armazenada no servidor de metadados como pares de chave-valor. As chaves de metadados diferenciam maiúsculas de minúsculas. Suas chaves podem ser predefinidas ou personalizadas.

As chaves de metadados predefinidas são chaves de metadados criadas pelo Compute Engine. Quando você cria uma VM, o Compute Engine define automaticamente os valores de metadados de algumas chaves nessa VM, por exemplo, o ID da instância da VM ou o ID do projeto. Para chaves predefinidas em que o Compute Engine não define automaticamente um valor, é possível escolher um conjunto de valores disponíveis dependendo da configuração do sistema. Por exemplo, para ativar o Login do SO em uma VM, defina o valor da chave predefinida enable-oslogin como TRUE para essa VM. Para desativar o Login do SO para essa VM, atualize o valor da chave para FALSE. Só é possível atualizar os valores dessas chaves, mas não as chaves em si.

Este documento apresenta informações sobre as chaves de metadados predefinidas que o Compute Engine fornece nos diretórios de metadados instance/ e project/.

Para informações sobre como os metadados da VM para o Compute Engine são definidos, categorizados e organizados, consulte Sobre os metadados da VM.

Chaves de metadados do projeto predefinidas

As chaves de metadados predefinidas dos metadados do projeto são armazenadas no seguinte diretório:

  • http://metadata.google.internal/computeMetadata/v1/project/

Na tabela a seguir, fornecemos uma lista de chaves de metadados e diretórios que o Compute Engine cria automaticamente no diretório de metadados project/:

Entrada de metadados Descrição
attributes/

Um diretório de valores de metadados personalizados passados para as VMs em seu projeto durante a inicialização ou o encerramento. Esses valores personalizados podem ser atributos do Google Cloud ou valores de metadados criados pelo usuário.

Para ver uma lista de atributos do Google Cloud no nível do projeto que podem ser definidos, consulte Atributos do projeto.

Para mais informações sobre como definir metadados, consulte Definir metadados personalizados.
numeric-project-id O ID numérico do projeto (número do projeto) da instância, que é diferente do nome do projeto, visível no Console do Google Cloud. Esse valor é diferente do valor de entrada de metadados project-id.
project-id O ID do projeto.

Chaves de metadados do atributo do projeto predefinido

As chaves de metadados predefinidas para atributos do projeto são armazenadas no seguinte diretório:

  • http://metadata.google.internal/computeMetadata/v1/project/attributes/

A tabela a seguir fornece uma lista de chaves de metadados que o Compute Engine cria automaticamente no diretório de metadados project/attributes/:

Entrada de metadados Descrição
disable-legacy-endpoints

Desativa os endpoints legados do servidor de metadados de todas as instâncias no projeto.

Os endpoints legados estão obsoletos, sempre defina disable-legacy-endpoints=TRUE.

enable-guest-attributes

Define os atributos de convidado do projeto.

Os atributos de convidado são valores de metadados de instância de VM personalizados que podem ser usados para publicar notificações de status pouco frequentes, dados de baixo volume ou dados de baixa frequência. Esses valores são úteis para indicar quando os scripts de inicialização foram concluídos ou para fornecer outras notificações de status infrequentes para outros aplicativos.

Para mais informações sobre os atributos de convidado, consulte Definir e consultar atributos de convidado.

enable-os-inventory

Ativa ou desativa o inventário do SO para o projeto.

Coleta e armazena as informações do SO. Isso inclui informações como nome do host, versão do kernel, arquitetura e detalhes dos pacotes instalados.

Para mais informações sobre o inventário do SO, consulte Visualizar detalhes do sistema operacional.

enable-oslogin

Ativa ou desativa o gerenciamento de chave SSH no seu projeto.

Para mais informações sobre o Login do SO, consulte Configurar o Login do SO.

enable-windows-ssh

Ativa ou desativa o SSH para VMs do Windows.

Para mais informações, consulte Conectar a VMs do Windows usando SSH.

google-compute-default-region Se definido, armazena a região padrão usada pelo projeto.

Para mais informações sobre como definir regiões padrão, consulte Região e zona padrão.

google-compute-default-zone Se definido, armazena a zona padrão usada pelo projeto.

Para mais informações sobre como definir zonas padrão, consulte Região e zona padrão.

ssh-keys

Se você estiver gerenciando chaves SSH usando metadados, esse atributo permitirá que você configure chaves SSH públicas que se conectam a VMs neste projeto. Se houver várias chaves SSH, cada uma será separada por um caractere de nova linha (\n). O valor do atributo ssh-keys é uma string.

Exemplo: "user1:ssh-rsa mypublickey user1@host.com\nuser2:ssh-rsa mypublickey user2@host.com"

As chaves SSH gerenciadas pelo Login do SO não são visíveis nos metadados.

sshKeys Obsoleto: use ssh-keys.
vmdnssetting

Ative o DNS por zona e o DNS global para as VMs no seu projeto.

Para mais informações sobre como usar nomes DNS zonais para suas VMs, consulte Usar DNS zonal para seu tipo de DNS interno.

Chaves de metadados de instância predefinidas

As chaves de metadados predefinidas dos metadados da instância são armazenadas no seguinte diretório:

  • http://metadata.google.internal/computeMetadata/v1/instance/

Na tabela a seguir, fornecemos uma lista de chaves de metadados e diretórios que o Compute Engine cria automaticamente no diretório de metadados instance/:

Entrada de metadados Descrição
attributes/

Um diretório de valores de metadados personalizados passados para a VM durante a inicialização ou o encerramento. Esses valores personalizados podem ser atributos do Google Cloud ou valores de metadados criados pelo usuário.

Para ver uma lista de atributos do Google Cloud no nível da instância que podem ser definidos, consulte Atributos de instância.

Saiba mais sobre a configuração de metadados personalizados em Configurar metadados personalizados.
cpu-platform

Plataforma de CPU da VM.

Para informações sobre plataformas de CPU, consulte Plataformas de CPU.
description A descrição de texto livre de uma instância que é atribuída usando a sinalização --description usando a CLI do Google Cloud ou a API.
disks/

Um diretório de discos anexados à VM. Para cada métrica, estão disponíveis as seguintes informações:

  • device-name
  • index
  • interface
  • mode
  • type

Para mais informações sobre discos, consulte Opções de armazenamento.

guest-attributes/

Define os atributos de convidado da VM. Esses valores personalizados podem ser atributos do Google Cloud ou valores de metadados criados pelo usuário.

Para ver uma lista de atributos do Google Cloud no nível da instância que podem ser definidos, consulte Atributos de instância.

Para mais informações sobre os atributos de convidado, consulte Definir e consultar atributos de convidado.

hostname O nome do host da VM.
id O ID da VM. Este é um ID numérico exclusivo, gerado pelo Compute Engine. Isso é útil para identificar VMs se você não usa nomes de VM.
image A imagem do sistema operacional usada pela VM. Esse valor tem o seguinte formato: projects/IMAGE_PROJECT/global/images/IMAGE_NAME
legacy-endpoint-access/ Armazena a lista de endpoints legados. Os valores são 0.1 e v1beta1.
licenses/ Uma lista de IDs de código de licença usados para anexar as licenças a imagens, snapshots e discos.
machine-type O tipo de máquina dessa VM. Esse valor tem o seguinte formato: projects/PROJECT_NUM/machineTypes/MACHINE_TYPE
maintenance-event Indica se um evento de manutenção está afetando esta VM. Para mais informações, consulte Migração em tempo real.
name O nome da VM.
network-interfaces/

Um diretório das interfaces de rede. As informações a seguir estão disponíveis para cada interface de rede:

  • access-configs/

    • external-ip
    • type
  • dns-servers
  • forwarded-ips/
  • gateway
  • ip
  • ip-aliases/
  • mac
  • mtu
  • network
  • subnetmask
  • target-instance-ips

Para mais informações sobre interfaces de rede, consulte Visão geral sobre várias interfaces de rede.

preempted

Um valor booleano que indica se uma VM está prestes a ser interrompida.
scheduling/

Define as opções de programação da VM.

Os valores de metadados de programação incluem o seguinte:

  • on-host-maintenance: indica se a VM termina ou migra em tempo real durante a manutenção do host.
  • automatic-restart: se esse valor for TRUE, a VM será reiniciada automaticamente depois de um evento de manutenção ou falha.
  • preemptible: se o valor for TRUE, significa que a VM é preemptiva. Esse valor é definido na criação de uma VM e não pode ser alterado.

Para mais informações sobre as opções de programação, consulte Configurar políticas de disponibilidade de instâncias.

service-accounts/

Um diretório das contas de serviço associadas à VM. As seguintes informações estão disponíveis para cada conta de serviço:

  • aliases
  • email: o endereço de e-mail da conta de serviço padrão.
  • identity: um JSON Web Token, exclusivo da instância. É necessário incluir o parâmetro audience na solicitação do valor de metadados da VM. Por exemplo, ?audience=http://www.example.com.

    Para informações sobre como solicitar e verificar os tokens de identidade da instância, consulte Verificar a identidade da VM.

  • scopes: os escopos de acesso atribuídos à conta de serviço.
  • token: O token de acesso OAuth2 que pode ser usado para autenticar aplicativos.

    Para informações sobre tokens de acesso, consulte Como autenticar aplicativos diretamente com tokens de acesso.

Para mais informações sobre como o Compute Engine usa contas de serviço, consulte Contas de serviço.

tags

Lista todas as tags de rede associadas à VM.

Para mais informações sobre tags de rede, consulte Adicionar tags de rede.

zone A zona em que está localizada a VM. Esse valor tem o seguinte formato: projects/PROJECT_NUM/zones/ZONE

Chaves de metadados do atributo de instância predefinida

As chaves de metadados predefinidas para atributos de instância são armazenadas no seguinte diretório:

  • http://metadata.google.internal/computeMetadata/v1/instance/attributes/

A tabela a seguir fornece uma lista de chaves de metadados que o Compute Engine cria automaticamente no diretório de metadados instance/attributes/:

Entrada de metadados Descrição
physical_host

Uma string de hash que representa o local de uma VM criada com uma política de posicionamento compacto.

Para mais informações sobre esse atributo, consulte Verificar o local físico de uma VM.

enable-oslogin

Ativa ou desativa o gerenciamento de chave SSH na VM.

Para mais informações sobre o Login do SO, consulte Configurar o Login do SO.

enable-windows-ssh

Ativa ou desativa o SSH para VMs do Windows.

Para mais informações, consulte Conectar a VMs do Windows usando SSH.

vmdnssetting

Ative o DNS por zona e o DNS global para a VM.

Para mais informações sobre como usar nomes DNS zonais no DNS das suas VMs, consulte Usar DNS zonal para o tipo de DNS interno.

ssh-keys

Se você estiver gerenciando chaves SSH usando metadados, esse atributo permitirá que você configure chaves SSH públicas que se conectam a VMs neste projeto. Se houver várias chaves SSH, cada uma será separada por um caractere de nova linha (\n). O valor do atributo ssh-keys é uma string.

Exemplo: "user1:ssh-rsa mypublickey user1@host.com\nuser2:ssh-rsa mypublickey user2@host.com"

As chaves SSH gerenciadas pelo Login do SO não são visíveis nos metadados.

Chaves de metadados do atributo de convidado predefinidas

As chaves de metadados predefinidas para atributos de convidado da instância são armazenadas no seguinte diretório:

  • http://metadata.google.internal/computeMetadata/v1/instance/guest-attributes/

A tabela a seguir fornece uma lista de chaves de metadados e diretórios que o Compute Engine cria automaticamente no diretório de metadados instance/guest-attributes/:

Entrada de metadados Descrição
guestInventory/

Armazena o inventário do SO para a VM.

Coleta e armazena informações de detalhes do sistema operacional. Isso inclui informações como nome do host, versão do kernel, arquitetura e detalhes dos pacotes instalados.

Para mais informações sobre o inventário do SO, consulte Visualizar detalhes do sistema operacional.

hostkeys/

Armazena as chaves de host SSH. As chaves de host podem ser usadas para identificar um host ou máquina específicos.

Para chaves de host de informações, consulte Como armazenar chaves de host ativando atributos de convidado.

A seguir