DescribeImages - : Central de Documentação do Alibaba Cloud

Observações de uso

Você pode consultar suas imagens personalizadas, imagens públicas fornecidas pela Alibaba Cloud, imagens do Alibaba Cloud Marketplace e imagens compartilhadas de outras contas da Alibaba Cloud.
Esta é uma consulta paginada. A resposta contém o número total de imagens disponíveis e as imagens na página retornada. Por padrão, 10 entradas são exibidas por página.
Ao chamar uma operação de API com a CLI da Alibaba Cloud, especifique os valores dos parâmetros de solicitação de diferentes tipos nos formatos exigidos. Para obter mais informações, consulte Visão geral do formato de parâmetros.
Se você definir ImageOwnerAlias como system ou others ao chamar a operação DescribeImages para consultar imagens fornecidas pela Alibaba Cloud ou imagens compartilhadas, a operação ignorará as regras de autenticação do Resource Access Management (RAM). Para obter mais informações, consulte Regras de autenticação.

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Recomendamos chamar esta operação no OpenAPI Explorer para maior conveniência. O OpenAPI Explorer gera dinamicamente códigos de exemplo da operação para diferentes SDKs.

Parâmetros de solicitação

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Sim	DescribeImages	A operação a ser executada. Defina o valor como DescribeImages.
RegionId	String	Sim	cn-hangzhou	O ID da região da imagem. Chame a operação DescribeRegions para consultar a lista de regiões mais recente.
Status	String	Não	Available	O status da imagem. Se este parâmetro não for especificado, apenas imagens no estado Available serão retornadas por padrão. Valores válidos: Creating: a imagem está sendo criada. Waiting: a imagem aguarda processamento. Available: a imagem está disponível. UnAvailable: a imagem está indisponível. CreateFailed: falha na criação da imagem. Deprecated: a imagem não é mais utilizada. Valor padrão: Available. Você pode especificar vários valores para este parâmetro. Separe-os com vírgulas (,).
ImageId	String	Não	m-bp1g7004ksh0oeuc****	O ID da imagem.
ShowExpired	Boolean	Não	false	Indica se a imagem por assinatura expirou. Nota Este parâmetro será removido futuramente. Recomendamos usar outros parâmetros para garantir compatibilidade futura.
SnapshotId	String	Não	s-bp17ot2q7x72ggtw****	O ID do snapshot usado para criar a imagem personalizada.
ImageName	String	Não	testImageName	O nome da imagem.
ImageFamily	String	Não	hangzhou-daily-update	O nome da família de imagens. Configure este parâmetro para consultar imagens da família especificada. Por padrão, este parâmetro está vazio. Nota Para obter informações sobre famílias de imagens associadas a imagens públicas fornecidas pela Alibaba Cloud, consulte Visão geral.
ImageOwnerAlias	String	Não	self	A origem da imagem. Valores válidos: system: imagem pública fornecida pela Alibaba Cloud, mas indisponível no Alibaba Cloud Marketplace. self: imagem personalizada criada por você. others: imagem compartilhada de outra conta da Alibaba Cloud ou imagem da comunidade publicada por um usuário da Alibaba Cloud para uso de outros membros da comunidade. Observe os seguintes itens: Para consultar imagens da comunidade, defina IsPublic como true. Para consultar imagens compartilhadas, defina IsPublic como false ou deixe o parâmetro IsPublic vazio. marketplace: imagem lançada pela Alibaba Cloud ou por um fornecedor independente de software (ISV) no Alibaba Cloud Marketplace. Adquira a imagem junto com uma instância do Elastic Compute Service (ECS). Atenção aos detalhes de faturamento das imagens. Por padrão, este parâmetro está vazio. Nota Se este parâmetro estiver vazio, a consulta retornará imagens personalizadas, imagens fornecidas pela Alibaba Cloud, imagens compartilhadas e imagens da comunidade.
InstanceType	String	Não	ecs.g5.large	O tipo de instância compatível com a imagem.
IsSupportIoOptimized	Boolean	Não	true	Indica se a imagem é compatível com instâncias otimizadas para E/S.
IsSupportCloudinit	Boolean	Não	true	Indica se a imagem oferece suporte a cloud-init.
OSType	String	Não	linux	O tipo de sistema operacional da imagem. Valores válidos: windows linux
Architecture	String	Não	i386	A arquitetura da imagem. Valores válidos: i386 x86_64 arm64
PageNumber	Integer	Não	1	O número da página. A numeração começa em 1. Valor padrão: 1.
PageSize	Integer	Não	1	O número de entradas por página. Valores válidos: 1 a 100. Valor padrão: 10.
Usage	String	Não	instance	Indica se a imagem está em execução em uma instância ECS. Valores válidos: instance: a imagem está em uso e em execução em uma instância ECS. none: a imagem não está em uso.
DryRun	Boolean	Não	false	Indica se deve ser realizada apenas uma simulação, sem executar a solicitação real. Valores válidos: true: realiza apenas uma simulação. O sistema verifica o par de AccessKey, as permissões do usuário do Resource Access Management (RAM) e os parâmetros obrigatórios. Se a solicitação falhar na simulação, uma mensagem de erro será retornada. Caso contrário, o código de erro DryRunOperation será retornado. false: realiza uma simulação e executa a solicitação real. Se a solicitação passar na simulação, um código de status HTTP 2xx será retornado e a operação será executada. Valor padrão: false.
ActionType	String	Não	CreateEcs	O cenário de uso da imagem. Valores válidos: CreateEcs (padrão): criação de instância. ChangeOS: substituição do disco do sistema ou do sistema operacional.
ResourceGroupId	String	Não	rg-bp67acfmxazb4p****	O ID do grupo de recursos ao qual a imagem personalizada pertence. Se este parâmetro for especificado na consulta, até 1.000 recursos pertencentes ao grupo de recursos indicado serão retornados. Nota Os recursos no grupo de recursos padrão aparecem na resposta independentemente da configuração deste parâmetro.
Tag.N.key	String	Não	null	A chave da tag N da imagem. Nota Este parâmetro será removido futuramente. Recomendamos usar `Tag.N.Key` para garantir compatibilidade futura.
Tag.N.Key	String	Não	TestKey	A chave da tag N da imagem. Valores válidos de N: 1 a 20. Se uma única tag for especificada na consulta, até 1.000 recursos com essa tag serão retornados. Se várias tags forem especificadas, até 1.000 recursos que contenham todas essas tags serão retornados. Para consultar mais de 1.000 recursos com as tags especificadas, chame a operação ListTagResources.
Tag.N.Value	String	Não	TestValue	O valor da tag N da imagem. Valores válidos de N: 1 a 20.
Tag.N.value	String	Não	null	O valor da tag N da imagem. Nota Este parâmetro será removido futuramente. Recomendamos usar `Tag.N.Value` para garantir compatibilidade futura.
Filter.N.Key	String	Não	CreationStartTime	A chave do filtro N usada para consultar recursos. Valores válidos: Se definido como `CreationStartTime`, consulta os recursos criados após o momento especificado pelo parâmetro `Filter.N.Value`. Se definido como `CreationEndTime`, consulta os recursos criados antes do momento especificado pelo valor de `Filter.N.Value`.
Filter.N.Value	String	Não	2017-12-05T22:40Z	O valor do filtro N usado para consultar recursos. Defina o valor como o início ou o fim do intervalo de tempo da consulta. Ao especificar este parâmetro, também especifique `Filter.N.Key`. Use o formato `yyyy-MM-ddTHH:mmZ`. A hora deve estar em UTC.
IsPublic	Boolean	Não	false	Indica se devem ser consultadas imagens da comunidade publicadas. Valores válidos: true: consulta imagens da comunidade publicadas. Se definido como true, o parâmetro ImageOwnerAlias deve ser definido como others. false: consulta tipos de imagem diferentes de imagens da comunidade. Os tipos específicos consultados dependem do valor de ImageOwnerAlias. Valor padrão: false.
ImageOwnerId	Long	Não	1234567890	O ID da conta da Alibaba Cloud à qual a imagem pertence. Este parâmetro só tem efeito na consulta de imagens compartilhadas ou imagens da comunidade.

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
PageSize	Integer	1	O número de entradas por página.
PageNumber	Integer	1	O número da página.
RequestId	String	66189103-EDB2-43E2-BB60-BFF2B62F4EB8	O ID da solicitação.
TotalCount	Integer	1	O número total de imagens.
RegionId	String	cn-hangzhou	O ID da região da imagem.
Images	Array of Image		As informações sobre as imagens.
Image
CreationTime	String	2019-11-15T06:07:05Z	A hora de criação da imagem.
Status	String	Available	O status da imagem. Valores válidos: UnAvailable Available Creating CreateFailed
ImageFamily	String	hangzhou-daily-update	O nome da família de imagens.
Progress	String	100%	O progresso da criação da imagem. Unidade: porcentagem (%).
IsCopied	Boolean	false	Indica se a imagem é uma cópia de outra imagem.
IsSupportIoOptimized	Boolean	true	Indica se a imagem é compatível com instâncias otimizadas para E/S.
ImageOwnerAlias	String	self	A origem da imagem. Valores válidos: system: imagens públicas fornecidas pela Alibaba Cloud. self: imagem personalizada criada por você. others: imagens compartilhadas de outras contas da Alibaba Cloud ou imagens da comunidade publicadas por outras contas da Alibaba Cloud. marketplace: imagens do Alibaba Cloud Marketplace.
IsSupportCloudinit	Boolean	true	Indica se a imagem oferece suporte a cloud-init.
ImageVersion	String	2	A versão da imagem.
Usage	String	none	Indica se a imagem foi usada para criar instâncias ECS. Valores válidos: instance: a imagem foi usada para criar uma ou mais instâncias ECS. none: a imagem não foi usada para criar instâncias ECS.
IsSelfShared	String	true	Indica se a imagem personalizada foi compartilhada com outras contas da Alibaba Cloud.
Description	String	Archive log for Oracle	A descrição da imagem.
Size	Integer	60	O tamanho da imagem. Unidade: GiB.
ResourceGroupId	String	rg-bp67acfmxazb4p****	O ID do grupo de recursos ao qual a imagem pertence.
Platform	String	Windows Server 2016	O sistema operacional.
OSNameEn	String	Windows Server 2016 Data Center Edition 64bit Chinese Edition	O nome de exibição do sistema operacional em inglês.
ImageName	String	testImageName	O nome da imagem.
OSName	String	Windows Server 2016 Datacenter 64-bit (Simplified Chinese)	O nome de exibição do sistema operacional em chinês.
ImageId	String	m-bp1g7004ksh0oeuc****	O ID da imagem.
OSType	String	windows	O tipo do sistema operacional. Valores válidos: windows linux
IsSubscribed	Boolean	false	Indica se os Termos de Serviço do serviço de imagem correspondente ao código do produto foram aceitos.
ProductCode	String	test000****	O código do produto do Alibaba Cloud Marketplace da imagem.
Architecture	String	x86_64	A arquitetura da imagem. Valores válidos: i386 x86_64 arm64
BootMode	String	BIOS	O modo de inicialização da imagem. Valores válidos: BIOS UEFI
DiskDeviceMappings	Array of DiskDeviceMapping		Os mapeamentos entre discos e snapshots na imagem.
DiskDeviceMapping
Type	String	system	O tipo da imagem.
ImportOSSBucket	String	testEcsImport	O bucket do Object Storage Service (OSS) que contém o arquivo de imagem importado.
Progress	String	32%	O progresso da tarefa de cópia da imagem.
SnapshotId	String	s-bp17ot2q7x72ggtw****	O ID do snapshot.
ImportOSSObject	String	imageImport	O objeto OSS correspondente ao arquivo de imagem importado.
Device	String	/dev/xvda	O nome do dispositivo do disco. Exemplo: /dev/xvdb. Nota Este parâmetro será removido futuramente. Para garantir compatibilidade, recomendamos usar outros parâmetros.
Size	String	60	O tamanho do disco. Unidade: GiB.
RemainTime	Integer	233	O tempo restante da tarefa de cópia de imagem. Unidade: segundos.
Format	String	qcow2	O formato da imagem.
Tags	Array of Tag		As tags da imagem.
Tag
TagValue	String	Oracle	O valor da tag da imagem.
TagKey	String	DTS	A chave da tag da imagem.
IsPublic	Boolean	false	Indica se a imagem é pública. Imagens públicas incluem imagens fornecidas pela Alibaba Cloud e imagens personalizadas publicadas como imagens da comunidade. Valores válidos: true: a imagem é pública. false: a imagem não é pública.
ImageOwnerId	Long	1234567890	O ID da conta da Alibaba Cloud à qual a imagem pertence. Este parâmetro só tem efeito na consulta de imagens compartilhadas ou imagens da comunidade.
LoginAsNonRootSupported	Boolean	false	Indica se a imagem permite login de usuários não root. Valores válidos: true false
SupplierName	String	TestName	O nome do fornecedor que publicou a imagem da comunidade.
DetectionOptions	Object		Detalhes da verificação da imagem.
Status	String	Processing	O status da tarefa de verificação da imagem. Valores válidos: Processing Finished
Items	Array of Item		Os itens de verificação.
Item
Name	String	Nvme	O nome do item de verificação.
Value	String	Supported	O resultado do item de verificação.
RiskLevel	String	High	A gravidade do risco associado ao item de verificação da imagem personalizada importada. Retornado apenas se o item apresentar risco. Valores válidos: High: item de alto risco que pode afetar a inicialização da instância. Recomendamos tratar o risco. Medium: item de médio risco que pode afetar o desempenho de inicialização ou as configurações da instância. Recomendamos tratar o risco.
RiskCode	String	NVMe.NotInstalled	O risco potencial do item de verificação.
Features	Object		Os atributos da imagem.
NvmeSupport	String	supported	Indica se a imagem oferece suporte ao protocolo Non-Volatile Memory Express (NVMe). Valores válidos: supported: a imagem oferece suporte ao protocolo NVMe. Instâncias criadas a partir desta imagem também oferecem suporte ao protocolo NVMe. unsupported: a imagem não oferece suporte ao protocolo NVMe. Instâncias criadas a partir desta imagem não oferecem suporte ao protocolo NVMe.

