DescribeImageFromFamily - - Centre de documentation Alibaba Cloud

Notes d'utilisation

Si aucune image n'est disponible dans une famille d'images spécifique, la réponse est vide.

Débogage

OpenAPI Explorer calcule automatiquement la valeur de signature. Pour plus de commodité, nous vous recommandons d'appeler cette opération dans OpenAPI Explorer. OpenAPI Explorer génère dynamiquement l'exemple de code de l'opération pour différents SDK.

Paramètres de requête

Paramètre

Type

Obligatoire

Exemple

Description

Action

String

Oui

DescribeImageFromFamily

L'opération à effectuer. Définissez la valeur sur DescribeImageFromFamily.

RegionId

String

Oui

cn-hangzhou

L'ID de région de l'image. Appelez l'opération DescribeRegions pour obtenir la liste des régions la plus récente.

ImageFamily

String

Oui

hangzhou-daily-update

Le nom de la famille d'images.

Vous pouvez configurer des familles d'images pour les images personnalisées, les images publiques, les images communautaires et les images partagées. Pour plus d'informations, consultez la rubrique Présentation.

Paramètres de réponse

Paramètre	Type	Exemple	Description
RequestId	String	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E	L'ID de la requête.
Image	Object		Les informations relatives à l'image.
CreationTime	String	2018-01-10T01:01:10Z	La date et l'heure de création de l'image.
Status	String	Available	L'état de l'image. Valeurs possibles : UnAvailable Available Creating CreateFailed
ImageFamily	String	testImageFamily	Le nom de la famille d'images.
Progress	String	100	La progression de la création de l'image, en pourcentage (%).
IsCopied	Boolean	false	Indique si l'image est une copie d'une autre image.
IsSupportIoOptimized	Boolean	true	Indique si l'image peut être utilisée sur des instances optimisées pour les E/S.
ImageOwnerAlias	String	self	L'alias du propriétaire de l'image. Valeurs possibles : system : images publiques fournies par Alibaba Cloud self : vos images personnalisées others : images partagées provenant d'autres comptes Alibaba Cloud marketplace : images Alibaba Cloud Marketplace
IsSupportCloudinit	Boolean	true	Indique si l'image prend en charge cloud-init.
ImageVersion	String	2	La version de l'image.
Usage	String	none	Indique si l'image est utilisée pour créer des instances ECS. Valeurs possibles : instance : L'image est utilisée pour créer une ou plusieurs instances ECS. none : L'image n'est pas utilisée pour créer des instances ECS.
IsSelfShared	String	true	Indique si l'image personnalisée a été partagée avec d'autres comptes Alibaba Cloud.
Description	String	testDescription	La description.
Size	Integer	80	La taille de l'image, en GiB.
Platform	String	Aliyun	La plateforme du système d'exploitation.
ImageName	String	testImageName	Le nom de l'image.
OSName	String	Alibaba Cloud Linux 2.1903	Le nom d'affichage en chinois du système d'exploitation.
ImageId	String	m-bp1g7004ksh0oeuc****	L'ID de l'image.
OSType	String	linux	Le type de système d'exploitation. Valeurs possibles : windows linux
IsSubscribed	Boolean	false	Indique si vous avez accepté les conditions de service du produit d'image correspondant au code de produit.
ProductCode	String	jxsc00****	Le code de produit de l'image Alibaba Cloud Marketplace.
Architecture	String	x86_64	L'architecture de l'image. Valeurs possibles : i386 x86_64
DiskDeviceMappings	Array of DiskDeviceMapping		Les mappages entre les disques et les snapshots dans l'image.
DiskDeviceMapping
Type	String	custom	Le type de l'image.
ImportOSSBucket	String	testEcsImport	Le bucket Object Storage Service (OSS) qui contient le fichier d'image importé.
SnapshotId	String	s-bp17ot2q7x72ggtw****	L'ID du snapshot.
ImportOSSObject	String	imageImport	L'objet OSS correspondant au fichier d'image importé.
Size	String	80	La taille du disque, en GiB.
Device	String	/dev/xvdb	Le nom de périphérique du disque. Exemple : /dev/xvdb. Remarque Ce paramètre sera obsolète. Nous vous recommandons d'utiliser d'autres paramètres pour assurer la compatibilité.
Format	String	qcow2	Le format de l'image.
Tags	Array of Tag		Les tags de l'image.
Tag
TagValue	String	TestValue	La valeur du tag de l'image personnalisée.
TagKey	String	TestKey	La clé du tag de l'image personnalisée.

Exemples

Exemples de requêtes

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

Exemples de réponses réussies

Format 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 format

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" : [ ]
    }
  }
}

Codes d'erreur

Code d'état HTTP

Code d'erreur

Message d'erreur

Description

404

InvalidRegionId.NotFound

The RegionId provided does not exist.

Le RegionId est introuvable.

Pour obtenir la liste des codes d'erreur, consultez la page Codes d'erreur de service.