Usar metadados da instância para gerenciar a instância do EC2 - Amazon Elastic Compute Cloud

Usar metadados da instância para gerenciar a instância do EC2

Os metadados da instância são dados sobre sua instância que é possível usar para configurar ou gerenciar a instância em execução. Os metadados de instância incluem o seguinte:

Propriedades de metadados de instância

As propriedades dos metadados de instância são divididas em categorias, por exemplo, nome do host, eventos e grupos de segurança.

Dados dinâmicos

Os dados dinâmicos são metadados que são gerados quando a instância é executada, como um documento de identidade de instância. Para ter mais informações, consulte Categorias de dados dinâmicos.

Dados do usuário

Você também pode usar os metadados de instância para acessar os dados do usuário que você especificou ao executar a instância. Por exemplo, é possível especificar parâmetros para configurar a instância ou incluir um script simples. Além disso, é possível criar AMIs genéricas e usar dados do usuário para modificar os arquivos de configuração fornecidos no momento da inicialização. Por exemplo, se você executar servidores Web para diversas pequenas empresas, todos eles poderão usar a mesma AMI genérica e recuperar o conteúdo de um bucket do Amazon S3 que você especificar nos dados do usuário na execução. Para adicionar um novo cliente a qualquer momento, crie um bucket para o cliente, adicione seu conteúdo e inicie a AMI com o nome exclusivo do bucket fornecido ao código nos dados do usuário. Se você executar várias instâncias usando a mesma chamada RunInstances, os dados do usuário estarão disponíveis para todas as instâncias nessa reserva. Cada instância que integra a mesma reserva tem um número de ami-launch-index exclusivo, permitindo que você escreva código que controle o que as instâncias farão. Por exemplo, o primeiro host pode se eleger como o nó original em um cluster. Para obter um exemplo detalhado de inicialização da AMI, consulte Identificar cada instância executada em uma única solicitação.

Importante

Embora você só possa acessar os metadados de instância e os dados do usuário de dentro da própria instância, os dados não são protegidos por autenticação ou métodos de criptografia. Qualquer usuário que tenha acesso direto à instância e, potencialmente, qualquer software em execução na instância, pode visualizar seus metadados. Portanto, você não deve armazenar dados confidenciais, como senhas ou chaves de criptografia de longa duração, como dados de usuário.

Categorias de metadados da instância

As propriedades de metadados de instância são divididas em categorias. Para recuperar as propriedades dos metadados de instância, especifique a categoria na solicitação. Os metadados serão retornados na resposta.

Quando novas categorias forem lançadas, uma nova compilação de metadados de instância será criada com um novo número de versão. Na tabela a seguir, a coluna Version when category was released (Versão quando a categoria foi lançada) especifica a versão da compilação quando uma categoria de metadados de instância foi lançada. Para evitar ter que atualizar seu código sempre que o Amazon EC2 lançar uma nova compilação de metadados de instância, use latest em vez do número da versão em suas solicitações de metadados. Para ter mais informações, consulte Obter as versões disponíveis dos metadados da instância.

Quando o Amazon EC2 libera uma nova categoria de metadados de instância, os metadados de instância da nova categoria podem não estar disponíveis para instâncias existentes. Com instâncias basedas em Nitro, você poderá recuperar metadados de instâncias somente para as categorias que estavam disponíveis na execução. Para instâncias com o hipervisor Xen, é possível interromper e iniciar a instância para atualizar as categorias que estão disponíveis para a instância.

A tabela a seguir lista as categorias de metadados da instância. Alguns dos nomes de categoria incluem espaços reservados para dados exclusivos da instância. Por exemplo, mac representa o endereço MAC para a interface de rede. É necessário substituir os espaços reservados pelos valores reais ao recuperar os metadados da instância.