Exemplos

Exemplos de solicitações

http(s)://ecs.aliyuncs.com/?Action=DescribeImages
&RegionId=cn-hangzhou
&PageNumber=1
&PageSize=1
&<Common request parameters>

Exemplos de respostas de sucesso

Formato XML

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeImagesResponse>
    <TotalCount>1</TotalCount>
    <PageSize>1</PageSize>
    <RequestId>66189103-EDB2-43E2-BB60-BFF2B62F4EB8</RequestId>
    <PageNumber>1</PageNumber>
    <Images>
        <Image>
            <ImageOwnerAlias>self</ImageOwnerAlias>
            <IsSelfShared>true</IsSelfShared>
            <Description>Archive log for Oracle</Description>
            <Platform>Windows Server 2016</Platform>
            <ResourceGroupId>rg-bp67acfmxazb4p****</ResourceGroupId>
            <Size>60</Size>
            <IsSubscribed>false</IsSubscribed>
            <BootMode>BIOS</BootMode>
            <OSName>Windows Server 2016 Datacenter 64-bit (Simplified Chinese)</OSName>
            <IsPublic>false</IsPublic>
            <ImageId>m-bp1g7004ksh0oeuc****</ImageId>
            <DetectionOptions/>
            <Features>
                <NvmeSupport>supported</NvmeSupport>
            </Features>
            <OSNameEn>Windows Server 2016 Data Center Edition 64bit Chinese Edition</OSNameEn>
            <Tags>
                <Tag>
                    <TagKey>DTS</TagKey>
                    <TagValue>Oracle</TagValue>
                </Tag>
            </Tags>
            <LoginAsNonRootSupported>false</LoginAsNonRootSupported>
            <Status>Available</Status>
            <Progress>100%</Progress>
            <Usage>none</Usage>
            <Architecture>x86_64</Architecture>
            <ProductCode>test000****</ProductCode>
            <IsCopied>false</IsCopied>
            <ImageFamily>hangzhou-daily-update</ImageFamily>
            <IsSupportIoOptimized>true</IsSupportIoOptimized>
            <IsSupportCloudinit>true</IsSupportCloudinit>
            <ImageName>testImageName</ImageName>
            <DiskDeviceMappings>
                <DiskDeviceMapping>
                    <SnapshotId>s-bp17ot2q7x72ggtw****</SnapshotId>
                    <Type>system</Type>
                    <Progress>32%</Progress>
                    <Format>qcow2</Format>
                    <Device>/dev/xvda</Device>
                    <Size>60</Size>
                    <ImportOSSBucket>testEcsImport</ImportOSSBucket>
                    <ImportOSSObject>imageImport</ImportOSSObject>
                </DiskDeviceMapping>
            </DiskDeviceMappings>
            <ImageVersion>2</ImageVersion>
            <OSType>windows</OSType>
            <CreationTime>2019-11-15T06:07:05Z</CreationTime>
        </Image>
    </Images>
    <RegionId>cn-hangzhou</RegionId>
