DescribeImageFromFamily - - Centro de documentación de Alibaba Cloud

Consulta la imagen más reciente disponible en una familia de imágenes específica.

Notas de uso

Si no existe ninguna imagen disponible en una familia de imágenes específica, la respuesta se devuelve vacía.

Depuración

OpenAPI Explorer calcula automáticamente el valor de la firma. Para su comodidad, le recomendamos que ejecute esta operación en OpenAPI Explorer. OpenAPI Explorer genera de forma dinámica el código de ejemplo de la operación para distintos SDK.

Parámetros de solicitud

Parámetro	Tipo	Obligatorio	Ejemplo	Descripción
Action	String	Sí	DescribeImageFromFamily	Operación que desea ejecutar. Establezca el valor en DescribeImageFromFamily.
RegionId	String	Sí	cn-hangzhou	ID de la región de la imagen. Ejecute la operación DescribeRegions para consultar la lista de regiones más reciente.
ImageFamily	String	Sí	hangzhou-daily-update	Nombre de la familia de imágenes. Configure familias de imágenes para imágenes personalizadas, públicas, comunitarias y compartidas. Para obtener más información, consulte Descripción general.

Parámetros de respuesta

Parámetro	Tipo	Ejemplo	Descripción
RequestId	String	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E	ID de la solicitud.
Image	Object		Información de la imagen.
CreationTime	String	2018-01-10T01:01:10Z	Fecha y hora de creación de la imagen.
Status	String	Available	Estado de la imagen. Valores válidos: UnAvailable Available Creating CreateFailed
ImageFamily	String	testImageFamily	Nombre de la familia de imágenes.
Progress	String	100	Progreso de creación de la imagen. Unidad: porcentaje (%).
IsCopied	Boolean	false	Indica si la imagen es una copia de otra.
IsSupportIoOptimized	Boolean	true	Indica si la imagen se puede utilizar en instancias optimizadas para E/S.
ImageOwnerAlias	String	self	Alias del propietario de la imagen. Valores válidos: system: imágenes públicas proporcionadas por Alibaba Cloud self: sus imágenes personalizadas others: imágenes compartidas desde otras cuentas de Alibaba Cloud marketplace: imágenes de Alibaba Cloud Marketplace
IsSupportCloudinit	Boolean	true	Indica si la imagen es compatible con cloud-init.
ImageVersion	String	2	Versión de la imagen.
Usage	String	none	Indica si la imagen se utiliza para crear instancias de ECS. Valores válidos: instance: la imagen se utiliza para crear una o más instancias de ECS. none: la imagen no se utiliza para crear instancias de ECS.
IsSelfShared	String	true	Indica si la imagen personalizada se compartió con otras cuentas de Alibaba Cloud.
Description	String	testDescription	Descripción.
Size	Integer	80	Tamaño de la imagen. Unidad: GiB.
Platform	String	Aliyun	Plataforma del sistema operativo.
ImageName	String	testImageName	Nombre de la imagen.
OSName	String	Alibaba Cloud Linux 2.1903	Nombre para mostrar del sistema operativo en chino.
ImageId	String	m-bp1g7004ksh0oeuc****	ID de la imagen.
OSType	String	linux	Tipo de sistema operativo. Valores válidos: windows linux
IsSubscribed	Boolean	false	Indica si aceptó los términos de servicio del producto de imagen correspondiente al código de producto de la imagen.
ProductCode	String	jxsc00****	Código de producto de la imagen de Alibaba Cloud Marketplace.
Architecture	String	x86_64	Arquitectura de la imagen. Valores válidos: i386 x86_64
DiskDeviceMappings	Array of DiskDeviceMapping		Asignaciones entre discos e instantáneas en la imagen.
DiskDeviceMapping
Type	String	custom	Tipo de la imagen.
ImportOSSBucket	String	testEcsImport	Bucket de Object Storage Service (OSS) que contiene el archivo de imagen importado.
SnapshotId	String	s-bp17ot2q7x72ggtw****	ID de la instantánea.
ImportOSSObject	String	imageImport	Objeto de OSS correspondiente al archivo de imagen importado.
Size	String	80	Tamaño del disco. Unidad: GiB.
Device	String	/dev/xvdb	Nombre del dispositivo del disco. Ejemplo: /dev/xvdb. Nota Este parámetro quedará obsoleto. Le recomendamos que utilice otros parámetros para asegurarse de mantener la compatibilidad.
Format	String	qcow2	Formato de la imagen.
Tags	Array of Tag		Etiquetas de la imagen.
Tag
TagValue	String	TestValue	Valor de la etiqueta de la imagen personalizada.
TagKey	String	TestKey	Clave de la etiqueta de la imagen personalizada.

Ejemplos

Solicitudes de ejemplo

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

Respuestas de ejemplo correctas

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>

JSON formato

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 error

Código de estado HTTP	Código de error	Mensaje de error	Descripción
404	InvalidRegionId.NotFound	El RegionId proporcionado no existe.	No se encontró el RegionId.

Para obtener una lista de códigos de error, consulte Códigos de error del servicio.