DescribeAvailableResource - - Centre de documentation Alibaba Cloud

Notes d'utilisation

La valeur du paramètre DestinationResource détermine si vous devez spécifier des paramètres supplémentaires. Plus la valeur sélectionnée pour DestinationResource est avancée dans la chaîne suivante, plus le nombre de paramètres requis augmente.

Zone > IoOptimized > InstanceType = Network = ddh > SystemDisk > DataDisk
Exemples :
- Vous définissez DestinationResource sur DataDisk.
  - Si vous définissez ResourceType sur disk pour interroger les catégories de disques de données indépendantes des types d'instance ECS, il n'est pas nécessaire de spécifier InstanceType.
  - Si vous définissez ResourceType sur instance pour interroger les catégories de disques de données achetées conjointement avec des instances ECS, vous devez spécifier InstanceType et SystemDiskCategory en raison des limites spécifiques aux types d'instance pour les disques système et les disques de données.
- Si vous définissez DestinationResource sur SystemDisk et ResourceType sur instance, vous devez spécifier InstanceType en raison des limites spécifiques aux types d'instance pour les disques système.
- Si vous définissez DestinationResource sur InstanceType, nous vous recommandons de spécifier IoOptimized et InstanceType.
- Pour interroger les ressources ecs.g5.large disponibles dans toutes les zones de la région Chine (Hangzhou), définissez RegionId sur cn-hangzhou, DestinationResource sur InstanceType, IoOptimized sur optimized et InstanceType sur ecs.g5.large.
- Pour identifier les zones de la région Chine (Hangzhou) où des ressources ecs.g5.large sont disponibles, définissez RegionId sur cn-hangzhou, DestinationResource sur Zone, IoOptimized sur optimized et InstanceType sur ecs.g5.large.

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 des exemples de code pour différents SDK.

Paramètres de requête