</DescribeImagesResponse>

Formato JSON

HTTP/1.1 200 OK
Content-Type:application/json

{
  "TotalCount" : 1,
  "PageSize" : 1,
  "RequestId" : "66189103-EDB2-43E2-BB60-BFF2B62F4EB8",
  "PageNumber" : 1,
  "Images" : {
    "Image" : [ {
      "ImageOwnerAlias" : "self",
      "IsSelfShared" : "true",
      "Description" : "Archive log for Oracle",
      "Platform" : "Windows Server 2016",
      "ResourceGroupId" : "rg-bp67acfmxazb4p****",
      "Size" : 60,
      "IsSubscribed" : false,
      "BootMode" : "BIOS",
      "OSName": "Windows Server 2016 Datacenter 64-bit (Simplified Chinese)",
      "IsPublic" : false,
      "ImageId" : "m-bp1g7004ksh0oeuc****",
      "DetectionOptions" : { },
      "Features" : {
        "NvmeSupport" : "supported"
      },
      "OSNameEn" : "Windows Server 2016 Data Center Edition 64bit Chinese Edition",
      "Tags" : {
        "Tag" : [ {
          "TagKey" : "DTS",
          "TagValue" : "Oracle"
        } ]
      },
      "LoginAsNonRootSupported" : false,
      "Status" : "Available",
      "Progress" : "100%",
      "Usage" : "none",
      "Architecture" : "x86_64",
      "ProductCode" : "test000****",
      "IsCopied" : false,
      "ImageFamily" : "hangzhou-daily-update",
      "IsSupportIoOptimized" : true,
      "IsSupportCloudinit" : true,
      "ImageName" : "testImageName",
      "DiskDeviceMappings" : {
        "DiskDeviceMapping" : [ {
          "SnapshotId" : "s-bp17ot2q7x72ggtw****",
          "Type" : "system",
          "Progress" : "32%",
          "Format" : "qcow2",
          "Device" : "/dev/xvda",
          "Size" : "60",
          "ImportOSSBucket" : "testEcsImport",
          "ImportOSSObject" : "imageImport"
        } ]
      },
      "ImageVersion" : "2",
      "OSType" : "windows",
      "CreationTime" : "2019-11-15T06:07:05Z"
    } ]
  },
  "RegionId" : "cn-hangzhou"
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	InvalidImageOwnerAlias.ValueNotSupported	The specified ImageOwnerAlias value is not supported.	Valor de ImageOwnerAlias inválido.
400	InvalidParamter	Invalid Parameter.	Valor de parâmetro inválido.
400	InvalidTag.Mismatch	The specified Tag.n.Key and Tag.n.Value are not match.	Os valores Tag.N.Key e Tag.N.Value não correspondem.
400	InvalidTagCount	The specified tags are beyond the permitted range.	O número máximo de tags especificadas foi excedido.
400	InvalidInstanceType.ValueNotSupported	The specified InstanceType does not exist or beyond the permitted range.	O tipo de instância especificado não existe ou você não tem autorização para gerenciar instâncias desse tipo.
403	CurrentAccount.NotSupportPublicImage	Public image is not supported for current account.	A conta atual não pode usar imagens públicas.
404	InvalidFilterKey.NotFound	The specified Filter Key is not found.	Valor de Filter.N.Key inválido.
404	InvalidFilterValue	The specified Filter Value is not valid.	Valor de Filter.N.Value inválido.
404	InvalidUsage	The specified Usage is not valid.	Valor de Usage inválido.
404	InvalidOSType	The specified OSType is not valid.	Valor de OSType inválido.
404	InvalidArchitecture	The specified Architecture is not valid.	Valor de Architecture inválido.
500	InternalError	The request processing has failed due to some unknown error.	Ocorreu um erro interno. Tente novamente mais tarde.

Para obter uma lista de códigos de erro, consulte Códigos de erro do serviço.