DescribeImageFromFamily - Elastic Compute Service - Centre de documentation Alibaba Cloud

Consulte les images personnalisées disponibles les plus récemment créées dans une famille d'images spécifique.

Description de l'opération

Notes d'utilisation

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

Testez maintenant

Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale. Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale.

Test

Autorisation RAM

Le tableau ci-dessous décrit les autorisations nécessaires pour appeler cette API. Vous pouvez les définir dans une politique Resource Access Management (RAM). Les colonnes du tableau sont détaillées ci-dessous :

Action : les actions peuvent être utilisées dans l'élément Action des instructions de politique de permissions RAM pour accorder les autorisations nécessaires à l'exécution de l'opération.
API : l'API que vous pouvez appeler pour exécuter l'action.
Niveau d'accès : le niveau d'accès prédéfini accordé pour chaque API. Valeurs valides : create, list, get, update et delete.
Type de ressource : le type de ressource qui prend en charge l'autorisation pour exécuter l'action. Il indique si l'action prend en charge les permissions au niveau de la ressource. La ressource spécifiée doit être compatible avec l'action. Sinon, la politique sera inefficace.
- Pour les API avec permissions au niveau de la ressource, les types de ressource requis sont marqués d'un astérisque (*). Spécifiez l'Alibaba Cloud Resource Name (ARN) correspondant dans l'élément Resource de la politique.
- Pour les API sans permissions au niveau de la ressource, la valeur All Resources est affichée. Utilisez un astérisque (*) dans l'élément Resource de la politique.
Clé de condition : les clés de condition définies par le service. La clé permet un contrôle granulaire, applicable aux actions seules ou aux actions associées à des ressources spécifiques. En plus des clés de condition propres au service, Alibaba Cloud fournit un ensemble de clés de condition communes applicables à tous les services pris en charge par RAM.
Action dépendante : les actions dépendantes requises pour exécuter l'action. Pour mener à bien l'opération, l'utilisateur RAM ou le rôle RAM doit disposer des permissions pour toutes les actions dépendantes.

ecs:DescribeImageFromFamily

get

*All Resource

*

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
RegionId	string	Oui	L'identifiant de la région dans laquelle créer l'image personnalisée. Vous pouvez appeler l'opération DescribeRegions pour interroger la liste des régions la plus récente.	cn-hangzhou
ImageFamily	string	Oui	Le nom de la famille de l'image que vous souhaitez utiliser pour créer les instances. 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 Présentation des familles d'images.	hangzhou-daily-update

Éléments de réponse

Élément	Type	Description	Exemple
	object
RequestId	string	L'identifiant de la requête.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
Image	object	Les informations de l'image.
CreationTime	string	L'heure de création de l'image.	2018-01-10T01:01:10Z
Status	string	L'état de l'image. Valeurs valides : UnAvailable Available Creating CreateFailed	Available
ImageFamily	string	Le nom de la famille d'images.	testImageFamily
Progress	string	La progression de la création de l'image en pourcentage.	100
IsCopied	boolean	Indique si l'image est une copie d'une autre image.	false
IsSupportIoOptimized	boolean	Indique si l'image peut être utilisée sur des instances optimisées pour les E/S.	true
ImageOwnerAlias	string	L'alias du propriétaire de l'image. Valeurs valides : system : images publiques fournies par Alibaba Cloud self : vos images personnalisées others : images partagées provenant d'autres comptes Alibaba Cloud marketplace : images de la place de marché Alibaba Cloud	self
IsSupportCloudinit	boolean	Indique si cloud-init est pris en charge.	true
ImageVersion	string	La version de l'image.	2
Usage	string	Indique si l'image a été utilisée pour créer des instances ECS. Valeurs valides : instance : l'image a été utilisée pour créer une ou plusieurs instances ECS. none : l'image n'a pas été utilisée pour créer des instances ECS.	none
IsSelfShared	string	Indique si l'image personnalisée a été partagée avec d'autres comptes Alibaba Cloud.	true
Description	string	La description du volume.	testDescription
Size	integer	La taille de l'image. Unité : GiB.	80
Platform	string	Le système d'exploitation.	Aliyun
ImageName	string	Le nom de l'image.	testImageName
OSName	string	Le nom d'affichage du système d'exploitation en chinois.	Alibaba Cloud Linux 2.1903
ImageId	string	L'identifiant de l'image.	m-bp1g7004ksh0oeuc****
OSType	string	Le type de système d'exploitation. Valeurs valides : windows linux	linux
IsSubscribed	boolean	Indique si vous avez souscrit aux conditions de service du produit d'image correspondant au code du produit d'image.	false
ProductCode	string	Le code produit de l'image de la place de marché Alibaba Cloud.	jxsc00****
Architecture	string	L'architecture de l'image. Valeurs valides : i386 x86_64	x86_64
DiskDeviceMappings	object
DiskDeviceMapping	array<object>	The mappings between disks and snapshots in the image.
	object
Type	string	The type of the image.	custom
ImportOSSBucket	string	The OSS bucket that contains the imported image.	testEcsImport
SnapshotId	string	The snapshot ID.	s-bp17ot2q7x72ggtw****
ImportOSSObject	string	The OSS object that corresponds to the imported image.	imageImport
Size	string	The size of the disk. Unit: GiB.	80
Device	string	The device name of the disk, such as /dev/xvdb. Remarque This parameter will be deprecated. To ensure code compatibility, do not use this parameter.	/dev/xvdb
Format	string	The format of the image.	qcow2
Tags	object
Tag	array<object>	The tag key-value pairs of the image.
	object
TagValue	string	The tag value of the custom image.	TestValue
TagKey	string	The tag key of the custom image.	TestKey

Exemples

JSON format

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "Image": {
    "CreationTime": "2018-01-10T01:01:10Z",
    "Status": "Available",
    "ImageFamily": "testImageFamily",
    "Progress": "100",
    "IsCopied": false,
    "IsSupportIoOptimized": true,
    "ImageOwnerAlias": "self",
    "IsSupportCloudinit": true,
    "ImageVersion": "2",
    "Usage": "none",
    "IsSelfShared": "true",
    "Description": "testDescription",
    "Size": 80,
    "Platform": "Aliyun",
    "ImageName": "testImageName",
    "OSName": "Alibaba Cloud Linux 2.1903",
    "ImageId": "m-bp1g7004ksh0oeuc****",
    "OSType": "linux",
    "IsSubscribed": false,
    "ProductCode": "jxsc00****",
    "Architecture": "x86_64",
    "DiskDeviceMappings": {
      "DiskDeviceMapping": [
        {
          "Type": "custom",
          "ImportOSSBucket": "testEcsImport",
          "SnapshotId": "s-bp17ot2q7x72ggtw****",
          "ImportOSSObject": "imageImport",
          "Size": "80",
          "Device": "/dev/xvdb",
          "Format": "qcow2"
        }
      ]
    },
    "Tags": {
      "Tag": [
        {
          "TagValue": "TestValue",
          "TagKey": "TestKey"
        }
      ]
    }
  }
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
403	InvalidUser.Unauthorized	The user is not authorized.
404	InvalidRegionId.NotFound	The RegionId provided does not exist.	The specified region does not exist.

Consultez Codes d'erreur pour la liste complète.

Notes de version

Consultez Notes de version pour la liste complète.