Paramètre	Type	Obligatoire	Exemple	Description
Action	String	Oui	DescribeAvailableResource	Nom de l'opération à effectuer. Définissez la valeur sur DescribeAvailableResource.
RegionId	String	Oui	cn-hangzhou	ID de la région. Vous pouvez appeler l'opération DescribeRegions pour obtenir la liste la plus récente des régions.
InstanceChargeType	String	Non	PrePaid	Mode de facturation de la ressource. Pour plus d'informations, consultez la page Présentation de la facturation. Valeurs possibles : PrePaid : abonnement PostPaid : paiement à l'utilisation Valeur par défaut : PostPaid.
SpotStrategy	String	Non	NoSpot	Politique d'enchère pour l'instance préemptible. Valeurs possibles : NoSpot : l'instance est une instance de type paiement à l'utilisation. SpotWithPriceLimit : l'instance est créée en tant qu'instance préemptible avec un prix horaire maximal spécifié. SpotAsPriceGo : l'instance est créée en tant qu'instance préemptible dont le prix est basé sur le prix du marché au moment de l'achat. Le prix du marché peut être égal au prix d'une instance de type paiement à l'utilisation. Valeur par défaut : NoSpot. Ce paramètre prend effet uniquement si vous définissez InstanceChargeType sur PostPaid.
SpotDuration	Integer	Non	1	Période de protection de l'instance préemptible. Unité : heures. Valeur par défaut : 1. Valeurs possibles : 1 : Après la création d'une instance préemptible, Alibaba Cloud garantit que l'instance ne sera pas libérée automatiquement pendant 1 heure. À l'issue de cette période de protection d'une heure, le système compare le prix d'enchère avec le prix du marché et vérifie l'inventaire des ressources pour décider de conserver ou de libérer l'instance. 0 : Après la création d'une instance préemptible, Alibaba Cloud ne garantit pas que l'instance fonctionnera pendant 1 heure. Le système compare le prix d'enchère avec le prix du marché et vérifie l'inventaire des ressources pour décider de conserver ou de libérer l'instance. Alibaba Cloud envoie des événements système ECS pour vous avertir 5 minutes avant la libération de l'instance. Les instances préemptibles sont facturées à la seconde. Nous vous recommandons de définir une période de protection adaptée à vos besoins métier. Remarque Ce paramètre prend effet si vous définissez SpotStrategy sur SpotWithPriceLimit ou SpotAsPriceGo.
DestinationResource	String	Oui	InstanceType	Type de ressource. Valeurs possibles : Zone : zone. IoOptimized : ressource optimisée pour les E/S. InstanceType : type d'instance. SystemDisk : disque système. DataDisk : disque de données. Network : type de réseau. ddh : hôte dédié. Pour plus d'informations sur la manière de spécifier DestinationResource, consultez la section « Notes d'utilisation » de cette rubrique.
ZoneId	String	Non	cn-hangzhou-e	ID de la zone. Par défaut, ce paramètre est vide. Cela indique que le système renvoie les ressources correspondant aux autres conditions dans toutes les zones de la région spécifiée par `RegionId`.
IoOptimized	String	Non	optimized	Indique si l'instance est optimisée pour les E/S. Valeurs possibles : none : l'instance n'est pas optimisée pour les E/S. optimized : l'instance est optimisée pour les E/S. Valeur par défaut : optimized.
DedicatedHostId	String	Non	dh-bp165p6xk2tlw61e****	ID de l'hôte dédié.
InstanceType	String	Non	ecs.g5.large	Type d'instance. Pour plus d'informations, consultez la page Présentation des familles d'instances. Vous pouvez également appeler l'opération DescribeInstanceTypes pour obtenir la liste la plus récente des types d'instances. Pour plus d'informations sur la manière de spécifier InstanceType, consultez la section Notes d'utilisation de cette rubrique.
SystemDiskCategory	String	Non	cloud_ssd	Catégorie du disque système. Valeurs possibles : cloud : disque basique. cloud_efficiency : disque ultra. cloud_ssd : SSD standard. ephemeral_ssd : SSD local. cloud_essd : ESSD. cloud_auto : disque ESSD AutoPL. Valeur par défaut : cloud_efficiency. Remarque Si vous définissez ResourceType sur instance et DestinationResource sur DataDisk, vous devez spécifier SystemDiskCategory. Si vous ne spécifiez pas ce paramètre, la valeur par défaut est utilisée.
DataDiskCategory	String	Non	cloud_ssd	Type de disque de données. Valeurs possibles : cloud : disque basique. cloud_efficiency : disque ultra. cloud_ssd : SSD standard. ephemeral_ssd : SSD local. cloud_essd : ESSD. cloud_auto : disque ESSD AutoPL.
NetworkCategory	String	Non	vpc	Type de réseau. Valeurs possibles : vpc : cloud privé virtuel (VPC). classic : réseau classique.
Cores	Integer	Non	2	Nombre de vCPU du type d'instance. Pour plus d'informations, consultez la page Présentation des familles d'instances. Ce paramètre prend effet uniquement si vous définissez DestinationResource sur InstanceType.
Memory	Float	Non	8.0	Taille de la mémoire du type d'instance. Unité : GiB. Pour plus d'informations, consultez la page Présentation des familles d'instances. Ce paramètre prend effet uniquement si vous définissez DestinationResource sur InstanceType.
ResourceType	String	Non	instance	Type de ressource. Valeurs possibles : instance : instance ECS. disk : disque cloud. reservedinstance : instance réservée. ddh : hôte dédié.
Scope	String	Non	Region	Portée de l'instance réservée. Valeurs possibles : Region : régional. Zone : zonal.

Paramètres de réponse

Parameter	Type	Example	Description
RequestId	String	0041D94C-FB92-4C49-B115-259DA1C*	ID de la requête.
AvailableZones	Array of AvailableZone		Zones interrogées.
AvailableZone
ZoneId	String	cn-hangzhou-e	ID de la zone.
Status	String	Available	Statut des ressources dans la zone. Valeurs possibles : Available SoldOut
StatusCategory	String	WithStock	Catégorie de ressource basée sur le niveau de stock. Valeurs possibles : WithStock : les ressources sont suffisantes. ClosedWithStock : les ressources sont insuffisantes. Nous vous recommandons d'utiliser d'autres ressources disposant d'un stock suffisant. WithoutStock : les ressources sont épuisées et seront réapprovisionnées. Nous vous recommandons d'utiliser d'autres ressources disposant d'un stock suffisant. ClosedWithoutStock : les ressources sont épuisées et ne seront pas réapprovisionnées. Nous vous recommandons d'utiliser d'autres ressources disposant d'un stock suffisant.
RegionId	String	cn-hangzhou	ID de la région.
AvailableResources	Array of AvailableResource		Ressources disponibles dans la zone.
AvailableResource
Type	String	InstanceType	Type de ressource. Valeurs possibles : Zone : zone. IoOptimized : ressource optimisée pour les E/S. InstanceType : type d'instance. SystemDisk : disque système. DataDisk : disque de données. Network : type de réseau. ddh : hôte dédié.
SupportedResources	Array of SupportedResource		Ressources interrogées.
SupportedResource
Status	String	Available	Statut de la ressource. Valeurs possibles : Available SoldOut
Value	String	ecs.d1ne.xlarge	Type de ressource.
Max	Integer	2048	Capacité maximale du disque. Ce paramètre prend effet uniquement si vous définissez DestinationResource sur SystemDisk ou DataDisk.
Unit	String	GiB	Unité de capacité du disque. Ce paramètre prend effet uniquement si vous définissez DestinationResource sur SystemDisk ou DataDisk.
StatusCategory	String	WithStock	Catégorie de ressource basée sur le niveau de stock. Valeurs possibles : WithStock : les ressources sont suffisantes. ClosedWithStock : les ressources sont insuffisantes. Nous vous recommandons d'utiliser d'autres ressources disposant d'un stock suffisant. WithoutStock : les ressources sont épuisées et seront réapprovisionnées. Nous vous recommandons d'utiliser d'autres ressources disposant d'un stock suffisant. ClosedWithoutStock : les ressources sont épuisées et ne seront pas réapprovisionnées. Nous vous recommandons d'utiliser d'autres ressources disposant d'un stock suffisant.
Min	Integer	20	Capacité minimale du disque. Ce paramètre prend effet uniquement si vous définissez DestinationResource sur SystemDisk ou DataDisk.

