DescribeImages - - Centro de documentación de Alibaba Cloud

Consulta las imágenes disponibles.

Notas de uso

Puede consultar sus imágenes personalizadas, las imágenes públicas proporcionadas por Alibaba Cloud, las imágenes de Alibaba Cloud Marketplace y las imágenes compartidas de otras cuentas de Alibaba Cloud.
Esta es una consulta paginada. La respuesta contiene el número total de imágenes disponibles y las imágenes en la página devuelta. De forma predeterminada, se muestran 10 entradas por página.
Al llamar a una operación de API mediante Alibaba Cloud CLI, debe especificar los valores de los parámetros de solicitud de diferentes tipos en los formatos requeridos. Para obtener más información, consulte Parameter format overview.
Si establece ImageOwnerAlias en system u others al llamar a la operación DescribeImages para consultar imágenes proporcionadas por Alibaba Cloud o imágenes compartidas, las reglas de autenticación de Resource Access Management (RAM) se ignoran en la operación. Para obtener más información, consulte Authentication rules.

Depuración

OpenAPI Explorer calcula automáticamente el valor de la firma. Para su comodidad, le recomendamos que llame a esta operación en OpenAPI Explorer. OpenAPI Explorer genera dinámicamente el código de ejemplo de la operación para diferentes SDK.

Parámetros de solicitud

