CreateShardingDBInstance - - Centre de documentation Alibaba Cloud

Crée ou clone une instance de cluster fragmenté ApsaraDB for MongoDB.

Description de l'opération

Avant d'appeler 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 d'ApsaraDB for MongoDB, consultez Spécifications des instances.
Pour créer une instance autonome ou de jeu de réplicas, appelez l'opération CreateDBInstance.

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

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.	cn-hangzhou
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
Engine	string	Oui	Le moteur de base de données. Définissez la valeur sur MongoDB. Valeurs valides : MongoDB : Moteur de base de données MongoDB.	MongoDB
EngineVersion	string	Oui	Le numéro de version de la base de données. Valeurs valides : 8.0 7.0 6.0 5.0 4.4 4.2 4.0 Remarque Pour plus d'informations sur les contraintes relatives aux moteurs de stockage et aux versions, consultez Versions du moteur de base de données et moteurs de stockage. Lorsque vous appelez cette opération pour cloner une instance, définissez ce paramètre sur la même valeur que celle de l'instance source.	4.4
DBInstanceDescription	string	Non	Le nom de l'instance. Valeurs valides : Le nom doit commencer par une lettre. Le nom peut contenir des chiffres, des lettres, des traits de soulignement (_), des points (.) et des traits d'union (-). Le nom 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 ne peuvent pas être dupliquées. Les trois formats suivants sont pris en charge : 0.0.0.0/0 Adresse IP, telle que 10.23.12.24. Bloc CIDR, tel que 10.23.12.0/24, où 24 indique la longueur du préfixe dans l'adresse IP et la valeur varie de 1 à 32. Remarque Vous pouvez ajouter jusqu'à 1 000 adresses IP ou blocs CIDR à tous les groupes de listes blanches d'adresses IP d'une instance. Si vous définissez ce paramètre sur 0.0.0.0/0, toutes les adresses IP peuvent accéder à l'instance. Faites preuve de prudence lorsque vous utilisez ce paramètre.	192.168.xx.xx,192.168.xx.xx
AccountPassword	string	Non	Le mot de passe du compte root. Valeurs valides : Le mot de passe 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 !@#$%^&()_+-= Le mot de passe doit comporter entre 8 et 32 caractères. Remarque* Pour plus d'informations sur la façon de 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, consultez Comment résoudre les échecs de connexion causés par des caractères spéciaux dans le mot de passe du compte d'une chaîne de connexion ?.	123456Aa
ChargeType	string	Non	La méthode de facturation de l'instance. Valeurs valides : PostPaid : paiement à l'usage. Il s'agit de la valeur par défaut. 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
Period	integer	Non	La période d'abonnement de l'instance. Unité : mois. Valeurs valides : 1 à 9 (entier), 12, 24, 36 et 60. Remarque Ce paramètre est disponible et requis uniquement lorsque vous définissez ChargeType sur PrePaid.	1
NetworkType	string	Non	Le type de réseau de l'instance. Valeurs valides : VPC : cloud privé virtuel (VPC).	VPC
VpcId	string	Non	L'identifiant du VPC.	vpc-bp1n3i15v90el48nx****
VSwitchId	string	Non	L'identifiant du vSwitch.	vsw-bp1vj604nj5a9zz74****
SrcDBInstanceId	string	Non	L'identifiant de l'instance source. Remarque Ce paramètre est requis uniquement lorsque vous appelez cette opération pour cloner une instance. Vous devez également configurer le paramètre RestoreTime.	dds-bp11483712c1****
RestoreTime	string	Non	Le point dans le temps vers lequel vous souhaitez récupérer les données. Vous pouvez spécifier n'importe quel point dans le temps au cours des sept derniers jours. Spécifiez l'heure au format yyyy-MM-ddTHH:mm:ssZ (UTC). Remarque Ce paramètre est requis uniquement lorsque vous appelez cette opération pour cloner une instance. Vous devez également configurer le paramètre SrcDBInstanceId.	2022-03-08T02:30:25Z
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 assurez-vous que le jeton est unique parmi les différentes requêtes. Le jeton ne peut contenir que des caractères ASCII et ne peut pas dépasser 64 caractères.	ETnLKlblzczshOTUbOCz****
StorageEngine	string	Non	Le moteur de stockage de l'instance. Définissez la valeur sur WiredTiger. Remarque Lorsque vous appelez cette opération pour cloner une instance, 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 du moteur de base de données et moteurs de stockage.	WiredTiger
AutoRenew	string	Non	Indique si le renouvellement automatique doit être activé pour l'instance. Valeurs valides : true : active le renouvellement automatique. false : désactive le renouvellement automatique. Vous devez renouveler l'instance manuellement. Il s'agit de la valeur par défaut. Remarque Ce paramètre est disponible et facultatif uniquement lorsque vous définissez ChargeType sur PrePaid.	true
ProtocolType	string	Non	Le type de protocole d'accès. Valeurs valides : mongodb : protocole MongoDB. dynamodb : protocole DynamoDB. Valeurs valides : mongodb : Protocole MongoDB. dynamodb : Protocole DynamoDB.	mongodb
Mongos	array<object>	Oui	Les informations sur les nœuds Mongos.
	object	Oui	Les informations sur les nœuds Mongos.
