CreateDBInstance - - Centre de documentation Alibaba Cloud

Crée ou clone une instance de jeu de réplicas ApsaraDB for MongoDB.

Description de l'opération

Avant d'utiliser cette opération, assurez-vous de bien comprendre les méthodes de facturation et la tarification d'ApsaraDB for MongoDB.

Pour plus d'informations sur les spécifications des instances, consultez Spécifications des instances.

Pour créer une instance de cluster fragmenté, appelez l'opération CreateShardingDBInstance.

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

create

*Instance.

acs:dds:{#regionId}:{#accountId}:dbinstance/*

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
RegionId	string	Oui	L'identifiant de la région. Vous pouvez appeler l'opération DescribeRegions pour interroger l'identifiant de la région. Remarque Si vous appelez cette opération pour cloner une instance ou restaurer une instance clonée depuis la corbeille, définissez ce paramètre sur la même valeur que celle de l'instance source.	cn-hangzhou
ClientToken	string	Non	Le jeton client utilisé pour garantir l'idempotence de la requête. Vous pouvez utiliser le client pour générer le jeton, mais vous devez vous assurer qu'il est unique pour chaque requête. Le jeton ne peut contenir que des caractères ASCII et sa longueur ne peut pas dépasser 64 caractères.	ETnLKlblzczshOTUbOCz****
ZoneId	string	Non	L'identifiant de la zone. Vous pouvez appeler l'opération DescribeRegions pour interroger l'identifiant de la zone.	cn-hangzhou-g
EngineVersion	string	Oui	La version du moteur de base de données. Valeurs valides : 8.0 7.0 6.0 5.0 4.4 4.2 4.0 Remarque Si vous appelez cette opération pour cloner une instance ou restaurer une instance clonée depuis la corbeille, définissez ce paramètre sur la même valeur que celle de l'instance source. Avertissement Les versions 3.4 et antérieures ne sont plus disponibles à l'achat.	4.4
DBInstanceClass	string	Oui	Le type d'instance. Vous pouvez appeler l'opération DescribeAvailableResource pour interroger les types d'instances disponibles.	dds.mongo.standard
DBInstanceStorage	integer	Oui	La capacité de stockage de l'instance. Unité : Go. Les valeurs valides dépendent du type d'instance. Pour plus de détails, consultez Spécifications des instances de jeu de réplicas.	10
DBInstanceDescription	string	Non	Le nom de l'instance. Le nom doit respecter les exigences suivantes : Doit commencer par un caractère chinois ou une lettre. Peut contenir des chiffres, des caractères chinois, des lettres, des traits de soulignement (_), des points (.) et des traits d'union (-). Doit comporter entre 2 et 256 caractères.	test
SecurityIPList	string	Non	La liste blanche d'adresses IP de l'instance. Séparez les adresses IP multiples par des virgules (,). Les adresses IP en double ne sont pas autorisées. Les formats suivants sont pris en charge : 0.0.0.0/0 Format d'adresse IP, tel que 10.23.12.24. Format de bloc CIDR, tel que 10.23.12.0/24. Dans cet exemple, 24 indique que le préfixe du bloc CIDR a une longueur de 24 bits. La longueur du préfixe varie de 1 à 32. Remarque Chaque instance prend en charge un maximum de 1 000 adresses IP ou blocs CIDR dans tous les groupes de listes blanches d'adresses IP. 0.0.0.0/0 autorise toutes les adresses IP à accéder à la base de données de l'instance. Il s'agit d'un paramètre à haut risque. Procédez avec prudence.	192.168.xx.xx,192.168.xx.xx
AccountPassword	string	Non	Le mot de passe du compte root. Le mot de passe doit respecter les exigences suivantes : Doit contenir au moins trois des types de caractères suivants : lettres majuscules, lettres minuscules, chiffres et caractères spéciaux. Les caractères spéciaux incluent !@#$%^&()_+-=. Doit comporter entre 8 et 32 caractères. Remarque* Pour plus d'informations sur la résolution des échecs de connexion à la base de données causés par des caractères spéciaux dans le mot de passe, consultez Comment résoudre les échecs de connexion à la base de données causés par des caractères spéciaux dans la chaîne de connexion ?.	123456Aa
Period	integer	Non	La durée d'abonnement de l'instance. Unité : mois. Valeurs valides : 1 à 9 (entiers), 12, 24, 36 et 60. Remarque Ce paramètre est disponible et requis lorsque ChargeType est défini sur PrePaid.	1
ChargeType	string	Non	La méthode de facturation de l'instance. Valeurs valides : PostPaid : valeur par défaut. Paiement à l'usage. PrePaid : Abonnement. Remarque Si vous définissez ce paramètre sur PrePaid, vous devez également configurer le paramètre Period. Valeurs valides : PostPaid : paiement à l'usage. PrePaid : abonnement.	PrePaid
NetworkType	string	Non	Le type de réseau de l'instance. Valeurs valides : VPC : Virtual Private Cloud. Valeurs valides : VPC : Virtual Private Cloud.	VPC
VpcId	string	Non	L'identifiant du VPC.	vpc-bp175iuvg8nxqraf2****
VSwitchId	string	Non	L'identifiant du vSwitch.	vsw-bp1gzt31twhlo0sa5****
SrcDBInstanceId	string	Non	L'identifiant de l'instance source. Remarque Si vous appelez cette opération pour cloner une instance, vous devez configurer ce paramètre avec le paramètre BackupId ou RestoreTime. Si vous appelez cette opération pour restaurer une instance clonée depuis la corbeille, vous devez uniquement configurer ce paramètre. Les paramètres BackupId et RestoreTime ne sont pas requis.	dds-bp1ee12ad351****
BackupId	string	Non	L'identifiant de la sauvegarde. Vous pouvez appeler l'opération DescribeBackups pour interroger l'identifiant de la sauvegarde. Remarque Ce paramètre est requis uniquement lorsque vous appelez cette opération pour cloner une instance à partir d'un point de sauvegarde. Vous devez également configurer le paramètre SrcDBInstanceId.	32994****
RestoreTime	string	Non	Le point dans le temps auquel restaurer l'instance. Vous pouvez spécifier n'importe quel point dans le temps au cours des 7 derniers jours. Spécifiez l'heure au format yyyy-MM-ddTHH:mm:ssZ. L'heure doit être en UTC. Remarque Ce paramètre est requis uniquement lorsque vous appelez cette opération pour cloner une instance à un point dans le temps. Vous devez également configurer le paramètre SrcDBInstanceId.	2022-03-13T12:11:14Z
BusinessInfo	string	Non	Les informations supplémentaires sur l'activité.	{“ActivityId":"000000000"}
AutoRenew	string	Non	Indique si le renouvellement automatique de l'instance doit être activé. Valeurs valides : true : active le renouvellement automatique. false : valeur par défaut. Désactive le renouvellement automatique. Vous devez renouveler l'instance manuellement. Remarque Ce paramètre est disponible et facultatif lorsque ChargeType est défini sur PrePaid.	true
DatabaseNames	string	Non	Le nom de la base de données. Remarque Lorsque vous appelez cette opération pour cloner une instance, vous pouvez spécifier ce paramètre pour cloner des bases de données spécifiques. Si vous ne spécifiez pas ce paramètre, toutes les bases de données sont clonées.	mongodbtest
CouponNo	string	Non	Indique si un coupon doit être utilisé. Valeurs valides : default ou null (par défaut) : utilise un coupon. youhuiquan_promotion_option_id_for_blank : n'utilise pas de coupon.	default
StorageEngine	string	Non	Le moteur de stockage de l'instance. La valeur est fixée à WiredTiger. Remarque Si vous appelez cette opération pour cloner une instance ou restaurer une instance clonée depuis la corbeille, définissez ce paramètre sur la même valeur que celle de l'instance source. Pour plus d'informations sur les contraintes relatives aux moteurs de stockage et aux versions, consultez Versions et moteurs de stockage. Valeurs valides : WiredTiger : Moteur de stockage WiredTiger.	WiredTiger
ReplicationFactor	string	Non	Le nombre de nœuds primaires et secondaires dans l'instance de jeu de réplicas. Valeurs valides : 3 (par défaut) 5 7 Important Ce paramètre n'est pas requis pour les instances à nœud unique.	3
ReadonlyReplicas	string	Non	Le nombre de nœuds en lecture seule dans l'instance de jeu de réplicas. Valeurs valides : 0 à 5 (entiers). Valeur par défaut : 0.	0
Engine	string	Non	L'identifiant du groupe de ressources. Valeurs valides : MongoDB : Moteur de base de données MongoDB.	rg-acfmyiu4ekp****
StorageType	string	Non	L'identifiant du cluster dédié.	dhg-2x78****
SecondaryZoneId	string	Non	Le moteur de base de données. La valeur est fixée à MongoDB.	MongoDB
HiddenZoneId	string	Non	Le type de stockage. Valeurs valides : cloud_essd1 : ESSD PL1. cloud_essd2 : ESSD PL2. cloud_essd3 : ESSD PL3. cloud_auto : disque ESSD AutoPL. local_ssd : SSD local. Remarque Pour les instances à nœud unique, si vous spécifiez cloud_essd1, l'instance utilise un disque cloud_essd. Les disques ESSD AutoPL ne sont actuellement disponibles que sur le site China. Pour les instances exécutant la version 4.4 ou ultérieure, la valeur par défaut est cloud_essd1. Pour les instances exécutant la version 4.2 ou antérieure, la valeur par défaut est local_ssd.	cloud_essd1
Tag	array<object>	Non	La zone où le nœud secondaire est déployé pour mettre en œuvre un déploiement multizone. Valeurs valides : cn-hangzhou-g : Hangzhou Zone G. cn-hangzhou-h : Hangzhou Zone H. cn-hangzhou-i : Hangzhou Zone I. cn-hongkong-b : Hong Kong (China) Zone B. cn-hongkong-c : Hong Kong (China) Zone C. cn-hongkong-d : Hong Kong (China) Zone D. cn-wulanchabu-a : Ulanqab Zone A. cn-wulanchabu-b : Ulanqab Zone B. cn-wulanchabu-c : Ulanqab Zone C. ap-southeast-1a : Singapore Zone A. ap-southeast-1b : Singapore Zone B. ap-southeast-1c : Singapore Zone C. ap-southeast-5a : Jakarta Zone A. ap-southeast-5b : Jakarta Zone B. ap-southeast-5c : Jakarta Zone C. eu-central-1a : Frankfurt Zone A. eu-central-1b : Frankfurt Zone B. eu-central-1c : Frankfurt Zone C. Remarque Ce paramètre est disponible lorsque l'instance utilise des disques cloud. La valeur de ce paramètre ne peut pas être identique aux valeurs de ZoneId et HiddenZoneId.	cn-hangzhou-h
	object	Non
Key	string	Non	La clé de la balise. Remarque N spécifie le numéro de la balise. Par exemple, Tag.1.Key spécifie la clé de la première balise, et Tag.2.Key spécifie la clé de la deuxième balise.	testdatabase
Value	string	Non	La valeur de la balise. Remarque N spécifie le numéro de la balise. Par exemple, Tag.1.Value spécifie la valeur de la première balise, et Tag.2.Value spécifie la valeur de la deuxième balise.	apitest
GlobalSecurityGroupIds	string	Non	La zone où le nœud masqué est déployé pour mettre en œuvre un déploiement multizone. Valeurs valides : cn-hangzhou-g : Hangzhou Zone G. cn-hangzhou-h : Hangzhou Zone H. cn-hangzhou-i : Hangzhou Zone I. cn-hongkong-b : Hong Kong (China) Zone B. cn-hongkong-c : Hong Kong (China) Zone C. cn-hongkong-d : Hong Kong (China) Zone D. cn-wulanchabu-a : Ulanqab Zone A. cn-wulanchabu-b : Ulanqab Zone B. cn-wulanchabu-c : Ulanqab Zone C. ap-southeast-1a : Singapore Zone A. ap-southeast-1b : Singapore Zone B. ap-southeast-1c : Singapore Zone C. ap-southeast-5a : Jakarta Zone A. ap-southeast-5b : Jakarta Zone B. ap-southeast-5c : Jakarta Zone C. eu-central-1a : Frankfurt Zone A. eu-central-1b : Frankfurt Zone B. eu-central-1c : Frankfurt Zone C. Remarque Ce paramètre est disponible lorsque l'instance utilise des disques cloud. La valeur de ce paramètre ne peut pas être identique aux valeurs de ZoneId et SecondaryZoneId.	cn-hangzhou-i
Encrypted	boolean	Non	Les balises définies par l'utilisateur.	true
EncryptionKey	string	Non	Les modèles de liste blanche d'adresses IP globales pour l'instance. Séparez les modèles multiples par des virgules (,). Les modèles en double ne sont pas autorisés. (Cette fonctionnalité est en version canari.)	g-qxieqf40xjst1ngpr3jz
ProvisionedIops	integer	Non	Indique si le chiffrement des disques cloud doit être activé.	true
RestoreType	string	Non	L'identifiant de la clé personnalisée.	2axxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
SrcRegion	string	Non	Les performances provisionnées (IOPS). Valeurs valides : 0 à 50000.	1960

Éléments de réponse

Élément	Type	Description	Exemple
	object
RequestId	string	L'identifiant de la requête.	D8F1D721-6439-4257-A89C-F1E8E9C9****
DBInstanceId	string	L'identifiant de l'instance.	dds-bp144a7f2db8****
OrderId	string	L'identifiant de la commande.	21077576248****

Exemples

JSON format

{
  "RequestId": "D8F1D721-6439-4257-A89C-F1E8E9C9****",
  "DBInstanceId": "dds-bp144a7f2db8****",
  "OrderId": "21077576248****"
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
400	SecurityRisk.AuthVerification	we have detected a risk with your default payment method. An email and notification has been sent to you. Please re-submit your order before after verificaiton.
400	MissingParameter	Period is mandatory for this action.
400	ORDER.ACCOUNT_INFORMATION_INCOMPLETE	Your information is incomplete. Complete your information before ordering.
400	InvalidClientToken.Malformed	Specified parameter ClientToken is not valid.
400	InvalidDBInstanceDescription.Malformed	Specified parameter DBInstanceDescription is not valid.	Le nom du nœud n'est pas valide.
400	InvalidSecurityIPListLength.Malformed	The quota of security ip exceeds.
400	InsufficientBalance	Your account does not have enough balance.
400	QuotaExceed.AfterpayInstance	Living afterpay instances quota exceeded.
400	InvalidCapacity.NotFound	The Capacity provided does not exist in our records.
400	ResourceNotAvailable	Resource you requested is not available for finance user.
400	IdempotentParameterMismatch	Request uses a client token in a previous request but is not identical to that request.
400	InvalidSecurityIPList.Malformed	The specified parameter "SecurityIPList" is not valid.
400	InvalidSecurityIPList.Duplicate	The Security IP address is not in the available range or occupied.
400	InvalidDBInstanceStorage.ValueNotSupported	The specified parameter DBInstanceStorage is not valid.
400	InvalidAccountPassword.Malformed	Specified parameter AccountPassword is not valid.
400	TokenServiceError	Duplicate ClientToken request.
400	Zone.Closed	The specified zone is closed.
400	PRICE.ORIGIN_PRICE_ERROR	The origin price error.
400	NO_AVAILABLE_PAYMENT_METHOD	No payment method is specified for your account. We recommend that you add a payment method.
400	InvalidEcsImage.NotFound	Specified ecs image does not exist.
400	SaleValidateNoSpecificCodeFailed	Specified Storage or Version or InstanceClass is invalid.	Le paramètre Storage, Version ou InstanceClass est vide.
400	Trade_Not_Support_Async_Pay	Trade not support async pay.
400	InvalidZoneld	The specified primary zone, secondary zone and hidden zone cannot be the same.	Les paramètres de zone principale, de zone secondaire 1 et de zone secondaire 2 ne peuvent pas être tous identiques.
400	SameZoneId	The specified primary zone, secondary zone require two different zones.	Les paramètres de zone principale et de zone secondaire spécifiés doivent être différents.
403	RealNameAuthenticationError	Your account has not passed the real-name authentication yet.
403	RegionUnauthorized	There is no authority to create instance in the specified region.
403	OperationDenied	The resource is out of usage.	La ressource n'est plus utilisée.
403	InvalidEngineVersionInRegion.NotAvailable	The EngineVersion in the Region is not available.
403	InvalidBackupLogStatus	Current backup log enable status does not support this operation.
403	IncorrectBackupSetState	Current backup set state does not support operations.
404	InvalidBackup.NotFound	The available backup does not exist in recovery time.

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

Notes de version

Consultez Notes de version pour la liste complète.