Parámetro	Tipo	Obligatorio	Ejemplo	Descripción
Action	String	Sí	DescribeImages	La operación que desea ejecutar. Establezca el valor en DescribeImages.
RegionId	String	Sí	cn-hangzhou	El ID de región de la imagen. Puede llamar a la operación DescribeRegions para consultar la lista de regiones más reciente.
Status	String	No	Available	El estado de la imagen. De forma predeterminada, si no especifica este parámetro, solo se devuelven las imágenes en estado Available. Valores válidos: Creating: La imagen se está creando. Waiting: La imagen está en espera de procesamiento. Available: La imagen está disponible. UnAvailable: La imagen no está disponible. CreateFailed: Error en la creación de la imagen. Deprecated: La imagen ya no se utiliza. Valor predeterminado: Available. Puede especificar varios valores para este parámetro. Separe los valores con comas (,).
ImageId	String	No	m-bp1g7004ksh0oeuc****	El ID de la imagen.
ShowExpired	Boolean	No	false	Especifica si la imagen de suscripción ha caducado. Nota Este parámetro se eliminará en el futuro. Le recomendamos que utilice otros parámetros para garantizar la compatibilidad futura.
SnapshotId	String	No	s-bp17ot2q7x72ggtw****	El ID de la instantánea utilizada para crear la imagen personalizada.
ImageName	String	No	testImageName	El nombre de la imagen.
ImageFamily	String	No	hangzhou-daily-update	El nombre de la familia de imágenes. Puede establecer este parámetro para consultar imágenes de la familia de imágenes especificada. Este parámetro está vacío de forma predeterminada. Nota Para obtener información sobre las familias de imágenes asociadas con imágenes públicas proporcionadas por Alibaba Cloud, consulte Overview.
ImageOwnerAlias	String	No	self	El origen de la imagen. Valores válidos: system: una imagen pública proporcionada por Alibaba Cloud que no está disponible en Alibaba Cloud Marketplace. self: una imagen personalizada que usted creó. others: una imagen compartida de otra cuenta de Alibaba Cloud o una imagen comunitaria publicada por un usuario de Alibaba Cloud para que otros miembros de la comunidad de Alibaba Cloud la utilicen. Tenga en cuenta a continuación puntos: Para consultar imágenes comunitarias, debe establecer IsPublic en true. Para consultar imágenes compartidas, debe establecer IsPublic en false o dejar el parámetro IsPublic vacío. marketplace: una imagen publicada por Alibaba Cloud o un proveedor de software independiente (ISV) en Alibaba Cloud Marketplace. Debe adquirir la imagen junto con una instancia de Elastic Compute Service (ECS). Tenga en cuenta los detalles de facturación de las imágenes. Este parámetro está vacío de forma predeterminada. Nota Si deja este parámetro vacío, se consultan imágenes personalizadas, imágenes proporcionadas por Alibaba Cloud, imágenes compartidas e imágenes comunitarias.
InstanceType	String	No	ecs.g5.large	El tipo de instancia para el cual se puede usar la imagen.
IsSupportIoOptimized	Boolean	No	true	Especifica si la imagen se puede usar en instancias optimizadas para E/S.
IsSupportCloudinit	Boolean	No	true	Especifica si la imagen admite cloud-init.
OSType	String	No	linux	El tipo de sistema operativo de la imagen. Valores válidos: windows linux
Architecture	String	No	i386	La arquitectura de la imagen. Valores válidos: i386 x86_64 arm64
PageNumber	Integer	No	1	El número de página. Las páginas comienzan desde la página 1. Valor predeterminado: 1.
PageSize	Integer	No	1	El número de entradas por página. Valores válidos: 1 a 100. Valor predeterminado: 10.
Usage	String	No	instance	Especifica si la imagen se está ejecutando en una instancia de ECS. Valores válidos: instance: La imagen ya está en uso y se ejecuta en una instancia de ECS. none: La imagen no está en uso.
DryRun	Boolean	No	false	Especifica si se realiza solo una ejecución de prueba, sin ejecutar la solicitud real. Valores válidos: true: realiza solo una ejecución de prueba. El sistema comprueba el par de AccessKey, los permisos del usuario de Resource Access Management (RAM) y los parámetros obligatorios. Si la solicitud falla en la ejecución de prueba, se devuelve un mensaje de error. De lo contrario, se devuelve el código de error DryRunOperation. false: realiza una ejecución de prueba y ejecuta la solicitud real. Si la solicitud pasa la ejecución de prueba, se devuelve un código de estado HTTP 2xx y se ejecuta la operación. Valor predeterminado: false.
ActionType	String	No	CreateEcs	El escenario en el que se usa la imagen. Valores válidos: CreateEcs (predeterminado): creación de instancias. ChangeOS: reemplazo del disco del sistema o del sistema operativo.
ResourceGroupId	String	No	rg-bp67acfmxazb4p****	El ID del resource group al que pertenece la imagen personalizada. Si se especifica este parámetro para consultar recursos, se devuelven hasta 1,000 recursos que pertenecen al resource group especificado. Nota Los recursos del resource group predeterminado se muestran en la respuesta independientemente de cómo se configure este parámetro.
Tag.N.key	String	No	null	La clave de la etiqueta N de la imagen. Nota Este parámetro se eliminará en el futuro. Le recomendamos que utilice `Tag.N.Key` para garantizar la compatibilidad futura.
Tag.N.Key	String	No	TestKey	La clave de la etiqueta N de la imagen. Valores válidos de N: 1 a 20. Si se especifica una sola etiqueta para consultar recursos, se devuelven hasta 1,000 recursos que tienen esta etiqueta agregada. Si se especifican varias etiquetas para consultar recursos, se devuelven hasta 1,000 recursos que tienen todas estas etiquetas agregadas. Para consultar más de 1,000 recursos que tienen las etiquetas especificadas, llame a la operación ListTagResources.
Tag.N.Value	String	No	TestValue	El valor de la etiqueta N de la imagen. Valores válidos de N: 1 a 20.
Tag.N.value	String	No	null	El valor de la etiqueta N de la imagen. Nota Este parámetro se eliminará en el futuro. Le recomendamos que utilice `Tag.N.Value` para garantizar la compatibilidad futura.
Filter.N.Key	String	No	CreationStartTime	La clave del filtro N utilizado para consultar recursos. Valores válidos: Si establece este parámetro en `CreationStartTime`, puede consultar los recursos que se crearon después del momento especificado por el parámetro `Filter.N.Value`. Si establece este parámetro en `CreationEndTime`, puede consultar los recursos que se crearon antes del momento especificado por el valor `Filter.N.Value`.
Filter.N.Value	String	No	2017-12-05T22:40Z	El valor del filtro N utilizado para consultar recursos. Establezca el valor al inicio o al final del intervalo de tiempo que desea consultar. Cuando especifique este parámetro, también debe especificar `Filter.N.Key`. Especifique la hora en formato `yyyy-MM-ddTHH:mmZ`. La hora debe estar en UTC.
IsPublic	Boolean	No	false	Especifica si se consultan imágenes comunitarias publicadas. Valores válidos: true: consulta imágenes comunitarias publicadas. Si establece este parámetro en true, debe establecer el parámetro ImageOwnerAlias en others. false: consulta tipos de imagen distintos a las imágenes comunitarias. Los tipos de imagen específicos que se consultarán están determinados por el valor de ImageOwnerAlias. Valor predeterminado: false.
ImageOwnerId	Long	No	1234567890	El ID de la cuenta de Alibaba Cloud a la que pertenece la imagen. Este parámetro solo surte efecto si consulta imágenes compartidas o imágenes comunitarias.