Class	string	Oui	La spécification du nœud Mongos. Pour plus d'informations, consultez Spécifications des instances de cluster fragmenté. Remarque N dans le nom du paramètre spécifie le numéro de séquence du nœud Mongos. Par exemple, Mongos.2.Class spécifie la spécification du deuxième nœud Mongos. Valeurs valides de N : 2 à 32.	mdb.shard.2x.xlarge.d
ReplicaSet	array<object>	Oui	Les informations sur les nœuds Shard.
	object	Non	Les informations sur les nœuds Shard.
Class	string	Oui	La spécification du nœud Shard. Pour plus d'informations, consultez Spécifications des instances de cluster fragmenté. Remarque N dans le nom du paramètre spécifie le numéro de séquence du nœud Shard. Par exemple, ReplicaSet.2.Class spécifie la spécification du deuxième nœud Shard. Valeurs valides de N : 2 à 32.	dds.shard.standard
Storage	integer	Oui	La capacité de stockage du nœud Shard. Unité : Go. Remarque Les valeurs valides sont soumises aux spécifications de l'instance. Pour plus d'informations, consultez Spécifications des instances de cluster fragmenté. N dans le nom du paramètre spécifie le numéro de séquence du nœud Shard. Par exemple, ReplicaSet.2.Storage spécifie la capacité de stockage du deuxième nœud Shard.	10
ReadonlyReplicas	integer	Non	Le nombre de nœuds en lecture seule pour le nœud Shard. Valeurs valides : 0 à 5 (entier). Valeur par défaut : 0. Remarque N dans le nom du paramètre spécifie le numéro de séquence du nœud Shard. Par exemple, ReplicaSet.2.ReadonlyReplicas spécifie le nombre de nœuds en lecture seule pour le deuxième nœud Shard.	0
ConfigServer	array<object>	Oui	Les informations sur les nœuds ConfigServer.
	object	Non	Les informations sur les nœuds ConfigServer.
Class	string	Oui	La spécification du nœud ConfigServer. Valeurs valides : mdb.shard.2x.xlarge.d : 4 vCPU, 8 Go de mémoire (dédié). Cette valeur est prise en charge uniquement pour les instances qui exécutent la version 4.4 ou ultérieure. dds.cs.mid : 1 vCPU, 2 Go de mémoire (usage général). Cette valeur est prise en charge uniquement pour les instances qui exécutent la version 4.2 ou antérieure.	mdb.shard.2x.xlarge.d
Storage	integer	Oui	La capacité de stockage du nœud ConfigServer. Unité : Go. Remarque Les valeurs valides sont soumises aux spécifications de l'instance. Pour plus d'informations, consultez Spécifications des instances de cluster fragmenté.	20
SecondaryZoneId	string	Non	L'identifiant du groupe de ressources. Pour plus d'informations, consultez Afficher les informations de base d'un groupe de ressources.	rg-acfmyiu4ekp****
HiddenZoneId	string	Non	La zone secondaire 1 pour le 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 (Chine) Zone B. cn-hongkong-c : Hong Kong (Chine) Zone C. cn-hongkong-d : Hong Kong (Chine) Zone D. cn-wulanchabu-a : Ulanqab Zone A. cn-wulanchabu-b : Ulanqab Zone B. cn-wulanchabu-c : Ulanqab Zone C. ap-southeast-1a : Singapour Zone A. ap-southeast-1b : Singapour Zone B. ap-southeast-1c : Singapour Zone C. ap-southeast-5a : Jakarta Zone A. ap-southeast-5b : Jakarta Zone B. ap-southeast-5c : Jakarta Zone C. eu-central-1a : Francfort Zone A. eu-central-1b : Francfort Zone B. eu-central-1c : Francfort Zone C. Remarque Ce paramètre est disponible uniquement lorsque l'instance utilise des disques cloud. La valeur de ce paramètre ne peut pas être identique aux valeurs de ZoneId ou HiddenZoneId. Pour plus d'informations sur la stratégie de déploiement multizone pour les instances de cluster fragmenté, consultez Créer une instance de cluster fragmenté multizone.	cn-hangzhou-h
StorageType	string	Non	La zone secondaire 2 pour le 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 (Chine) Zone B. cn-hongkong-c : Hong Kong (Chine) Zone C. cn-hongkong-d : Hong Kong (Chine) Zone D. cn-wulanchabu-a : Ulanqab Zone A. cn-wulanchabu-b : Ulanqab Zone B. cn-wulanchabu-c : Ulanqab Zone C. ap-southeast-1a : Singapour Zone A. ap-southeast-1b : Singapour Zone B. ap-southeast-1c : Singapour Zone C. ap-southeast-5a : Jakarta Zone A. ap-southeast-5b : Jakarta Zone B. ap-southeast-5c : Jakarta Zone C. eu-central-1a : Francfort Zone A. eu-central-1b : Francfort Zone B. eu-central-1c : Francfort Zone C. Remarque Ce paramètre est disponible uniquement lorsque l'instance utilise des disques cloud. La valeur de ce paramètre ne peut pas être identique aux valeurs de ZoneId ou SecondaryZoneId. Pour plus d'informations sur la stratégie de déploiement multizone pour les instances de cluster fragmenté, consultez Créer une instance de cluster fragmenté multizone.	cn-hangzhou-i
GlobalSecurityGroupIds	string	Non	Le type de stockage. Valeurs valides : cloud_essd1 : ESSD PL1. cloud_essd2 : ESSD PL2. cloud_essd3 : ESSD PL3. local_ssd : SSD local. Remarque Les instances qui exécutent la version 4.4 ou ultérieure prennent en charge uniquement les disques cloud. Si vous ne spécifiez pas ce paramètre, cloud_essd1 est utilisé par défaut. Les instances qui exécutent la version 4.2 ou antérieure prennent en charge uniquement les disques locaux. Si vous ne spécifiez pas ce paramètre, local_ssd est utilisé par défaut.	cloud_essd1
Tag	array<object>	Non	Les modèles de liste blanche d'adresses IP globales de l'instance. Séparez les modèles multiples par des virgules (,). Les modèles ne peuvent pas être dupliqués.	g-qxieqf40xjst1ngpr3jz
	object	Non	Les balises personnalisées ajoutées à l'instance.
