CreateShardingDBInstance - - Centre de documentation Alibaba Cloud

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

Assurez-vous de bien comprendre les méthodes de facturation et la tarification

d'ApsaraDB for MongoDB avant d'appeler cette opération.
Pour plus d'informations sur les types d'instances ApsaraDB for MongoDB, consultez la rubrique Types d'instances.
Pour créer des instances autonomes et des ensembles de réplicas, appelez l'opération CreateDBInstance.

Débogage

OpenAPI Explorer calcule automatiquement la valeur de signature. Par souci de simplicité, nous vous recommandons d'appeler cette opération dans OpenAPI Explorer. OpenAPI Explorer génère dynamiquement un exemple de code pour différents SDK.

Paramètres de requête

Paramètre	Type	Obligatoire	Exemple	Description
RegionId	String	Oui	cn-hangzhou	ID de région de l'instance. Appelez l'opération DescribeRegions pour obtenir la liste actualisée des régions.
Action	String	Oui	CreateShardingDBInstance	Opération à effectuer. Définissez la valeur sur CreateShardingDBInstance.
ZoneId	String	Non	cn-hangzhou-g	ID de zone de disponibilité de l'instance. Appelez l'opération DescribeRegions pour obtenir la liste actualisée des zones.
Engine	String	Oui	MongoDB	Moteur de base de données de l'instance. Définissez la valeur sur MongoDB.
EngineVersion	String	Oui	4.4	Version du moteur de base de données. Valeurs possibles : 6.0 5.0 4.4 4.2 4.0 Remarque Pour connaître les limitations liées aux versions de base de données et aux moteurs de stockage, consultez la rubrique Versions MongoDB et moteurs de stockage. Lors du clonage d'une instance via cette opération, définissez ce paramètre avec le moteur de l'instance source.
DBInstanceDescription	String	Non	test	Nom de l'instance. Contraintes : Le nom doit commencer par une lettre. Le nom peut contenir des chiffres, des lettres, des traits de soulignement (_) et des traits d'union (-). La description doit comporter entre 2 et 256 caractères.
SecurityIPList	String	Non	192.168.xx.xx,192.168.xx.xx	Adresses IP figurant dans la liste blanche. Séparez plusieurs adresses IP par des virgules (,). Chaque adresse IP de la liste blanche doit être unique. Les formats suivants sont pris en charge : 0.0.0.0/0 Adresses IP, par exemple 10.23.12.24. Plages CIDR (Classless Inter-Domain Routing), par exemple 10.23.12.0/24. Dans ce cas, /24 indique que le préfixe de chaque adresse IP est de 24 bits. Vous pouvez remplacer 24 par une valeur comprise entre 1 et 32. Remarque Un maximum de 1 000 adresses IP et plages CIDR peut être configuré par instance. Si vous saisissez 0.0.0.0/0, toutes les adresses IP peuvent accéder à l'instance, ce qui peut présenter des risques de sécurité.
AccountPassword	String	Non	123456Aa	Mot de passe du compte root. Exigences : Le mot de passe doit contenir au moins trois des types de caractères suivants : majuscules, minuscules, chiffres et caractères spéciaux. Les caractères spéciaux autorisés incluent ! # $ % ^ & * ( ) _ + - = Le mot de passe doit comporter entre 8 et 32 caractères.
ChargeType	String	Non	PrePaid	Méthode de facturation de l'instance. Valeurs possibles : PostPaid : paiement à l'utilisation PrePaid : abonnement Remarque Si vous définissez ce paramètre sur PrePaid, vous devez également spécifier le paramètre Period.
Period	Integer	Non	1	Durée de l'abonnement à l'instance. Unité : mois. Valeurs possibles : 1 à 9, 12, 24, 36 et 60. Remarque Si la propriété ChargeType est définie sur PrePaid, configurez cette propriété.
NetworkType	String	Non	VPC	Type de réseau de l'instance. Valeurs possibles : VPC
VpcId	String	Oui	vpc-bp1n3i15v90el48nx****	ID du VPC de l'instance.
VSwitchId	String	Oui	vsw-bp1vj604nj5a9zz74****	ID du vSwitch de l'instance.
SrcDBInstanceId	String	Non	dds-bp11483712c1****	ID de la base de données source. Remarque ID de l'instance source. Ce paramètre est requis uniquement lors du clonage d'une instance via cette opération. Si vous spécifiez ce paramètre, vous devez également indiquer le paramètre RestoreTime.
RestoreTime	String	Non	2022-03-08T02:30:25Z	Point dans le temps auquel cloner l'instance (doit se situer dans les sept derniers jours). Indiquez l'heure au format yyyy-MM-ddTHH:mm:ssZ (UTC). Remarque Ce paramètre est requis uniquement lors du clonage d'une instance via cette opération. Si vous spécifiez ce paramètre, vous devez également indiquer le paramètre SrcDBInstanceId.
ClientToken	String	Non	ETnLKlblzczshOTUbOCz****	Jeton client utilisé pour garantir l'idempotence de la requête. Générez la valeur côté client, mais assurez-vous qu'elle soit unique pour chaque requête. Le jeton ne peut contenir que des caractères ASCII et ne doit pas dépasser 64 caractères.
StorageEngine	String	Non	WiredTiger	Moteur de stockage de l'instance. Valeur par défaut : WiredTiger. Remarque Lors du clonage d'une instance via cette opération, définissez ce paramètre avec le moteur de l'instance source. Pour connaître les limitations liées aux versions de base de données et aux moteurs de stockage, consultez la rubrique Versions MongoDB et moteurs de stockage.
AutoRenew	String	Non	true	Indique si le renouvellement automatique est activé pour l'instance. Valeur par défaut : false. Valeurs possibles : true false Remarque Si le paramètre ChargeType est défini sur PrePaid, configurez ce paramètre facultatif.
ProtocolType	String	Non	mongodb	Type de protocole d'accès de l'instance. Valeurs possibles : mongodb : protocole MongoDB dynamodb : protocole DynamoDB
Mongos.N.Class	String	Oui	mdb.shard.2x.xlarge.d	Type d'instance du nœud mongos. Pour plus d'informations, consultez la rubrique Types d'instances. Remarque N indique le numéro de série du nœud mongos pour lequel le type d'instance est spécifié. Par exemple, Mongos.2.Class spécifie le type d'instance du deuxième nœud mongos. Valeurs possibles pour N : 2 à 32.
ReplicaSet.N.Class	String	Oui	dds.shard.standard	Type d'instance du nœud shard. Pour plus d'informations, consultez la rubrique Types d'instances. Remarque N indique le numéro de série du nœud shard pour lequel le type d'instance est spécifié. Par exemple, ReplicaSet.2.Class spécifie le type d'instance du deuxième nœud shard. Valeurs possibles pour N : 2 à 32.
ReplicaSet.N.Storage	Integer	Oui	10	Capacité de stockage du nœud shard. Unité : Go. Remarque Les valeurs possibles pour ce paramètre dépendent des types d'instances. Pour plus d'informations, consultez la rubrique Types d'instances. N indique le numéro de série du nœud shard pour lequel la capacité de stockage est spécifiée. Par exemple, ReplicaSet.2.Storage spécifie la capacité de stockage du deuxième nœud shard.
ReplicaSet.N.ReadonlyReplicas	Integer	Non	0	Nombre de nœuds en lecture seule dans le nœud shard N. Valeurs possibles : 0 à 5. La valeur doit être un entier. Valeur par défaut : 0. Remarque N indique le numéro de série du nœud shard pour lequel vous souhaitez définir le nombre de nœuds en lecture seule. ReplicaSet.2.ReadonlyReplicas spécifie le nombre de nœuds en lecture seule dans le deuxième nœud shard.
ConfigServer.N.Class	String	Oui	mdb.shard.2x.xlarge.d	Type d'instance du nœud Configserver. Valeur possible : mdb.shard.2x.xlarge.d : 4 cœurs, 8 Go (dédié). Seules les instances exécutant MongoDB 4.4 et versions ultérieures prennent en charge ce type d'instance. dds.cs.mid : 1 cœur, 2 Go (à usage général). Seules les instances exécutant MongoDB 4.2 et versions antérieures prennent en charge ce type d'instance.
ConfigServer.N.Storage	Integer	Oui	20	Capacité de stockage du nœud Configserver. Unité : Go. Remarque Les valeurs possibles pour ce paramètre dépendent des types d'instances. Pour plus d'informations, consultez la rubrique Types d'instances.
StorageType	String	Non	cloud_essd1	Type de stockage de l'instance. Valeurs possibles : cloud_essd1 : ESSD PL1. cloud_essd2 : ESSD PL2. cloud_essd3 : ESSD PL3. local_ssd : SSD local Remarque Les instances MongoDB 4.4 et versions ultérieures ne prennent en charge que les disques cloud. cloud_essd1 est sélectionné si vous laissez ce paramètre vide. Les instances MongoDB 4.2 et versions antérieures ne prennent en charge que les disques locaux. local_ssd est sélectionné si vous laissez ce paramètre vide.