Categoria Descrição Versão quando a categoria foi lançada
ami-id O ID da AMI usada para executar a instância. 1,0
ami-launch-index Se você executar várias instâncias usando a mesma chamada RunInstances, esse valor indicará a ordem de execução de cada instância. O valor da primeira instância executada é 0. Se você executar instâncias usando uma frota do Auto Scaling ou do EC2, esse valor será sempre 0. 1,0
ami-manifest-path O caminho para o arquivo de manifesto da AMI no Amazon S3. Se você usou uma AMI baseada no Amazon EBS para executar a instância, o resultado retornado será unknown. 1,0
ancestor-ami-ids Os IDs das AMIs de todas as instâncias que foram reagrupadas para criar essa AMI. Este valor existirá somente se o arquivo de manifesto de AMIs continham uma chave ancestor-amis. 10/10/2007
autoscaling/target-lifecycle-state

Valor mostrando o estado de destino do ciclo de vida do Auto Scaling para o qual uma instância do Auto Scaling está fazendo a transição. Presente quando a instância faz a transição para um dos estados de destino do ciclo de vida após 10 de março de 2022. Valores possíveis: Detached | InService | Standby | Terminated | Warmed:Hibernated | Warmed:Running | Warmed:Stopped | Warmed:Terminated. Consulte Retrieve the target lifecycle state through instance metadata (Recuperar o estado de destino do ciclo de vida por meio de metadados da instância) no Guia do usuário do Amazon EC2 Auto Scaling.