Parámetros de respuesta

Parámetro	Tipo	Ejemplo	Descripción
PageSize	Integer	1	El número de entradas por página.
PageNumber	Integer	1	El número de página.
RequestId	String	66189103-EDB2-43E2-BB60-BFF2B62F4EB8	El ID de la solicitud.
TotalCount	Integer	1	El número total de imágenes.
RegionId	String	cn-hangzhou	El ID de región de la imagen.
Images	Array of Image		La información sobre las imágenes.
Image
CreationTime	String	2019-11-15T06:07:05Z	La hora en que se creó la imagen.
Status	String	Available	El estado de la imagen. Valores válidos: UnAvailable Available Creating CreateFailed
ImageFamily	String	hangzhou-daily-update	El nombre de la familia de imágenes.
Progress	String	100%	El progreso de creación de la imagen. Unidad: porcentaje (%).
IsCopied	Boolean	false	Indica si la imagen es una copia de otra imagen.
IsSupportIoOptimized	Boolean	true	Indica si la imagen se puede usar en instancias optimizadas para E/S.
ImageOwnerAlias	String	self	El origen de la imagen. Valores válidos: system: imágenes públicas proporcionadas por Alibaba Cloud. self: una imagen personalizada que usted creó. others: imágenes compartidas de otras cuentas de Alibaba Cloud o imágenes comunitarias publicadas por otras cuentas de Alibaba Cloud. marketplace: imágenes de Alibaba Cloud Marketplace.
IsSupportCloudinit	Boolean	true	Indica si la imagen admite cloud-init.
ImageVersion	String	2	La versión de la imagen.
Usage	String	none	Indica si la imagen se utilizó para crear instancias de ECS. Valores válidos: instance: La imagen se utilizó para crear una o más instancias de ECS. none: La imagen no se utilizó para crear instancias de ECS.
IsSelfShared	String	true	Indica si la imagen personalizada se compartió con otras cuentas de Alibaba Cloud.
Description	String	Archive log for Oracle	La descripción de la imagen.
Size	Integer	60	El tamaño de la imagen. Unidad: GiB.
ResourceGroupId	String	rg-bp67acfmxazb4p****	El ID del resource group al que pertenece la imagen.
Platform	String	Windows Server 2016	El sistema operativo.
OSNameEn	String	Windows Server 2016 Data Center Edition 64bit Chinese Edition	El nombre para mostrar del sistema operativo en inglés.
ImageName	String	testImageName	El nombre de la imagen.
OSName	String	Windows Server 2016 Datacenter 64-bit (Simplified Chinese)	El nombre para mostrar del sistema operativo en chino.
ImageId	String	m-bp1g7004ksh0oeuc****	El ID de la imagen.
OSType	String	windows	El tipo de sistema operativo. Valores válidos: windows linux
IsSubscribed	Boolean	false	Indica si aceptó los Términos de servicio del servicio de imágenes correspondiente al código de producto.
ProductCode	String	test000****	El código de producto de Alibaba Cloud Marketplace de la imagen.
Architecture	String	x86_64	La arquitectura de la imagen. Valores válidos: i386 x86_64 arm64
BootMode	String	BIOS	El modo de arranque de la imagen. Valores válidos: BIOS UEFI
DiskDeviceMappings	Array of DiskDeviceMapping		Las asignaciones entre discos e instantáneas en la imagen.
DiskDeviceMapping
Type	String	system	El tipo de la imagen.
ImportOSSBucket	String	testEcsImport	El bucket de Object Storage Service (OSS) que contiene el archivo de imagen importado.
Progress	String	32%	El progreso de la tarea de copia de imagen.
SnapshotId	String	s-bp17ot2q7x72ggtw****	El ID de la instantánea.
ImportOSSObject	String	imageImport	El objeto de OSS que corresponde al archivo de imagen importado.
Device	String	/dev/xvda	El nombre del dispositivo del disco. Ejemplo: /dev/xvdb. Nota Este parámetro se eliminará en el futuro. Para garantizar la compatibilidad, le recomendamos que utilice otros parámetros.
Size	String	60	El tamaño del disco. Unidad: GiB.
RemainTime	Integer	233	El tiempo restante de una tarea de copia de imagen. Unidad: segundos.
Format	String	qcow2	El formato de la imagen.
Tags	Array of Tag		Las etiquetas de la imagen.
Tag
TagValue	String	Oracle	El valor de la etiqueta de la imagen.
TagKey	String	DTS	La clave de la etiqueta de la imagen.
IsPublic	Boolean	false	Indica si la imagen está disponible públicamente. Las imágenes disponibles públicamente incluyen imágenes públicas proporcionadas por Alibaba Cloud e imágenes personalizadas publicadas como imágenes comunitarias. Valores válidos: true: La imagen está disponible públicamente. false: La imagen no está disponible públicamente.
ImageOwnerId	Long	1234567890	El ID de la cuenta de Alibaba Cloud a la que pertenece la imagen. Este parámetro solo surte efecto si consulta imágenes compartidas o imágenes comunitarias.
LoginAsNonRootSupported	Boolean	false	Indica si la imagen admite inicios de sesión de usuarios que no son root. Valores válidos: true false
SupplierName	String	TestName	El nombre del proveedor que publicó la imagen comunitaria.
DetectionOptions	Object		Detalles sobre la comprobación realizada en la imagen.
Status	String	Processing	El estado de la tarea de comprobación de imagen. Valores válidos: Processing Finished
Items	Array of Item		Los elementos de comprobación.
Item
Name	String	Nvme	El nombre del elemento de comprobación.
Value	String	Supported	El resultado del elemento de comprobación.
RiskLevel	String	High	La gravedad del riesgo que tiene el elemento de comprobación de la imagen personalizada importada. Si el elemento de comprobación presenta un riesgo, se devuelve este parámetro. Si el elemento de comprobación no presenta riesgos, no se devuelve este parámetro. Valores válidos: High: El elemento de comprobación es un elemento de alto riesgo que puede afectar el inicio de la instancia. Le recomendamos que gestione el riesgo. Medium: El elemento de comprobación es un elemento de riesgo medio que puede afectar el rendimiento de inicio o las configuraciones de la instancia. Le recomendamos que gestione el riesgo.
RiskCode	String	NVMe.NotInstalled	El riesgo que puede tener el elemento de comprobación.
Features	Object		Los atributos de la imagen.
NvmeSupport	String	supported	Indica si la imagen admite el protocolo Non-Volatile Memory Express (NVMe). Valores válidos: supported: La imagen admite el protocolo NVMe. Las instancias creadas a partir de esta imagen también admiten el protocolo NVMe. unsupported: La imagen no admite el protocolo NVMe. Las instancias creadas a partir de esta imagen no admiten el protocolo NVMe.