Key	string	Non	La clé de la balise.	testdatabase
Value	string	Non	La valeur de la balise.	apitest
Encrypted	boolean	Non	Les balises personnalisées.	true
EncryptionKey	string	Non	Indique si le chiffrement des disques cloud doit être activé.	true
ProvisionedIops	integer	Non	L'identifiant de la clé de chiffrement personnalisée.	2axxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
SrcRegion	string	Non	Les IOPS provisionnés.	1960
BackupId	string	Non	La région où réside l'instance source. Remarque Ce paramètre est requis lorsque le type de récupération de sauvegarde consiste à reconstruire une instance supprimée. Ce paramètre est requis lorsque le type de récupération de sauvegarde consiste à cloner à partir d'une sauvegarde à redondance géographique.	cn-beijing
RestoreType	string	Non	L'identifiant de la sauvegarde du cluster. Remarque Ce paramètre est requis uniquement lorsque RestoreType est défini sur 2 ou 3.	cb-xxx
DestRegion	string	Non	Le type de récupération de sauvegarde. Valeurs valides : 1 : Récupérer l'instance vers un point dans le temps spécifié. 2 : Récupérer une instance libérée à partir d'un jeu de sauvegarde spécifié. 3 : Récupérer l'instance à partir d'un jeu de sauvegarde à redondance géographique spécifié.	1

Éléments de réponse

Élément	Type	Description	Exemple
	object	Les paramètres de réponse.
RequestId	string	L'identifiant de la requête.	D8F1D721-6439-4257-A89C-F1E8E9C9****
DBInstanceId	string	L'identifiant de l'instance.	dds-bp114f14849d****
OrderId	string	L'identifiant de la commande.	21010996721****

Exemples

JSON format

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

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	InvaliadParameter.ShardsCount.LessThanSrc	The specified number of shards is less than that of source instance.
400	ORDER.ACCOUNT_INFORMATION_INCOMPLETE	Your information is incomplete. Complete your information before ordering.
400	InvalidRegion.Format	Specified Region is not valid.
400	Zone.Closed	The specified zone is closed.
400	TokenServiceError	The request token is duplicated.
400	InvalidParam	Param not valid.
400	InvalidEngineVersion.Malformed	Specified engine version is not valid.
400	InvalidParameters.Format	Specified parameters is not valid.	Le paramètre d'entrée n'est pas valide.
400	RestoreTypeNotSupported	The specified restoreType is not supported for the instance, check the input parameters 'RestoreType/BackupID/RestoreTime'.	Le type de restauration d'instance spécifié n'est pas pris en charge. Vérifiez les paramètres d'entrée RestoreType, BackupID et RestoreTime.
500	VpcServiceError	Invoke vpc service error.	Une erreur s'est produite lors de l'appel au service VPC.
403	InvalidBackupLogStatus	Current backup log enable status does not support this operation.
403	ReduceDiskNotSupport	Reduce disk size is not supported in clone/restore.	La réduction de l'espace du disque cloud n'est pas prise en charge pour le clonage ou la restauration d'instance.

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

Notes de version

Consultez Notes de version pour la liste complète.