Paramètres de réponse

Paramètre	Type	Exemple	Description
RequestId	String	D8F1D721-6439-4257-A89C-F1E8E9C9****	ID de la requête.
DBInstanceId	String	dds-bp114f14849d****	ID de l'instance
OrderId	String	21010996721****	ID de la commande.

Exemples

Exemples de requêtes

http(s)://mongodb.aliyuncs.com/?RegionId=cn-hangzhou
&Action=CreateShardingDBInstance
&ZoneId=cn-hangzhou-g
&Engine=MongoDB
&EngineVersion=4.4
&DBInstanceDescription=test
&SecurityIPList=192.168.xx.xx,192.168.xx.xx
&AccountPassword=123456Aa
&ChargeType=PrePaid
&Period=1
&NetworkType=VPC
&VpcId=vpc-bp1n3i15v90el48nx****
&VSwitchId=vsw-bp1vj604nj5a9zz74****
&SrcDBInstanceId=dds-bp11483712c1****
&RestoreTime=2022-03-08T02:30:25Z
&ClientToken=ETnLKlblzczshOTUbOCz****
&StorageEngine=WiredTiger
&AutoRenew=true
&ProtocolType=mongodb
&Mongos=[{"Class":"mdb.shard.2x.xlarge.d"}]
&ReplicaSet=[{"Class":"dds.shard.standard","Storage":10,"ReadonlyReplicas":0}]
&ConfigServer=[{"Class":"mdb.shard.2x.xlarge.d","Storage":20}]
&StorageType=cloud_essd1
&<Common request parameters>

Exemples de réponses réussies

Format XML

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

<CreateShardingDBInstanceResponse>
    <RequestId>D8F1D721-6439-4257-A89C-F1E8E9C9****</RequestId>
    <DBInstanceId>dds-bp114f14849d****</DBInstanceId>
    <OrderId>21010996721****</OrderId>
</CreateShardingDBInstanceResponse>

Format JSON

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

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

Codes d'erreur

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