CreateShardingDBInstance - ApsaraDB for MongoDB - Centro de documentación de Alibaba Cloud

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

Descripción de la operación

Antes de llamar a esta operación, asegúrese de comprender completamente los métodos de facturación y los precios de ApsaraDB for MongoDB.
Para obtener más información sobre las especificaciones de las instancias de ApsaraDB for MongoDB, consulte Especificaciones de las instancias.
Para crear una instancia independiente o de conjunto de réplicas, llame a la operación CreateDBInstance.

Pruébelo ahora

Pruebe esta API en OpenAPI Explorer sin necesidad de firma manual. Las llamadas exitosas generan automáticamente código SDK acorde a sus parámetros. Descárguelo con seguridad de credenciales integrada para uso local.

Test

Autorización de RAM

La siguiente tabla describe la autorización necesaria para invocar esta API. Puede definirla en una directiva de Resource Access Management (RAM). A continuación, se detallan las columnas de la tabla:

Action: Estas acciones se utilizan en el elemento Action de las declaraciones de directivas de permisos de RAM para otorgar permisos que permitan realizar la operación.
API: La API que debe invocarse para llevar a cabo la acción.
Nivel de acceso: Nivel de acceso predefinido que se concede para cada API. Valores válidos: create, list, get, update y delete.
Tipo de recurso: Tipo de recurso que admite autorización para ejecutar la acción. Indica si la acción es compatible con permisos a nivel de recurso. El recurso especificado debe ser compatible con la acción; de lo contrario, la directiva no surtirá efecto.
- En las API con permisos a nivel de recurso, los tipos de recursos obligatorios se marcan con un asterisco (*). Especifique el Alibaba Cloud Resource Name (ARN) correspondiente en el elemento Resource de la directiva.
- Para las API sin permisos a nivel de recurso, se muestra All Resources. Utilice un asterisco (*) en el elemento Resource de la directiva.
Clave de condición: Claves de condición definidas por el servicio. Permiten un control granular y se aplican ya sea solo a acciones o a acciones asociadas con recursos específicos. Además de las claves de condición específicas del servicio, Alibaba Cloud proporciona un conjunto de common condition keys aplicables a todos los servicios compatibles con RAM.
Acción dependiente: Acciones dependientes necesarias para ejecutar la acción principal. Para completar la operación, el usuario de RAM o el rol de RAM debe contar con permisos para realizar todas las acciones dependientes.

Action

Nivel de acceso

Tipo de recurso

Clave de condición

Acción dependiente

dds:CreateShardingDBInstance

create