Exemples

Exemple de requête

https://ecs.aliyuncs.com/?Action=DescribeAvailableResource
&RegionId=cn-hangzhou
&DestinationResource=InstanceType
&IoOptimized=optimized
&InstanceType=ecs.g5.large
&<Common request parameters>

Exemple de réponse réussie

XML format

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

<DescribeAvailableResourceResponse>
    <RequestId>0041D94C-FB92-4C49-B115-259DA1C*****</RequestId>
    <AvailableZones>
        <AvailableZone>
            <Status>Available</Status>
            <RegionId>cn-hangzhou</RegionId>
            <AvailableResources>
                <AvailableResource>
                    <Type>InstanceType</Type>
                    <SupportedResources>
                        <SupportedResource>
                            <Status>Available</Status>
                            <Value>ecs.g5.large</Value>
                            <StatusCategory>WithStock</StatusCategory>
                        </SupportedResource>
                    </SupportedResources>
                </AvailableResource>
            </AvailableResources>
            <ZoneId>cn-hangzhou-i</ZoneId>
            <StatusCategory>WithStock</StatusCategory>
        </AvailableZone>
    </AvailableZones>
</DescribeAvailableResourceResponse>

JSON format

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

{
  "RequestId" : "0041D94C-FB92-4C49-B115-259DA1C*****",
  "AvailableZones" : {
    "AvailableZone" : [ {
      "Status" : "Available",
      "RegionId" : "cn-hangzhou",
      "AvailableResources" : {
        "AvailableResource" : [ {
          "Type" : "InstanceType",
          "SupportedResources" : {
            "SupportedResource" : [ {
              "Status" : "Available",
              "Value" : "ecs.g5.large",
              "StatusCategory" : "WithStock"
            } ]
          }
        } ]
      },
      "ZoneId" : "cn-hangzhou-i",
      "StatusCategory" : "WithStock"
    } ]
  }
}

Codes d'erreur

HttpCode	Error code	Error message	Description
400	Invalid.InstanceChargeType	The specified InstanceChargeType is not valid.	Valeur InstanceChargeType non valide.
400	Invalid.Param	The input parameter DestinationResource that is mandatory for processing this request is not supplied.	Valeur DestinationResource non valide.
400	InvalidRegionId.MalFormed	The specified parameter RegionId is not valid.	Valeur RegionId non valide.
403	InvalidDedicatedHostId.NotFound	The specified DedicatedHostId does not exist.	Valeur DedicatedHostId non valide.
404	Invalid.RegionId	The specified RegionId does not exist.	Valeur RegionId non valide.
404	Unavailable.Regions	The available regions does not exists	Valeur RegionId non valide.
404	Invalid.ResourceType	The ResourceType provided does not exist in our records.	Valeur ResourceType non valide.
404	Invalid.DestinationResource	The specified DestinationResource is not valid.	Valeur DestinationResource non valide.
404	Invalid.IoOptimized	The specified IoOptimized is not valid.	Valeur IoOptimized non valide.
404	Invalid.NetworkCategory	The specified NetworkCategory is not valid.	Valeur NetworkCategory non valide.
404	Invalid.SpotStrategy	The specified SpotStrategy is not valid.	Valeur SpotStrategy non valide.
404	Invalid.NetworkType	The specified NetworkType is not valid.	Valeur NetworkType non valide.
404	InvalidResourceId.NotFound	The specified ResourceId is not found in our records	Valeur ResourceId non valide. Vérifiez si la ressource existe.

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