15/07/2021
block-device-mapping/ami O dispositivo virtual que contém o sistema de arquivos de inicialização/raiz. 15/12/2007
block-device-mapping/ebsN Os dispositivos virtuais associados a quaisquer volumes do Amazon EBS. Os volumes do Amazon EBS estarão disponíveis somente em metadados se estiverem presentes no momento da execução ou quando a instância foi iniciada pela última vez. O N indica o índice do volume do Amazon EBS (como ebs1 ou ebs2). 15/12/2007
block-device-mapping/ephemeralN Os dispositivos virtuais para qualquer volume de armazenamento de instâncias não NVMe. O N indica o índice de cada volume. O número dos volumes de armazenamento de instâncias no mapeamento de dispositivos de blocos pode não corresponder ao número real de volumes de armazenamento de instâncias da instância. O tipo de instância determina o número de volumes de armazenamento de instâncias que estão disponíveis para uma instância. Se o número de volumes de armazenamento de instâncias em um mapeamento de dispositivos de blocos exceder o número disponível para uma instância, os volumes de armazenamento de instâncias adicionais serão ignorados. 15/12/2007
block-device-mapping/root Os dispositivos virtuais ou as partições associadas aos dispositivos raiz, ou as partições no dispositivo virtual, onde o sistema de arquivos raiz (/ ou C:) está associado à instância específica. 15/12/2007
block-device-mapping/swap Os dispositivos virtuais associados a swap. Nem sempre presente. 15/12/2007
elastic-gpus/associations/elastic-gpu-id Se houver um Elastic GPU anexado à instância, ele contém uma string JSON com informações sobre o Elastic GPU, incluindo suas informações de ID e conexão. 30/11/2016
elastic-inference/associations/eia-id Se houver um acelerador do Elastic Inference anexado à instância, ele conterá uma string JSON com informações sobre o acelerador do Elastic Inference, incluindo o ID e o tipo. 29/11/2018
events/maintenance/history Se houver eventos de manutenção da instância concluídos ou cancelados, contém uma string JSON com informações sobre os eventos. 17/08/2018
events/maintenance/scheduled Se houver eventos de manutenção da instância ativos, contém uma string JSON com informações sobre os eventos. Para ter mais informações, consulte Visualizar eventos programados que afetam as instâncias do Amazon EC2. 17/08/2018
events/recommendations/rebalance O tempo aproximado, em UTC, quando a notificação de recomendação de rebalanceamento da instância do EC2 é emitida para a instância. Veja a seguir um exemplo dos metadados para esta categoria: {"noticeTime": "2020-11-05T08:22:00Z"}. Esta categoria só está disponível após a emissão da notificação. Para ter mais informações, consulte Recomendações de rebalanceamento de instâncias do EC2. 27/10/2020
hostname Se a instância do EC2 estiver usando a nomenclatura baseada em IP (IPBN), esse é o hostname DNS de IPv4 privado da instância. Se a instância do EC2 estiver usando nomenclatura baseada em recursos (RBN), esse é o RBN. Em casos em que várias interfaces de rede estão presentes, isso se refere ao dispositivo eth0 (o dispositivo para o qual o número de dispositivo é 0). Para obter mais informações sobre IPBN e RBN, consulte Tipos de nome de host de instância do Amazon EC2. 1,0
iam/info Se houver uma função do IAM associada à instância, conterá informações sobre a última vez que o perfil de instância foi atualizado, incluindo a data LastUpdated, InstanceProfileArn e InstanceProfileId. Caso contrário, não estará presente. 12/01/2012
iam/security-credentials/role-name Se houver uma função do IAM associada à instância, role-name será o nome da função, e role-name conterá as credenciais de segurança temporárias associadas à função (para obter mais informações, consulte Recuperar credenciais de segurança dos metadados da instância). Caso contrário, não estará presente. 12/01/2012
identity-credentials/ec2/info Informações sobre as credenciais no identity-credentials/ec2/security-credentials/ec2-instance. 23/05/2018
identity-credentials/ec2/security-credentials/ec2-instance As credenciais do perfil de identidade da instância que permitem que o software na instância se identifique para a AWS para oferecer suporte a recursos como o EC2 Instance Connect e à Configuração padrão de gerenciamento de host do AWS Systems Manager. Essas credenciais não têm políticas anexadas, portanto, não têm permissões adicionais de APIs da AWS além de identificar a instância para o recurso da AWS. Para ter mais informações, consulte Perfis de identidade da instância para instâncias do Amazon EC2. 23/05/2018
instance-action Notifica a instância que ela deve ser reinicializada em preparação para o empacotamento. Valores válidos: none | shutdown | bundle-pending. 01/09/2008
instance-id O ID dessa instância. 1,0
instance-life-cycle A opção de compra desta instância. Para ter mais informações, consulte Opções de faturamento e compra do Amazon EC2. 01/10/2019
instance-type O tipo da instância. Para ter mais informações, consulte Tipos de instância do Amazon EC2. 29/08/2007
ipv6 O endereço IPv6 da instância. Em casos em que várias interfaces de rede estão presentes, isso se refere ao dispositivo eth0 (o dispositivo cujo número de dispositivo é 0) na interface de rede e o primeiro endereço iPv6 atribuído. Se nenhum endereço IPv6 existir na interface de rede[0], esse item não será definido e gerará uma resposta HTTP 404. 03/01/2021
kernel-id O ID do kernel executado com essa instância, se aplicável. 01/02/2008
local-hostname Em casos em que várias interfaces de rede estão presentes, isso se refere ao dispositivo eth0 (o dispositivo para o qual o número de dispositivo é 0). Se a instância do EC2 estiver usando a nomenclatura baseada em IP (IPBN), esse é o hostname DNS de IPv4 privado da instância. Se a instância do EC2 estiver usando nomenclatura baseada em recursos (RBN), esse é o RBN. Para obter mais informações sobre IPBN, RBN e nomenclatura de instâncias do EC2, consulte Tipos de nome de host de instância do Amazon EC2. 19/01/2007
local-ipv4 O endereço IPv4 privado da instância. Em casos em que várias interfaces de rede estão presentes, isso se refere ao dispositivo eth0 (o dispositivo para o qual o número de dispositivo é 0). Se esta for uma instância somente IPv6, esse item não será definido e gerará uma resposta HTTP 404. 1,0
mac O endereço Media Access Control (MAC) da instância. Em casos em que várias interfaces de rede estão presentes, isso se refere ao dispositivo eth0 (o dispositivo para o qual o número de dispositivo é 0). 01/01/2011
metrics/vhostmd Não está mais disponível. 01/05/2011
network/interfaces/macs/mac/device-number O número de dispositivo exclusivo associado a essa interface. O número do dispositivo corresponde ao nome do dispositivo; por exemplo, um device-number de 2 é para o dispositivo eth2. Essa categoria corresponde aos campos DeviceIndex e device-index que são usados pelos comandos da API do Amazon EC2 e do EC2 para a AWS CLI. 01/01/2011
network/interfaces/macs/mac/interface-id O ID da interface de rede. 01/01/2011
network/interfaces/macs/mac/ipv4-associations/public-ip Os endereços IPv4 privados que estão associados a cada endereço IP público e estão atribuídos a essa interface. 01/01/2011
network/interfaces/macs/mac/ipv6s Os endereços IPv6 atribuídos à interface. 30/06/2016
network/interfaces/macs/mac/ipv6-prefix O prefixo IPv6 atribuído à interface de rede.
network/interfaces/macs/mac/local-hostname