*Instance

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

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
RegionId	string	Sí	El ID de la región. Puede llamar a la operación DescribeRegions para consultar el ID de la región.	cn-hangzhou
ZoneId	string	No	El ID de la zona. Puede llamar a la operación DescribeRegions para consultar el ID de la zona.	cn-hangzhou-g
Engine	string	Sí	El motor de base de datos. Establezca el valor en MongoDB. Valores válidos: MongoDB : Motor de base de datos MongoDB.	MongoDB
EngineVersion	string	Sí	El número de versión de la base de datos. Valores válidos: 8.0 7.0 6.0 5.0 4.4 4.2 4.0 Nota Para obtener más información sobre las restricciones de los motores de almacenamiento y las versiones, consulte Versiones del motor de base de datos y motores de almacenamiento. Cuando llame a esta operación para clonar una instancia, establezca este parámetro en el mismo valor que la instancia de origen.	4.4
DBInstanceDescription	string	No	El nombre de la instancia. Valores válidos: El nombre debe comenzar con una letra. El nombre puede contener dígitos, letras, guiones bajos (_), puntos (.) y guiones (-). El nombre debe tener una longitud de 2 a 256 caracteres.	test
SecurityIPList	string	No	La lista blanca de direcciones IP de la instancia. Separe varias direcciones IP con comas (,). Las direcciones IP no pueden estar duplicadas. Se admiten los siguientes tres formatos: 0.0.0.0/0 Dirección IP, como 10.23.12.24. Bloque CIDR, como 10.23.12.0/24, donde 24 indica la longitud del prefijo en la dirección IP y el valor varía de 1 a 32. Nota Puede agregar hasta 1,000 direcciones IP o bloques CIDR a todos los grupos de listas blancas de direcciones IP de una instancia. Si establece este parámetro en 0.0.0.0/0, todas las direcciones IP pueden acceder a la instancia. Tenga precaución al utilizar esta configuración.	192.168.xx.xx,192.168.xx.xx
AccountPassword	string	No	La contraseña de la cuenta root. Valores válidos: La contraseña debe contener al menos tres de los siguientes tipos de caracteres: letras mayúsculas, letras minúsculas, dígitos y caracteres especiales. Los caracteres especiales incluyen !@#$%^&()_+-= La contraseña debe tener una longitud de 8 a 32 caracteres. Nota* Para obtener más información sobre cómo solucionar problemas de conexión a la base de datos causados por caracteres especiales en la cadena de conexión, consulte ¿Cómo soluciono los errores de conexión causados por caracteres especiales en la contraseña de la cuenta de una cadena de conexión?.	123456Aa
ChargeType	string	No	El método de facturación de la instancia. Valores válidos: PostPaid: pago por uso. Este es el valor predeterminado. PrePaid: suscripción. Nota Si establece este parámetro en PrePaid, también debe configurar el parámetro Period. Valores válidos: PostPaid : Pago por uso. PrePaid : Suscripción.	PrePaid
Period	integer	No	El periodo de suscripción de la instancia. Unidad: meses. Valores válidos: 1 a 9 (entero), 12, 24, 36 y 60. Nota Este parámetro está disponible y es obligatorio solo cuando establece ChargeType en PrePaid.	1
NetworkType	string	No	El tipo de red de la instancia. Valores válidos: VPC: nube privada virtual (VPC).	VPC
VpcId	string	No	El ID de la VPC.	vpc-bp1n3i15v90el48nx****
VSwitchId	string	No	El ID del vSwitch.	vsw-bp1vj604nj5a9zz74****
SrcDBInstanceId	string	No	El ID de la instancia de origen. Nota Este parámetro es obligatorio solo cuando llama a esta operación para clonar una instancia. También debe configurar el parámetro RestoreTime.	dds-bp11483712c1****
RestoreTime	string	No	El punto en el tiempo al que desea recuperar los datos. Puede especificar cualquier punto en el tiempo dentro de los últimos siete días. Especifique la hora en formato yyyy-MM-ddTHH:mm:ssZ (UTC). Nota Este parámetro es obligatorio solo cuando llama a esta operación para clonar una instancia. También debe configurar el parámetro SrcDBInstanceId.	2022-03-08T02:30:25Z
ClientToken	string	No	El token de cliente que se utiliza para garantizar la idempotencia de la solicitud. Puede utilizar el cliente para generar el token, pero asegúrese de que el token sea único entre las diferentes solicitudes. El token solo puede contener caracteres ASCII y no puede superar los 64 caracteres de longitud.	ETnLKlblzczshOTUbOCz****
StorageEngine	string	No	El motor de almacenamiento de la instancia. Establezca el valor en WiredTiger. Nota Cuando llame a esta operación para clonar una instancia, establezca este parámetro en el mismo valor que la instancia de origen. Para obtener más información sobre las restricciones de los motores de almacenamiento y las versiones, consulte Versiones del motor de base de datos y motores de almacenamiento.	WiredTiger
AutoRenew	string	No	Especifica si se debe habilitar la renovación automática para la instancia. Valores válidos: true: habilita la renovación automática. false: deshabilita la renovación automática. Debe renovar la instancia manualmente. Este es el valor predeterminado. Nota Este parámetro está disponible y es opcional solo cuando establece ChargeType en PrePaid.	true
ProtocolType	string	No	El tipo de protocolo de acceso. Valores válidos: mongodb: protocolo MongoDB. dynamodb: protocolo DynamoDB. Valores válidos: mongodb : Protocolo MongoDB. dynamodb : Protocolo DynamoDB.	mongodb
Mongos	array<object>	Sí	La información sobre los nodos Mongos.
	object	Sí	La información sobre los nodos Mongos.
Class	string	Sí	La especificación del nodo Mongos. Para obtener más información, consulte Especificaciones de instancias de clúster fragmentado. Nota N en el nombre del parámetro especifica el número de secuencia del nodo Mongos. Por ejemplo, Mongos.2.Class especifica la especificación del segundo nodo Mongos. Valores válidos de N: 2 a 32.	mdb.shard.2x.xlarge.d
ReplicaSet	array<object>	Sí	La información sobre los nodos Shard.
	object	No	La información sobre los nodos Shard.
