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

Observações de uso

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

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Para sua conveniência, recomendamos que você chame esta operação no OpenAPI Explorer. O OpenAPI Explorer gera dinamicamente o código de exemplo da operação para diferentes SDKs.

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Sim	DescribeImageFromFamily	A operação a ser executada. Defina o valor como DescribeImageFromFamily.
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.
ImageFamily	String	Sim	hangzhou-daily-update	O nome da família de imagens. É possível configurar famílias de imagens para imagens personalizadas, públicas, da comunidade e compartilhadas. Para obter mais informações, consulte Visão geral.

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
RequestId	String	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E	O ID da solicitação.
Image	Object		As informações da imagem.
CreationTime	String	2018-01-10T01:01:10Z	A hora de criação da imagem.
Status	String	Available	O status da imagem. Valores válidos: UnAvailable Available Creating CreateFailed
ImageFamily	String	testImageFamily	O nome da família de imagens.
Progress	String	100	O progresso de 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 pode ser usada em instâncias otimizadas para E/S.
ImageOwnerAlias	String	self	O alias do proprietário da imagem. Valores válidos: system: imagens públicas fornecidas pela Alibaba Cloud self: suas imagens personalizadas others: imagens compartilhadas de outras contas da Alibaba Cloud marketplace: imagens do Alibaba Cloud Marketplace
IsSupportCloudinit	Boolean	true	Indica se a imagem oferece suporte ao cloud-init.
ImageVersion	String	2	A versão da imagem.
Usage	String	none	Indica se a imagem foi utilizada 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	testDescription	A descrição.
Size	Integer	80	O tamanho da imagem. Unidade: GiB.
Platform	String	Aliyun	A plataforma do sistema operacional.
ImageName	String	testImageName	O nome da imagem.
OSName	String	Alibaba Cloud Linux 2.1903	O nome de exibição do sistema operacional em chinês.
ImageId	String	m-bp1g7004ksh0oeuc****	O ID da imagem.
OSType	String	linux	O tipo do sistema operacional. Valores válidos: windows linux
IsSubscribed	Boolean	false	Indica se você aceitou os termos de serviço do produto de imagem correspondente ao código do produto de imagem.
ProductCode	String	jxsc00****	O código do produto da imagem do Alibaba Cloud Marketplace.
Architecture	String	x86_64	A arquitetura da imagem. Valores válidos: i386 x86_64
DiskDeviceMappings	Array of DiskDeviceMapping		Os mapeamentos entre discos e snapshots na imagem.
DiskDeviceMapping
Type	String	custom	O tipo da imagem.
ImportOSSBucket	String	testEcsImport	O bucket do Object Storage Service (OSS) que contém o arquivo de imagem importado.
SnapshotId	String	s-bp17ot2q7x72ggtw****	O ID do snapshot.
ImportOSSObject	String	imageImport	O objeto OSS correspondente ao arquivo de imagem importado.
Size	String	80	O tamanho do disco. Unidade: GiB.
Device	String	/dev/xvdb	O nome do dispositivo do disco. Exemplo: /dev/xvdb. Nota Este parâmetro será descontinuado. Recomendamos o uso de outros parâmetros para garantir a compatibilidade.
Format	String	qcow2	O formato da imagem.
Tags	Array of Tag		As tags da imagem.
Tag
TagValue	String	TestValue	O valor da tag da imagem personalizada.
TagKey	String	TestKey	A chave da tag da imagem personalizada.

Exemplos

Exemplos de solicitações

https://ecs.aliyuncs.com/?Action=DescribeImageFromFamily
&RegionId=cn-hangzhou
&ImageFamily=as-hangzhou-game-01
&<Common request parameters>

Exemplos de respostas de sucesso

Formato XML

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

<DescribeImageFromFamilyResponse>
    <RequestId>E39053A7-C3E6-41FA-8F8D-F5BD8063E61C</RequestId>
    <Image>
        <ImageOwnerAlias>self</ImageOwnerAlias>
        <Status>Available</Status>
        <Progress/>
        <Usage/>
        <Description>testDescription</Description>
        <IsSelfShared/>
        <Architecture>x86_64</Architecture>
        <Platform>CentOS</Platform>
        <ProductCode/>
        <Size>40</Size>
        <IsSubscribed>false</IsSubscribed>
        <IsCopied>false</IsCopied>
        <ImageFamily>testImageFamily</ImageFamily>
        <OSName>CentOS 8.0 64位</OSName>
        <IsSupportIoOptimized>true</IsSupportIoOptimized>
        <IsSupportCloudinit>true</IsSupportCloudinit>
        <ImageName>testImageName</ImageName>
        <DiskDeviceMappings>
            <DiskDeviceMapping>
                <SnapshotId>s-bp1ejhb4r1lyu55t****</SnapshotId>
                <Type>system</Type>
                <Format/>
                <Size>40</Size>
                <Device>/dev/xvda</Device>
                <ImportOSSBucket/>
                <ImportOSSObject/>
            </DiskDeviceMapping>
        </DiskDeviceMappings>
        <ImageVersion/>
        <OSType>linux</OSType>
        <ImageId>m-bp1ejhb4r1lyu55t****</ImageId>
        <CreationTime>2020-03-17T06:19:19Z</CreationTime>
        <Tags>
        </Tags>
    </Image>
</DescribeImageFromFamilyResponse>

Formato JSON

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

{
  "RequestId" : "E39053A7-C3E6-41FA-8F8D-F5BD8063E61C",
  "Image" : {
    "ImageOwnerAlias" : "self",
    "Status" : "Available",
    "Progress" : "",
    "Usage" : "",
    "Description" : "testDescription",
    "IsSelfShared" : "",
    "Architecture" : "x86_64",
    "Platform" : "CentOS",
    "ProductCode" : "",
    "Size" : 40,
    "IsSubscribed" : false,
    "IsCopied" : false,
    "ImageFamily" : "testImageFamily",
    "OSName" : "CentOS 8.0 64位",
    "IsSupportIoOptimized" : true,
    "IsSupportCloudinit" : true,
    "ImageName" : "testImageName",
    "DiskDeviceMappings" : {
      "DiskDeviceMapping" : [ {
        "SnapshotId" : "s-bp1ejhb4r1lyu55t****",
        "Type" : "system",
        "Format" : "",
        "Size" : "40",
        "Device" : "/dev/xvda",
        "ImportOSSBucket" : "",
        "ImportOSSObject" : ""
      } ]
    },
    "ImageVersion" : "",
    "OSType" : "linux",
    "ImageId" : "m-bp1ejhb4r1lyu55t****",
    "CreationTime" : "2020-03-17T06:19:19Z",
    "Tags" : {
      "Tag" : [ ]
    }
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
404	InvalidRegionId.NotFound	The RegionId provided does not exist.	O RegionId não foi encontrado.

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