CreateShardingDBInstance - - Centro de documentación de Alibaba Cloud

Crea o clona una instancia de clúster fragmentado de ApsaraDB for MongoDB.

Asegúrese de comprender completamente los métodos de facturación y la facturación

de ApsaraDB for MongoDB antes de llamar a esta operación.
Para obtener más información sobre los tipos de instancia de ApsaraDB for MongoDB, consulte Tipos de instancia.
Para crear instancias independientes y de conjunto de réplicas, llame a la operación CreateDBInstance.

Depuración

OpenAPI Explorer calcula automáticamente el valor de la firma. Para su comodidad, le recomendamos que llame a esta operación en OpenAPI Explorer. OpenAPI Explorer genera dinámicamente el código de ejemplo de la operación para diferentes SDK.

Parámetros de solicitud

Parámetro	Tipo	Obligatorio	Ejemplo	Descripción
RegionId	String	Sí	cn-hangzhou	ID de región de la instancia. Llame a la operación DescribeRegions para consultar la lista de regiones más reciente.
Action	String	Sí	CreateShardingDBInstance	Operación que desea ejecutar. Establezca el valor en CreateShardingDBInstance.
ZoneId	String	No	cn-hangzhou-g	ID de zona de la instancia. Llame a la operación DescribeRegions para consultar la lista de zonas más reciente.
Engine	String	Sí	MongoDB	Motor de la instancia. Establezca el valor en MongoDB.
EngineVersion	String	Sí	4.4	Versión del motor de base de datos. Valores válidos: 6.0 5.0 4.4 4.2 4.0 Nota Para obtener más información sobre los límites de las versiones de base de datos y los motores de almacenamiento, consulte Versiones de MongoDB y motores de almacenamiento. Si llama a esta operación para clonar una instancia, establezca el valor en el motor de la instancia de origen.
DBInstanceDescription	String	No	test	Nombre de la instancia. Valores válidos: Debe comenzar con una letra. Puede contener dígitos, letras, guiones bajos (_) y guiones (-). Debe tener entre 2 y 256 caracteres de longitud.
SecurityIPList	String	No	192.168.xx.xx,192.168.xx.xx	Direcciones IP en una lista de permitidos. Separe varias direcciones IP con comas (,). Cada dirección IP en la lista de permitidos debe ser única. Se admiten los siguientes tipos de valores: 0.0.0.0/0 Direcciones IP, como 10.23.12.24. Bloques Classless Inter-Domain Routing (CIDR), como 10.23.12.0/24. En este caso, /24 indica que el prefijo de cada dirección IP tiene una longitud de 24 bits. Puede reemplazar 24 con un valor dentro del rango de 1 a 32. Nota Se pueden configurar un máximo de 1,000 direcciones IP y bloques CIDR para cada instancia. Si introduce 0.0.0.0/0, todas las direcciones IP podrán acceder a la instancia. Esto puede introducir riesgos de seguridad en la instancia.
AccountPassword	String	No	123456Aa	Contraseña de la cuenta root. Debe cumplir los siguientes requisitos: Debe contener como mínimo tres de los siguientes tipos de caracteres: letras mayúsculas, letras minúsculas, dígitos y caracteres especiales. Los caracteres especiales incluyen ! # $ % ^ & * ( ) _ + - = Debe tener entre 8 y 32 caracteres de longitud.
ChargeType	String	No	PrePaid	Método de facturación de la instancia. Valores válidos: PostPaid: pay-as-you-go PrePaid: suscripción Nota Si especifica este parámetro como PrePaid, también debe especificar el parámetro Period.
Period	Integer	No	1	Período de suscripción de la instancia. Unidad: meses. Valores válidos: de 1 a 9, 12, 24, 36 y 60. Nota Si establece la propiedad ChargeType en PrePaid, debe configurar esta propiedad.
NetworkType	String	No	VPC	Tipo de red de la instancia. Valores válidos: VPC
VpcId	String	Sí	vpc-bp1n3i15v90el48nx****	ID de VPC de la instancia.
VSwitchId	String	Sí	vsw-bp1vj604nj5a9zz74****	ID de vSwitch de la instancia.
SrcDBInstanceId	String	No	dds-bp11483712c1****	ID de la base de datos de origen. Nota ID de la instancia de origen. Este parámetro es obligatorio solo cuando llama a esta operación para clonar una instancia. Si especifica este parámetro, también debe especificar el parámetro RestoreTime.
RestoreTime	String	No	2022-03-08T02:30:25Z	Punto en el tiempo para clonar la instancia, que debe estar dentro de los últimos siete días. Especifique la hora en formato aaaa-MM-ddTHH:mm:ssZ. La hora debe estar en UTC. Nota Este parámetro es obligatorio solo cuando llama a esta operación para clonar una instancia. Si especifica este parámetro, también debe especificar el parámetro SrcDBInstanceId.
ClientToken	String	No	ETnLKlblzczshOTUbOCz****	Token de cliente que se utiliza para garantizar la idempotencia de la solicitud. Puede usar el cliente para generar el valor, pero debe asegurarse de que sea único entre diferentes solicitudes. El token solo puede contener caracteres ASCII y no puede exceder los 64 caracteres de longitud.
StorageEngine	String	No	WiredTiger	Motor de almacenamiento de la instancia. Valor predeterminado: WiredTiger. Nota Si llama a esta operación para clonar una instancia, establezca el valor en el motor de la instancia de origen. Para obtener más información sobre los límites de las versiones de base de datos y los motores de almacenamiento, consulte Versiones de MongoDB y motores de almacenamiento.
AutoRenew	String	No	true	Especifica si se habilita la renovación automática para la instancia. Valor predeterminado: false. Valores válidos: true false Nota Si establece el parámetro ChargeType en PrePaid, debe configurar este parámetro opcional.
ProtocolType	String	No	mongodb	Tipo de protocolo de acceso de la instancia. Valores válidos: mongodb: protocolo MongoDB dynamodb: protocolo DynamoDB
Mongos.N.Class	String	Sí	mdb.shard.2x.xlarge.d	Tipo de instancia del nodo mongos. Para obtener más información, consulte Tipos de instancia. Nota N especifica el número de serie del nodo mongos para el cual se especifica el tipo de instancia. Por ejemplo, Mongos.2.Class especifica el tipo de instancia del segundo nodo mongos. Valores válidos para N: de 2 a 32.
ReplicaSet.N.Class	String	Sí	dds.shard.standard	Tipo de instancia del nodo shard. Para obtener más información, consulte Tipos de instancia. Nota N especifica el número de serie del nodo shard para el cual se especifica el tipo de instancia. Por ejemplo, ReplicaSet.2.Class especifica el tipo de instancia del segundo nodo shard. Valores válidos para N: de 2 a 32.
ReplicaSet.N.Storage	Integer	Sí	10	Capacidad de almacenamiento del nodo shard. Unidad: GB. Nota Los valores que se pueden especificar para este parámetro dependen de los tipos de instancia. Para obtener más información, consulte Tipos de instancia. N especifica el número de serie del nodo shard para el cual se especifica la capacidad de almacenamiento. Por ejemplo, ReplicaSet.2.Storage especifica la capacidad de almacenamiento del segundo nodo shard.
ReplicaSet.N.ReadonlyReplicas	Integer	No	0	Número de nodos de solo lectura en el nodo shard N. Valores válidos: de 0 a 5. El valor debe ser un número entero. Valor predeterminado: 0. Nota N especifica el número de serie del nodo shard para el cual desea establecer el número de nodos de solo lectura. ReplicaSet.2.ReadonlyReplicas especifica el número de nodos de solo lectura en el segundo nodo shard.
ConfigServer.N.Class	String	Sí	mdb.shard.2x.xlarge.d	Tipo de instancia del nodo Configserver. Valores válidos: mdb.shard.2x.xlarge.d: 4 núcleos, 8 GB (dedicado). Solo las instancias que ejecutan MongoDB 4.4 y versiones posteriores admiten este tipo de instancia. dds.cs.mid: 1 núcleo, 2 GB (uso general). Solo las instancias que ejecutan MongoDB 4.2 y versiones anteriores admiten este tipo de instancia.
ConfigServer.N.Storage	Integer	Sí	20	Capacidad de almacenamiento del nodo Configserver. Unidad: GB. Nota Los valores que se pueden especificar para este parámetro dependen de los tipos de instancia. Para obtener más información, consulte Tipos de instancia.
StorageType	String	No	cloud_essd1	Tipo de almacenamiento de la instancia. Valores válidos: cloud_essd1: ESSD PL1. cloud_essd2: ESSD PL2. cloud_essd3: ESSD PL3. local_ssd: SSD local Nota Las instancias de MongoDB 4.4 y versiones posteriores solo admiten discos en la nube. Se selecciona cloud_essd1 si deja este parámetro vacío. Las instancias de MongoDB 4.2 y versiones anteriores solo admiten discos locales. Se selecciona local_ssd si deja este parámetro vacío.

Parámetros de respuesta

Parámetro	Tipo	Ejemplo	Descripción
RequestId	String	D8F1D721-6439-4257-A89C-F1E8E9C9****	ID de la solicitud.
DBInstanceId	String	dds-bp114f14849d****	ID de la instancia.
OrderId	String	21010996721****	ID del pedido.

Ejemplos

Solicitudes de ejemplo

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>

Respuestas exitosas de ejemplo

Formato 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>

Formato JSON

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

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

Códigos de error

Para obtener una lista de códigos de error, consulte Códigos de error del servicio.