O nome de host DNS IPv4 privado da instância. Em casos em que várias interfaces de rede estão presentes, isso se refere ao dispositivo eth0 (o dispositivo para o qual o número de dispositivo é 0). Se esta for uma instância somente IPv6, esse será o nome baseado em recursos. Para obter mais informações sobre IPBN e RBN, consulte Tipos de nome de host de instância do Amazon EC2.

19/01/2007
network/interfaces/macs/mac/local-ipv4s Os endereços IPv4 privados associados à interface. Se esta for uma interface de rede somente IPv6, esse item não será definido e gerará uma resposta HTTP 404. 01/01/2011
network/interfaces/macs/mac/mac O endereço MAC da instância. 01/01/2011
network/interfaces/macs/mac/network-card O índice da placa de rede. Alguns tipos de instância suportam várias placas de rede. 01-11-2020
network/interfaces/macs/mac/owner-id O ID do proprietário da interface de rede. Em ambientes de várias interfaces, um terceiro pode anexar uma interface, como o Elastic Load Balancing. O tráfego em uma interface é sempre cobrado do proprietário da interface. 01/01/2011
network/interfaces/macs/mac/public-hostname O DNS público da interface (IPv4). Essa categoria só será retornada se o atributo enableDnsHostnames for definido como true. Para ter mais informações, consulte Atributos de DNS para sua VPC no Guia do usuário da Amazon VPC. Se a instância tiver apenas um endereço IPv6 público e nenhum endereço IPv4 público, esse item não será definido e gerará uma resposta HTTP 404. 01/01/2011
network/interfaces/macs/mac/public-ipv4s Os endereços IP públicos ou os endereços IP elásticos associados à interface. Pode haver vários endereços IPv4 em uma instância. 01/01/2011
network/interfaces/macs/mac/security-groups Grupos de segurança aos quais a interface de rede pertence. 01/01/2011
network/interfaces/macs/mac/security-group-ids Os IDs dos grupos de segurança aos quais a interface de rede pertence. 01/01/2011
network/interfaces/macs/mac/subnet-id O ID da sub-rede na qual a interface reside. 01/01/2011
network/interfaces/macs/mac/subnet-ipv4-cidr-block O bloco CIDR IPv4 da sub-rede na qual a interface reside. 01/01/2011
network/interfaces/macs/mac/subnet-ipv6-cidr-blocks O bloco CIDR IPv6 da sub-rede na qual a interface reside. 30/06/2016
network/interfaces/macs/mac/vpc-id O ID da VPC na qual a interface reside. 01/01/2011
network/interfaces/macs/mac/vpc-ipv4-cidr-block O bloco CIDR IPv4 principal da VPC. 01/01/2011
network/interfaces/macs/mac/vpc-ipv4-cidr-blocks Os blocos CIDR IPv4 da VPC. 30/06/2016
network/interfaces/macs/mac/vpc-ipv6-cidr-blocks O bloco CIDR IPv6 da VPC na qual a interface reside. 30/06/2016
placement/availability-zone A zona de disponibilidade na qual a instância foi executada. 01/02/2008
placement/availability-zone-id O ID estático da zona de disponibilidade em que a instância é executada. O ID da zona de disponibilidade é consistente entre as contas. No entanto, pode ser diferente da zona de disponibilidade, que pode variar de acordo com a conta. 01/10/2019
placement/group-name O nome do grupo de posicionamento no qual a instância é executada. 24/08/2020
placement/host-id O ID do host no qual a instância é executada. Aplicável apenas a Hosts dedicados. 24/08/2020
placement/partition-number O número da partição na qual a instância é executada. 24/08/2020
placement/region A região da AWS na qual a instância é executada. 24/08/2020
product-codes AWS Marketplace Os códigos de produtos associados com a instância, se houver. 01/03/2007
public-hostname O DNS público da instância (IPv4). Essa categoria só será retornada se o atributo enableDnsHostnames for definido como true. Para ter mais informações, consulte Atributos de DNS para sua VPC no Guia do usuário da Amazon VPC. Se a instância tiver apenas um endereço IPv6 público e nenhum endereço IPv4 público, esse item não será definido e gerará uma resposta HTTP 404. 19/01/2007
public-ipv4 O endereço IPv4 público. Se um endereço IP elástico estiver associado à instância, o valor retornado será o endereço IP elástico. 19/01/2007
public-keys/0/openssh-key Chave pública. Disponível somente se fornecido no momento da execução da instância. 1,0
ramdisk-id O ID do disco de RAM no momento da execução, se aplicável. 10/10/2007
reservation-id O ID da reserva. 1,0
security-groups

