EvaluateResource - - Centre de documentation Alibaba Cloud

Évalue la disponibilité des ressources avant d'acheter une nouvelle instance ou de modifier la configuration d'une instance existante.

Description de l'opération

Évalue la disponibilité des ressources pour les instances de jeu de réplicas MongoDB et les instances de cluster fragmenté. Les scénarios pris en charge incluent l'achat d'une nouvelle instance, la modification de la configuration d'une instance et l'ajout de nœuds à un cluster fragmenté.

Remarque

Vous pouvez appeler cette opération jusqu'à 200 fois par minute. Les appels qui dépassent cette limite sont soumis à une limitation du trafic.

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.

dds:EvaluateResource

none

*All Resource

*

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
RegionId	string	Oui	L'identifiant de la région. Pour plus d'informations, consultez DescribeRegions.	cn-hangzhou
ZoneId	string	Oui	L'identifiant de la zone. Pour plus d'informations, consultez DescribeRegions.	cn-hangzhou-h
Engine	string	Non	Le moteur de base de données. Définissez la valeur sur MongoDB.	MongoDB
EngineVersion	string	Oui	La version du moteur de base de données.	4.2
DBInstanceClass	string	Non	Le type d'instance. Remarque Ce paramètre est requis lorsque vous évaluez les ressources pour une instance de jeu de réplicas. Pour plus de détails sur les types d'instances, consultez Types d'instances.	dds.mongo.mid
ShardsInfo	string	Non	Les informations sur les fragments du cluster fragmenté. Ce paramètre est requis lorsque vous évaluez les ressources pour une instance de cluster fragmenté. Pour évaluer les ressources pour une nouvelle instance de cluster fragmenté, spécifiez le type d'instance pour chaque fragment dans une chaîne JSON. Exemple : `{ "ConfigSvrs": [{"Storage":20,"DBInstanceClass":"dds.cs.mid"}], "Mongos": [{"DBInstanceClass":"dds.mongos.standard"},{"DBInstanceClass":"dds.mongos.standard"}], "Shards": [{"Storage":50,"DBInstanceClass":"dds.shard.standard"},{"Storage":50,"DBInstanceClass":"dds.shard.standard"}, {"Storage":50,"DBInstanceClass":"dds.shard.standard"}] }` Les paramètres de l'exemple sont décrits comme suit : ConfigSvrs : les nœuds ConfigServer. Mongos : les nœuds Mongos. Shards : les nœuds de fragment. Storage : l'espace de stockage du fragment cible. DBInstanceClass : le type d'instance du fragment cible. Pour plus de détails sur les types d'instances, consultez Types d'instances de cluster fragmenté. Pour évaluer les ressources pour la mise à niveau ou la rétrogradation d'une instance de cluster fragmenté, spécifiez uniquement les informations de nœud dans une chaîne JSON. Exemple : `{ "NodeId": "d-bp147c4d9ca7****", "NodeClass": "dds.shard.standard" }` Les paramètres de l'exemple sont décrits comme suit : NodeId : l'identifiant du nœud cible. NodeClass : le type d'instance du nœud cible. Pour plus de détails sur les types d'instances, consultez Types d'instances de cluster fragmenté.	{"NodeId": "d-bp147c4d9ca7****", "NodeClass": "dds.shard.standard"}
DBInstanceId	string	Non	L'identifiant de l'instance. Ce paramètre est requis lorsque vous évaluez les ressources pour une mise à niveau ou une rétrogradation d'instance.	dds-bp14bf67a76d****
ReplicationFactor	string	Non	Le nombre de nœuds dans l'instance. Définissez la valeur sur 1 pour une instance autonome. Définissez la valeur sur 2 pour une instance qui utilise un stockage partagé. Pour une instance de jeu de réplicas, les valeurs valides sont 3, 5 et 7.	3
ReadonlyReplicas	string	Non	Le nombre de nœuds en lecture seule dans l'instance. Valeurs valides : 1 à 5. Remarque Ce paramètre n'est pas requis pour les instances autonomes.	1
Storage	string	Non	L'espace de stockage du jeu de réplicas. Unité : Go. Remarque Ce paramètre est requis si l'instance utilise des disques cloud.	10

Éléments de réponse

Élément	Type	Description	Exemple
	object
DBInstanceAvailable	string	Indique si des ressources sont disponibles dans la région actuelle. Valeurs valides : 1 : les ressources sont suffisantes. 0 : les ressources sont insuffisantes.	1
EngineVersion	string	La version du moteur de base de données.	4.0
RequestId	string	L'identifiant de la requête.	AE2DE465-E45F-481F-ABD8-37D64173****
Engine	string	Le moteur de base de données. La valeur est fixée à MongoDB.	MongoDB

Exemples

JSON format

{
  "DBInstanceAvailable": "1",
  "EngineVersion": "4.0",
  "RequestId": "AE2DE465-E45F-481F-ABD8-37D64173****",
  "Engine": "MongoDB"
}

Codes d'erreur

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

Notes de version

Consultez Notes de version pour la liste complète.