Class	string	Sí	La especificación del nodo Shard. Para obtener más información, consulte Especificaciones de instancias de clúster fragmentado. Nota N en el nombre del parámetro especifica el número de secuencia del nodo Shard. Por ejemplo, ReplicaSet.2.Class especifica la especificación del segundo nodo Shard. Valores válidos de N: 2 a 32.	dds.shard.standard
Storage	integer	Sí	La capacidad de almacenamiento del nodo Shard. Unidad: GB. Nota Los valores válidos están sujetos a las especificaciones de la instancia. Para obtener más información, consulte Especificaciones de instancias de clúster fragmentado. N en el nombre del parámetro especifica el número de secuencia del nodo Shard. Por ejemplo, ReplicaSet.2.Storage especifica la capacidad de almacenamiento del segundo nodo Shard.	10
ReadonlyReplicas	integer	No	El número de nodos de solo lectura para el nodo Shard. Valores válidos: 0 a 5 (entero). Valor predeterminado: 0. Nota N en el nombre del parámetro especifica el número de secuencia del nodo Shard. Por ejemplo, ReplicaSet.2.ReadonlyReplicas especifica el número de nodos de solo lectura para el segundo nodo Shard.	0
ConfigServer	array<object>	Sí	La información sobre los nodos ConfigServer.
	object	No	La información sobre los nodos ConfigServer.
Class	string	Sí	La especificación del nodo ConfigServer. Valores válidos: mdb.shard.2x.xlarge.d: 4 vCPU, 8 GB de memoria (dedicado). Este valor solo se admite para instancias que ejecutan la versión 4.4 o posterior. dds.cs.mid: 1 vCPU, 2 GB de memoria (de propósito general). Este valor solo se admite para instancias que ejecutan la versión 4.2 o anterior.	mdb.shard.2x.xlarge.d
Storage	integer	Sí	La capacidad de almacenamiento del nodo ConfigServer. Unidad: GB. Nota Los valores válidos están sujetos a las especificaciones de la instancia. Para obtener más información, consulte Especificaciones de instancias de clúster fragmentado.	20
SecondaryZoneId	string	No	El ID del grupo de recursos. Para obtener más información, consulte Ver información básica de un grupo de recursos.	rg-acfmyiu4ekp****
HiddenZoneId	string	No	La zona secundaria 1 para el despliegue multizona. Valores válidos: cn-hangzhou-g: Zona G de Hangzhou. cn-hangzhou-h: Zona H de Hangzhou. cn-hangzhou-i: Zona I de Hangzhou. cn-hongkong-b: Zona B de Hong Kong (China). cn-hongkong-c: Zona C de Hong Kong (China). cn-hongkong-d: Zona D de Hong Kong (China). cn-wulanchabu-a: Zona A de Ulanqab. cn-wulanchabu-b: Zona B de Ulanqab. cn-wulanchabu-c: Zona C de Ulanqab. ap-southeast-1a: Zona A de Singapur. ap-southeast-1b: Zona B de Singapur. ap-southeast-1c: Zona C de Singapur. ap-southeast-5a: Zona A de Yakarta. ap-southeast-5b: Zona B de Yakarta. ap-southeast-5c: Zona C de Yakarta. eu-central-1a: Zona A de Fráncfort. eu-central-1b: Zona B de Fráncfort. eu-central-1c: Zona C de Fráncfort. Nota Este parámetro está disponible solo cuando la instancia utiliza discos en la nube. El valor de este parámetro no puede ser igual a los valores de ZoneId o HiddenZoneId. Para obtener más información sobre la estrategia de despliegue multizona para instancias de clúster fragmentado, consulte Crear una instancia de clúster fragmentado multizona.	cn-hangzhou-h
StorageType	string	No	La zona secundaria 2 para el despliegue multizona. Valores válidos: cn-hangzhou-g: Zona G de Hangzhou. cn-hangzhou-h: Zona H de Hangzhou. cn-hangzhou-i: Zona I de Hangzhou. cn-hongkong-b: Zona B de Hong Kong (China). cn-hongkong-c: Zona C de Hong Kong (China). cn-hongkong-d: Zona D de Hong Kong (China). cn-wulanchabu-a: Zona A de Ulanqab. cn-wulanchabu-b: Zona B de Ulanqab. cn-wulanchabu-c: Zona C de Ulanqab. ap-southeast-1a: Zona A de Singapur. ap-southeast-1b: Zona B de Singapur. ap-southeast-1c: Zona C de Singapur. ap-southeast-5a: Zona A de Yakarta. ap-southeast-5b: Zona B de Yakarta. ap-southeast-5c: Zona C de Yakarta. eu-central-1a: Zona A de Fráncfort. eu-central-1b: Zona B de Fráncfort. eu-central-1c: Zona C de Fráncfort. Nota Este parámetro está disponible solo cuando la instancia utiliza discos en la nube. El valor de este parámetro no puede ser igual a los valores de ZoneId o SecondaryZoneId. Para obtener más información sobre la estrategia de despliegue multizona para instancias de clúster fragmentado, consulte Crear una instancia de clúster fragmentado multizona.	cn-hangzhou-i
GlobalSecurityGroupIds	string	No	El tipo de almacenamiento. Valores válidos: cloud_essd1: ESSD PL1. cloud_essd2: ESSD PL2. cloud_essd3: ESSD PL3. local_ssd: SSD local. Nota Las instancias que ejecutan la versión 4.4 o posterior solo admiten discos en la nube. Si no especifica este parámetro, se utiliza cloud_essd1 de forma predeterminada. Las instancias que ejecutan la versión 4.2 o anterior solo admiten discos locales. Si no especifica este parámetro, se utiliza local_ssd de forma predeterminada.	cloud_essd1
Tag	array<object>	No	Las plantillas de lista blanca de direcciones IP globales de la instancia. Separe varias plantillas con comas (,). Las plantillas no pueden estar duplicadas.	g-qxieqf40xjst1ngpr3jz
	object	No	Las etiquetas personalizadas agregadas a la instancia.