Os nomes dos grupos de segurança aplicados à instância.

Após a execução, você só pode alterar os grupos de segurança das instâncias. Essas alterações estão refletidas aqui e em network/interfaces/macs/mac/security-groups.

1,0
services/domain

O domínio dos recursos da AWS para a região.

25/02/2014
services/partition

A partição na qual o recurso está. Para regiões padrão da AWS a partição é aws. Se você tem recursos em outras partições, a partição é aws-partitionname. Por exemplo, a partição de recursos na região China (Pequim) é aws-cn.

20/10/2015
spot/instance-action

A ação (hibernar, interromper ou encerrar) e o tempo aproximado, em UTC, em que a ação ocorrerá. Esse item estará presente somente se a instância spot tiver sido marcada para hibernar, interromper ou encerrar. Para ter mais informações, consulte instance-action.

15/11/2016
spot/termination-time

O tempo aproximado, em UTC, no qual o sistema operacional para sua instância spot receberá o sinal de desligamento. Esse item está presente e contém um valor de tempo (por exemplo, 2015-01-05T18:02:00Z) somente se a instância spot tiver sido marcada para término pelo Amazon EC2. O item hora de encerramento não está definido como uma hora se você mesmo encerrou a instância spot. Para ter mais informações, consulte termination-time.

05/11/2014
tags/instance As tags de instância associadas à instância. Somente disponível se você permitir explicitamente acesso a etiquetas em metadados de instância. Para ter mais informações, consulte Permitir acesso a tags em metadados de instância. 23/03/2021

Categorias de dados dinâmicos

A tabela a seguir lista as categorias de dados dinâmicos.

Categoria Descrição Versão quando a categoria foi lançada
fws/instance-monitoring O valor que mostra se o cliente habilitou o monitoramento de um minuto detalhado no CloudWatch. Valores válidos: enabled | disabled 04/04/2009
instance-identity/document O JSON que contém os atributos da instância, como o ID da instância, o endereço IP privado, etc. Consulte Documentos de identidade da instância para instâncias do Amazon EC2. 04/04/2009
instance-identity/pkcs7 Usado para verificar a autenticidade e o conteúdo do documentos em relação à assinatura. Consulte Documentos de identidade da instância para instâncias do Amazon EC2. 04/04/2009
instance-identity/signature Os dados que podem ser usados por outras partes para verificar sua origem e autenticidade. Consulte Documentos de identidade da instância para instâncias do Amazon EC2. 04/04/2009