DescribeImageFromFamily - Elastic Compute Service: Central de Documentação do Alibaba Cloud

Consulta a imagem disponível mais recente em uma família de imagens especificada.

Descrição da operação

Se não existir nenhuma imagem disponível na família de imagens especificada, a resposta estará vazia.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

ecs:DescribeImageFromFamily

get

*Todos os recursos.

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
RegionId	string	Sim	O ID da região da imagem. Você pode chamar DescribeRegions para consultar a lista de regiões mais recente.	cn-hangzhou
ImageFamily	string	Sim	O nome da família de imagens. Imagens personalizadas, imagens públicas, imagens da comunidade e imagens compartilhadas suportam famílias de imagens. Para mais informações, consulte Visão geral da família de imagens.	hangzhou-daily-update

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
RequestId	string	O ID da solicitação.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
Image	object	As informações da imagem.
CreationTime	string	A hora em que a imagem foi criada. A hora segue o padrão ISO 8601 em UTC.	2018-01-10T01:01:10Z
Status	string	O status da imagem. Valores válidos: UnAvailable: indisponível Available: disponível Creating: sendo criada CreateFailed: falha ao ser criada	Available
ImageFamily	string	A família de imagens.	testImageFamily
Progress	string	O progresso de criação da imagem, em porcentagem.	100
IsCopied	boolean	Indica se a imagem é uma cópia de outra imagem.	false
IsSupportIoOptimized	boolean	Indica se a imagem pode ser usada em instâncias otimizadas para E/S.	true
ImageOwnerAlias	string	O alias do proprietário da imagem. Valores válidos: system: imagem pública. self: sua imagem personalizada. others: imagem de outro usuário. marketplace: imagem do Alibaba Cloud Marketplace.	self
IsSupportCloudinit	boolean	Indica se o cloud-init é suportado.	true
ImageVersion	string	A versão da imagem.	2
Usage	string	O tipo de recurso ao qual a imagem está associada. Valores válidos: instance: uma ou mais instâncias ECS foram criadas a partir da imagem. none: nenhuma instância ECS foi criada a partir da imagem.	none
IsSelfShared	string	Indica se a imagem personalizada foi compartilhada com outros usuários.	true
Description	string	A descrição da imagem.	testDescription
Size	integer	O tamanho da imagem. Unidade: GiB.	80
Platform	string	A plataforma do sistema operacional.	Aliyun
ImageName	string	O nome da imagem.	testImageName
OSName	string	O nome de exibição do sistema operacional na localidade da China.	Alibaba Cloud Linux 2.1903
ImageId	string	O ID da imagem.	m-bp1g7004ksh0oeuc****
OSType	string	O tipo do sistema operacional. Valores válidos: windows linux	linux
IsSubscribed	boolean	Indica se você se inscreveu nos Termos de Serviço do produto de imagem que corresponde ao código do produto.	false
ProductCode	string	O código do produto da imagem do Alibaba Cloud Marketplace.	jxsc00****
Architecture	string	O tipo de arquitetura do sistema da imagem. Valores válidos: i386 x86_64	x86_64
DiskDeviceMappings	object
DiskDeviceMapping	array<object>	Os mapeamentos entre discos e snapshots na imagem.
	object
Type	string	O tipo da imagem.	custom
ImportOSSBucket	string	O bucket do OSS que contém a imagem importada.	testEcsImport
SnapshotId	string	O ID do snapshot.	s-bp17ot2q7x72ggtw****
ImportOSSObject	string	O objeto do OSS que corresponde à imagem importada.	imageImport
Size	string	O tamanho do disco. Unidade: GiB.	80
Device	string	As informações do dispositivo do disco, como /dev/xvdb. Nota Este parâmetro será descontinuado. Para garantir a compatibilidade, não use este parâmetro.	/dev/xvdb
Format	string	O formato da imagem.	qcow2
Tags	object
Tag	array<object>	Os pares chave-valor de tag da imagem.
	object
TagValue	string	O valor da tag da imagem personalizada.	TestValue
TagKey	string	A chave da tag da imagem personalizada.	TestKey

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "Image": {
    "CreationTime": "2018-01-10T01:01:10Z",
    "Status": "Available",
    "ImageFamily": "testImageFamily",
    "Progress": "100",
    "IsCopied": false,
    "IsSupportIoOptimized": true,
    "ImageOwnerAlias": "self",
    "IsSupportCloudinit": true,
    "ImageVersion": "2",
    "Usage": "none",
    "IsSelfShared": "true",
    "Description": "testDescription",
    "Size": 80,
    "Platform": "Aliyun",
    "ImageName": "testImageName",
    "OSName": "Alibaba Cloud Linux 2.1903",
    "ImageId": "m-bp1g7004ksh0oeuc****",
    "OSType": "linux",
    "IsSubscribed": false,
    "ProductCode": "jxsc00****",
    "Architecture": "x86_64",
    "DiskDeviceMappings": {
      "DiskDeviceMapping": [
        {
          "Type": "custom",
          "ImportOSSBucket": "testEcsImport",
          "SnapshotId": "s-bp17ot2q7x72ggtw****",
          "ImportOSSObject": "imageImport",
          "Size": "80",
          "Device": "/dev/xvdb",
          "Format": "qcow2"
        }
      ]
    },
    "Tags": {
      "Tag": [
        {
          "TagValue": "TestValue",
          "TagKey": "TestKey"
        }
      ]
    }
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
403	InvalidUser.Unauthorized	The user is not authorized.
404	InvalidRegionId.NotFound	The RegionId provided does not exist.	O RegionId especificado não existe. Verifique se o produto está disponível nesta região.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.