Key	string	No	La clave de la etiqueta. Nota N especifica el número de serie de la etiqueta. Por ejemplo, Tag.1.Key especifica la clave de la primera etiqueta y Tag.2.Key especifica la clave de la segunda etiqueta.	testdatabase
Value	string	No	El valor de la etiqueta. Nota N especifica el número de serie de la etiqueta. Por ejemplo, Tag.1.Value especifica el valor de la primera etiqueta y Tag.2.Value especifica el valor de la segunda etiqueta.	apitest
Encrypted	boolean	No	Las etiquetas personalizadas.	true
EncryptionKey	string	No	Especifica si se debe habilitar el cifrado de discos en la nube.	true
ProvisionedIops	integer	No	El ID de la clave de cifrado personalizada.	2axxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
SrcRegion	string	No	Las IOPS aprovisionadas.	1960
BackupId	string	No	La región donde reside la instancia de origen. Nota Este parámetro es obligatorio cuando el tipo de recuperación de copia de seguridad es la reconstrucción de una instancia eliminada. Este parámetro es obligatorio cuando el tipo de recuperación de copia de seguridad es la clonación desde una copia de seguridad con redundancia geográfica.	cn-beijing
RestoreType	string	No	El ID de la copia de seguridad del clúster. Nota Este parámetro es obligatorio solo cuando RestoreType se establece en 2 o 3.	cb-xxx
DestRegion	string	No	El tipo de recuperación de copia de seguridad. Valores válidos: 1: Recuperar la instancia a un punto en el tiempo especificado. 2: Recuperar una instancia liberada desde un conjunto de copias de seguridad especificado. 3: Recuperar la instancia desde un conjunto de copias de seguridad con redundancia geográfica especificado.	1

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Los parámetros de respuesta.
RequestId	string	El ID de la solicitud.	D8F1D721-6439-4257-A89C-F1E8E9C9****
DBInstanceId	string	El ID de la instancia.	dds-bp114f14849d****
OrderId	string	El ID del pedido.	21010996721****

Ejemplos

Respuesta exitosa

JSON Formato

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

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error	Descripción
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.	El parámetro de entrada no es válido.
400	RestoreTypeNotSupported	The specified restoreType is not supported for the instance, check the input parameters 'RestoreType/BackupID/RestoreTime'.	El tipo de restauración de instancia especificado no es compatible. Verifique los parámetros de entrada RestoreType, BackupID y RestoreTime.
500	VpcServiceError	Invoke vpc service error.	Ocurrió un error al llamar al servicio VPC.
403	InvalidBackupLogStatus	Current backup log enable status does not support this operation.
403	ReduceDiskNotSupport	Reduce disk size is not supported in clone/restore.	No se admite la reducción del espacio en disco en la nube para la clonación o restauración de instancias.

Consulte Códigos de error para ver la lista completa.

Notas de la versión

Consulte Notas de la versión para ver la lista completa.