DescribeElasticityAssurances - Elastic Compute Service - Centre de documentation Alibaba Cloud

Consulte les détails d'une assurance d'élasticité. Par exemple, vous pouvez consulter l'état, le mode de correspondance, le mode d'effet, l'heure d'expiration et le nombre d'instances utilisées d'une assurance d'élasticité.

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:DescribeElasticityAssurances

get

*ElasticityAssurance.

acs:ecs:{#regionId}:{#accountId}:elasticityassurance/*

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
RegionId	string	Oui	L'identifiant de la région à laquelle l'assurance d'élasticité appartient. Vous pouvez appeler DescribeRegions pour consulter la liste des régions la plus récente.	cn-hangzhou
ResourceGroupId	string	Non	L'identifiant du groupe de ressources. Lorsque vous utilisez ce paramètre pour filtrer les ressources, le nombre de ressources ne peut pas dépasser 1 000. Remarque Le filtrage par le groupe de ressources par défaut n'est pas pris en charge.	rg-bp67acfmxazb4p****
Tag	array<object>	Non	La liste des paires clé-valeur de balise liées à l'assurance d'élasticité.
	object	Non	Les informations de balise.
Key	string	Non	La clé de balise. N indique que vous pouvez définir plusieurs clés de balise pour le filtrage. Valeurs valides de N : 1 à 20. Si vous utilisez une seule balise pour filtrer les ressources, le nombre de ressources portant cette balise ne peut pas dépasser 1 000. Si vous utilisez plusieurs balises pour filtrer les ressources, le nombre de ressources auxquelles toutes les balises spécifiées sont attachées ne peut pas dépasser 1 000. Si le nombre de ressources dépasse 1 000, appelez l'opération ListTagResources pour consulter les ressources.	TestKey
Value	string	Non	La valeur de balise. N indique que vous pouvez spécifier plusieurs clés de balise pour le filtrage. Valeurs valides de N : 1 à 20.	TestValue
MaxResults	integer	Non	Le nombre maximal d'entrées par page pour une requête paginée. Valeur maximale : 100. Valeur par défaut : 10.	10
NextToken	string	Non	Le jeton de pagination pour la requête d'assurance d'élasticité. Obtenez la valeur à partir du résultat de la requête précédente.	caeba0bbb2be03f84eb48b699f0a4883
PrivatePoolOptions.Ids	string	Non	La liste des identifiants d'assurance d'élasticité. La valeur peut être un tableau JSON composé de jusqu'à 100 identifiants. Séparez les identifiants multiples par des virgules (,).	["eap-bp67acfmxazb4**", "eap-bp67acfmxazb5**"]
Platform	string	Non	Remarque Ce paramètre est obsolète.	null
InstanceType	string	Non	Le type d'instance. Vous pouvez utiliser le type d'instance pour consulter uniquement les assurances d'élasticité actives. Les assurances d'élasticité libérées ne peuvent être consultées qu'en utilisant PrivatePoolOptions.Ids.	ecs.c6.large
ZoneId	string	Non	L'identifiant de la zone dans la région à laquelle l'assurance d'élasticité appartient.	cn-hangzhou-h
InstanceChargeType	string	Non	Le mode de facturation de l'instance. Valeurs valides : PostPaid. Seul le mode postpayé est pris en charge. Valeur par défaut : PostPaid.	PostPaid
Status	string	Non	L'état de l'assurance d'élasticité. Valeurs valides : All : tous les états. Deactived : à activer. Cet état est en avant-première sur invitation. Preparing : en cours de préparation. Prepared : prêt à prendre effet. Active : en vigueur. Released : libéré. Si vous ne spécifiez pas ce paramètre, les assurances d'élasticité dans tous les états sauf Pending et Released sont consultées.	Active
PackageType	string	Non	Le type de l'assurance d'élasticité. Valeurs valides : ElasticityAssurance : assurance d'élasticité standard. Il s'agit du type lorsque RecurrenceRules n'est pas spécifié. TimeDivisionElasticityAssurance : assurance d'élasticité à division temporelle. Il s'agit du type lorsque RecurrenceRules est spécifié.	ElasticityAssurance

Éléments de réponse

Élément	Type	Description	Exemple
	object
NextToken	string	Le jeton de pagination pour la requête suivante.	caeba0bbb2be03f84eb48b699f0a4883
RequestId	string	L'identifiant de la requête.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
TotalCount	integer	Le nombre total d'entrées qui correspondent aux conditions de la requête.	1
MaxResults	integer	Le nombre maximal d'entrées par page pour l'assurance d'élasticité.	10
ElasticityAssuranceSet	object
ElasticityAssuranceItem	array<object>	La collection des détails de l'assurance d'élasticité.
	array<object>	Les détails de l'assurance d'élasticité.
Status	string	L'état de l'assurance d'élasticité. Valeurs valides : Preparing : en cours de préparation. Prepared : prêt à prendre effet. Active : en vigueur. Released : libéré.	Active
PrivatePoolOptionsMatchCriteria	string	Le mode de correspondance de l'assurance d'élasticité. Valeurs valides : Open : mode ouvert. Le système fait automatiquement correspondre la capacité des pools privés ouverts lorsque des instances sont démarrées. Si aucune capacité de pool privé correspondante n'est disponible, les ressources du pool public sont utilisées pour démarrer les instances. Target : mode ciblé. Les instances sont démarrées en utilisant la capacité du pool privé spécifié. Si la capacité du pool privé spécifié n'est pas disponible, le démarrage des instances échoue.	Target
PrivatePoolOptionsId	string	L'identifiant de l'assurance d'élasticité.	eap-bp1ir35kqtn8ywci****
UsedAssuranceTimes	integer	Remarque Ce paramètre n'est pas disponible publiquement.	0
LatestStartTime	string	Remarque Ce paramètre n'est pas disponible publiquement.	null
PrivatePoolOptionsName	string	Le nom de service de l'assurance d'élasticité.	eapTestName
RegionId	string	L'identifiant de la région à laquelle l'assurance d'élasticité appartient.	cn-hangzhou
EndTime	string	L'heure d'expiration de l'assurance d'élasticité. L'heure est au format ISO 8601 en temps UTC.	2021-12-03T16:00Z
StartTime	string	L'heure de prise d'effet de l'assurance d'élasticité. L'heure est au format ISO 8601 en temps UTC.	2020-12-03T05:25Z
Description	string	La description de l'assurance d'élasticité.	Ceci est une description
ResourceGroupId	string	L'identifiant du groupe de ressources.	rg-bp67acfmxazb4p****
TotalAssuranceTimes	string	Le nombre total de fois où l'assurance d'élasticité est appliquée. Actuellement, seul le mode illimité pendant la période d'effet est pris en charge.	Unlimited
AllocatedResources	object
AllocatedResource	array<object>	La liste des détails d'allocation des ressources.
	array<object>	Les détails d'allocation des ressources.
UsedAmount	integer	Le nombre d'instances utilisées.	2
TotalAmount	integer	Le nombre total d'instances à réserver pour un seul type d'instance.	2
AvailableAmount	integer	Remarque Ce paramètre n'est pas disponible publiquement.	5
FailedAmount	integer	La capacité en échec.	1
LockedAmount	integer	La capacité verrouillée.	1
zoneId	string	L'identifiant de la zone dans la région à laquelle l'assurance d'élasticité appartient.	cn-hangzhou-h
InstanceType	string	Le type de l'instance.	ecs.c6.large
ElasticityAssuranceUsages	object
ElasticityAssuranceUsage	array<object>	Remarque Ce paramètre n'est pas disponible publiquement.
	object	Remarque Ce paramètre n'est pas disponible publiquement.
AccountId	string	Remarque Ce paramètre n'est pas disponible publiquement.	1144775968548340
ServiceName	string	Remarque Ce paramètre n'est pas disponible publiquement.	name
UsedAmount	integer	Remarque Ce paramètre n'est pas disponible publiquement.	1
Tags	object
Tag	array<object>	La liste des paires clé-valeur de balise liées à l'assurance d'élasticité.
	object	Les paires clé-valeur des balises associées à l'assurance d'élasticité.
TagValue	string	La valeur de la balise.	TestValue
TagKey	string	La clé de la balise.	TestKey
InstanceChargeType	string	Le mode de facturation de l'instance. Actuellement, seul le mode postpayé est pris en charge. Valeurs valides : PostPaid.	PostPaid
StartTimeType	string	Le mode de prise d'effet de l'assurance d'élasticité. Valeurs valides : Now : prend effet immédiatement. Later : prend effet à une heure spécifiée.	Now
ElasticityAssuranceOwnerId	string	Remarque Ce paramètre n'est pas disponible publiquement.	e114477596854834
RecurrenceRules	object
RecurrenceRule	array<object>	La liste des règles de récurrence pour l'assurance d'élasticité à division temporelle.
	object	La règle de récurrence pour l'assurance d'élasticité à division temporelle.
RecurrenceType	string	Le type de stratégie de la règle de récurrence. Valeurs valides : Daily : récurrence quotidienne. Weekly : récurrence hebdomadaire. Monthly : récurrence mensuelle.	Daily
RecurrenceValue	string	La valeur de la règle de récurrence. Valeurs valides : Si RecurrenceType est défini sur Daily, une seule valeur peut être spécifiée. Valeurs valides : 1 à 31. La valeur indique l'intervalle en jours. Si RecurrenceType est défini sur Weekly, plusieurs valeurs peuvent être spécifiées et séparées par des virgules (,). Les valeurs pour dimanche, lundi, mardi, mercredi, jeudi, vendredi et samedi sont 0, 1, 2, 3, 4, 5 et 6. Par exemple, `1,2` indique lundi et mardi. Si RecurrenceType est défini sur Monthly, le format est `A-B`. Valeurs valides de A et B : 1 à 31. B doit être supérieur ou égal à A. Par exemple, `1-5` indique du 1er au 5ème jour de chaque mois.	1
StartHour	integer	L'heure de prise d'effet de l'assurance à division temporelle.	4
EndHour	integer	L'heure de fin de l'assurance à division temporelle.	10
PackageType	string	Le type de l'assurance d'élasticité. Valeurs valides : ElasticityAssurance : assurance d'élasticité standard. TimeDivisionElasticityAssurance : assurance d'élasticité à division temporelle.	ElasticityAssurance

Exemples

JSON format

{
  "NextToken": "caeba0bbb2be03f84eb48b699f0a4883",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "TotalCount": 1,
  "MaxResults": 10,
  "ElasticityAssuranceSet": {
    "ElasticityAssuranceItem": [
      {
        "Status": "Active",
        "PrivatePoolOptionsMatchCriteria": "Target",
        "PrivatePoolOptionsId": "eap-bp1ir35kqtn8ywci****",
        "UsedAssuranceTimes": 0,
        "LatestStartTime": "null",
        "PrivatePoolOptionsName": "eapTestName",
        "RegionId": "cn-hangzhou",
        "EndTime": "2021-12-03T16:00Z",
        "StartTime": "2020-12-03T05:25Z",
        "Description": "Ceci est une description",
        "ResourceGroupId": "rg-bp67acfmxazb4p****",
        "TotalAssuranceTimes": "Unlimited",
        "AllocatedResources": {
          "AllocatedResource": [
            {
              "UsedAmount": 2,
              "TotalAmount": 2,
              "AvailableAmount": 5,
              "FailedAmount": 1,
              "LockedAmount": 1,
              "zoneId": "cn-hangzhou-h",
              "InstanceType": "ecs.c6.large",
              "ElasticityAssuranceUsages": {
                "ElasticityAssuranceUsage": [
                  {
                    "AccountId": "1144775968548340",
                    "ServiceName": "name",
                    "UsedAmount": 1
                  }
                ]
              }
            }
          ]
        },
        "Tags": {
          "Tag": [
            {
              "TagValue": "TestValue",
              "TagKey": "TestKey"
            }
          ]
        },
        "InstanceChargeType": "PostPaid",
        "StartTimeType": "Now",
        "ElasticityAssuranceOwnerId": "e114477596854834",
        "RecurrenceRules": {
          "RecurrenceRule": [
            {
              "RecurrenceType": "Daily",
              "RecurrenceValue": "1",
              "StartHour": 4,
              "EndHour": 10
            }
          ]
        },
        "PackageType": "ElasticityAssurance"
      }
    ]
  }
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
400	MissingParameter.RegionId	The specified RegionId should not be null.	Le paramètre RegionId ne peut pas être vide.
400	InvalidParameter.Name	The specified PrivatePoolOptions.Name is invalid.
400	InvalidParameter.PrivatePoolOptions.Ids	The specified PrivatePoolOptions.Ids is invalid.
400	DedicatedHostNotSupported	DedicatedHost is not supported for PrivatePool.	Les pools privés ne prennent pas en charge les hôtes dédiés.
400	SpotNotSupported	Spot is not supported for PrivatePool.	Les pools privés ne prennent pas en charge les instances spot.
400	ClassicNetworkNotSupported	Classic network is not supported for PrivatePool.	Les pools privés ne prennent pas en charge les instances de type réseau classique.
400	Invalid.InstanceId	Instance does not exist.	L'instance ne correspond à aucun pool privé.
400	Invalid.PrivatePoolOptions.MatchCriteria	Target mode does not support this operation.	Le paramètre PrivatePoolOptions.MatchCriteria spécifié ne correspond pas au pool privé.
400	MissingParameter.PrivatePoolOptions.Id	The specified PrivatePoolOptions.Id should not be null.	Le paramètre PrivatePoolOptions.Id ne peut pas être vide.
400	Invalid.PrivatePoolOptions.Id	The PrivatePool does not exist.	Le pool privé n'existe pas.
400	Invalid.InstanceType	The InstanceType does not match the PrivatePool.	Le type d'instance ne correspond pas au pool privé.
400	Invalid.InstanceChargeType	The InstanceChargeType does not match the PrivatePool.	Le paramètre InstanceChargeType spécifié n'est pas valide.
400	Invalid.ZoneId	The ZoneId does not match the PrivatePool.	La zone ne correspond pas au pool privé.
400	Invalid.PrivatePoolOptions.status	The PrivatePool has been used up.	L'état du pool privé spécifié n'est pas valide.
400	InvalidPlatform.ValueNotSupported	The Platform does not match the PrivatePool.	Le paramètre Platform spécifié ne correspond pas au pool privé.
400	InvalidAliUid	The PrivatePool does not belong to the user of the Instance.	Le pool privé n'appartient pas à l'utilisateur qui crée l'instance.
400	MissingParameter.PackageType	The specified parameter "PackageType" can not be empty.	Le paramètre PackageType ne peut pas être vide.
400	MissingParameter.PrivatePoolOptions.Ids	The specified parameter "PrivatePoolOptions.Ids" can not be empty.	Le paramètre spécifié PrivatePoolOptions.ids ne peut pas être vide.
400	MissingParameter.InstanceCpuCoreCount	The specified parameter "InstanceCpuCoreCount" can not be empty.	Le paramètre spécifié InstanceCpuCocount ne peut pas être vide.
400	MissingParameter.InstanceAmount	The specified parameter "InstanceAmount" can not be empty.	Le paramètre spécifié InstanceAmount ne peut pas être vide.
400	MissingParameter.InstanceCpuCoreCountOrInstanceAmount	The specified parameter "InstanceCpuCoreCount" and "InstanceAmount" must not be empty at the same time.	Les paramètres InstanceCpuCoreCount et InstanceAmount ne peuvent pas être tous les deux vides.
400	Invalid.TooManyPrivatePoolOptions.Ids	Too many PrivatePoolOptions.Ids in this request.	Le nombre de PrivatePoolOptions.Ids dépasse la limite supérieure.
400	Invalid.TooManyZoneIds	Too many ZoneIds in the request.	Le nombre de ZoneIds dépasse la limite supérieure.
400	Invalid.TooManyInstanceTypes	Too many InstanceTypes in the request.	Le nombre d'InstanceTypes dépasse la limite supérieure.
400	Invalid.TooManyUnpaidPrivatePool	Too many PrivatePools create but still unpaid.	Plusieurs pools privés ne sont pas payés.
400	Invalid.InstanceCpuCoreCountOrInstanceAmount	Both InstanceCpuCoreCount and InstanceAmount are provided.	Les paramètres InstanceCpuCoreCount et InstanceAmount n'ont pas besoin d'être spécifiés en même temps.
400	Invalid.PrivatePoolOptions.Ids	The specified parameter "PrivatePoolOptions.Ids" exist invalid element Id.	L'identifiant de pool privé spécifié n'existe pas.
400	Invalid.PackageType	The specified parameter "PackageType" is invalid.	Le paramètre PackageType spécifié n'est pas valide.
400	Invalid.PrivatePool.Purchase	The PrivatePool has already paid.	Le pool privé est déjà payé.
400	Invalid.AssuranceTimes.NotSupported	The value of AssuranceTimes is not supported.	La valeur du paramètre AssuranceTimes n'est pas prise en charge.
400	RepeatStartPrivatePool	PrivatePool has already been started.	Le pool privé est déjà démarré.
500	InternalError	The request processing has failed due to some unknown error, exception or failure.	Une erreur interne s'est produite. Réessayez.
404	InvalidResourceGroup.NotFound	The specified resource group is not found.	Le groupe de ressources est introuvable dans les enregistrements.

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

Notes de version

Consultez Notes de version pour la liste complète.