Ejemplos

Solicitudes de ejemplo

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

Respuestas exitosas de ejemplo

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 error

Código de estado HTTP	Código de error	Mensaje de error	Descripción
400	InvalidImageOwnerAlias.ValueNotSupported	The specified ImageOwnerAlias value is not supported.	Valor de ImageOwnerAlias no válido.
400	InvalidParamter	Invalid Parameter.	Valor de parámetro no válido.
400	InvalidTag.Mismatch	The specified Tag.n.Key and Tag.n.Value are not match.	Los valores Tag.N.Key y Tag.N.Value no se corresponden entre sí.
400	InvalidTagCount	The specified tags are beyond the permitted range.	Se excedió el número máximo de etiquetas especificadas.
400	InvalidInstanceType.ValueNotSupported	The specified InstanceType does not exist or beyond the permitted range.	El tipo de instancia especificado no se encuentra o no tiene autorización para gestionar instancias de este tipo.
403	CurrentAccount.NotSupportPublicImage	Public image is not supported for current account.	La cuenta actual no puede usar imágenes públicas.
404	InvalidFilterKey.NotFound	The specified Filter Key is not found.	Valor de Filter.N.Key no válido.
404	InvalidFilterValue	The specified Filter Value is not valid.	Valor de Filter.N.Value no válido.
404	InvalidUsage	The specified Usage is not valid.	Valor de Usage no válido.
404	InvalidOSType	The specified OSType is not valid.	Valor de OSType no válido.
404	InvalidArchitecture	The specified Architecture is not valid.	Valor de Architecture no válido.
500	InternalError	The request processing has failed due to some unknown error.	Ocurrió un error interno. Inténtelo de nuevo más tarde.

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