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

Crea o clona una instancia de conjunto de réplicas de ApsaraDB for MongoDB.

Descripción de la operación

Antes de utilizar esta operación, asegúrese de comprender los métodos de facturación y los precios de ApsaraDB for MongoDB.

Para obtener información sobre las especificaciones de las instancias, consulte Especificaciones de las instancias.

Para crear una instancia de clúster fragmentado, llame a la operación CreateShardingDBInstance.

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

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. Nota Si llama a esta operación para clonar una instancia o restaurar una instancia clonada desde la papelera de reciclaje, establezca este parámetro con el mismo valor que el de la instancia de origen.	cn-hangzhou
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 debe asegurarse 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****
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
EngineVersion	string	Sí	La versión del motor de base de datos. Valores válidos: 8.0 7.0 6.0 5.0 4.4 4.2 4.0 Nota Si llama a esta operación para clonar una instancia o restaurar una instancia clonada desde la papelera de reciclaje, establezca este parámetro con el mismo valor que el de la instancia de origen. Aviso Las versiones 3.4 y anteriores ya no están disponibles para su compra.	4.4
DBInstanceClass	string	Sí	El tipo de instancia. Puede llamar a la operación DescribeAvailableResource para consultar los tipos de instancia disponibles.	dds.mongo.standard
DBInstanceStorage	integer	Sí	La capacidad de almacenamiento de la instancia. Unidad: GB. Los valores válidos dependen del tipo de instancia. Para obtener más detalles, consulte Especificaciones de instancias de conjunto de réplicas.	10
DBInstanceDescription	string	No	El nombre de la instancia. El nombre debe cumplir con los siguientes requisitos: Debe comenzar con un carácter chino o una letra. Puede contener dígitos, caracteres chinos, letras, guiones bajos (_), puntos (.) y guiones (-). Debe tener una longitud de 2 a 256 caracteres.	test
SecurityIPList	string	No	La lista blanca de IP de la instancia. Separe varias direcciones IP con comas (,). No se permiten direcciones IP duplicadas. Se admiten los siguientes formatos: 0.0.0.0/0 Formato de dirección IP, como 10.23.12.24. Formato de bloque CIDR, como 10.23.12.0/24. En este ejemplo, 24 indica que el prefijo del bloque CIDR tiene una longitud de 24 bits. La longitud del prefijo varía de 1 a 32. Nota Cada instancia admite un máximo de 1,000 direcciones IP o bloques CIDR en todos los grupos de listas blancas de IP. 0.0.0.0/0 permite que todas las direcciones IP accedan a la base de datos de la instancia. Esta es una configuración de alto riesgo. Proceda con precaución.	192.168.xx.xx,192.168.xx.xx
AccountPassword	string	No	La contraseña de la cuenta root. La contraseña debe cumplir con los siguientes requisitos: 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 !@#$%^&()_+-=. Debe tener una longitud de 8 a 32 caracteres. Nota* Para obtener información sobre cómo resolver los errores de conexión a la base de datos causados por caracteres especiales en la contraseña, consulte ¿Cómo resuelvo los errores de conexión a la base de datos causados por caracteres especiales en la cadena de conexión?.	123456Aa
Period	integer	No	La duración de la suscripción de la instancia. Unidad: meses. Valores válidos: 1 a 9 (números enteros), 12, 24, 36 y 60. Nota Este parámetro está disponible y es obligatorio cuando ChargeType se establece en PrePaid.	1
ChargeType	string	No	El método de facturación de la instancia. Valores válidos: PostPaid: valor predeterminado. Pago por uso. 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
NetworkType	string	No	El tipo de red de la instancia. Valores válidos: VPC: Virtual Private Cloud. Valores válidos: VPC : Virtual Private Cloud.	VPC
VpcId	string	No	El ID de la VPC.	vpc-bp175iuvg8nxqraf2****
VSwitchId	string	No	El ID del vSwitch.	vsw-bp1gzt31twhlo0sa5****
SrcDBInstanceId	string	No	El ID de la instancia de origen. Nota Si llama a esta operación para clonar una instancia, debe configurar este parámetro junto con el parámetro BackupId o RestoreTime. Si llama a esta operación para restaurar una instancia clonada desde la papelera de reciclaje, solo necesita configurar este parámetro. Los parámetros BackupId y RestoreTime no son obligatorios.	dds-bp1ee12ad351****
BackupId	string	No	El ID de la copia de seguridad. Puede invocar la operación DescribeBackups para consultar el ID de la copia de seguridad. Nota Este parámetro solo es obligatorio cuando invoca esta operación para clonar una instancia desde un punto de copia de seguridad. También debe configurar el parámetro SrcDBInstanceId.	32994****
RestoreTime	string	No	El punto en el tiempo al que se recuperará la instancia. Puede especificar cualquier punto en el tiempo dentro de los últimos 7 días. Especifique la hora en formato yyyy-MM-ddTHH:mm:ssZ. La hora debe estar en UTC. Nota Este parámetro solo es obligatorio cuando invoca esta operación para clonar una instancia en un punto en el tiempo. También debe configurar el parámetro SrcDBInstanceId.	2022-03-13T12:11:14Z
BusinessInfo	string	No	La información adicional sobre el negocio.	{“ActivityId":"000000000"}
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: valor predeterminado. Deshabilita la renovación automática. Debe renovar la instancia manualmente. Nota Este parámetro está disponible y es opcional cuando ChargeType se establece en PrePaid.	true
DatabaseNames	string	No	El nombre de la base de datos. Nota Cuando invoca esta operación para clonar una instancia, puede especificar este parámetro para clonar bases de datos específicas. Si no especifica este parámetro, se clonan todas las bases de datos.	mongodbtest
CouponNo	string	No	Especifica si se debe utilizar un cupón. Valores válidos: default o null (predeterminado): utiliza un cupón. youhuiquan_promotion_option_id_for_blank: no utiliza un cupón.	default
StorageEngine	string	No	El motor de almacenamiento de la instancia. El valor se fija como WiredTiger. Nota Si llama a esta operación para clonar una instancia o restaurar una instancia clonada desde la papelera de reciclaje, establezca este parámetro con el mismo valor que el de la instancia de origen. Para obtener información sobre las restricciones de los motores de almacenamiento y las versiones, consulte Versiones y motores de almacenamiento. Valores válidos: WiredTiger : Motor de almacenamiento WiredTiger.	WiredTiger
ReplicationFactor	string	No	El número de nodos primarios y secundarios en la instancia de conjunto de réplicas. Valores válidos: 3 (predeterminado) 5 7 Importante Este parámetro no es obligatorio para las instancias de un solo nodo.	3
ReadonlyReplicas	string	No	El número de nodos de solo lectura en la instancia de conjunto de réplicas. Valores válidos: 0 a 5 (números enteros). Valor predeterminado: 0.	0
Engine	string	No	El ID del grupo de recursos. Valores válidos: MongoDB : Motor de base de datos MongoDB.	rg-acfmyiu4ekp****
StorageType	string	No	El ID del clúster dedicado.	dhg-2x78****
SecondaryZoneId	string	No	El motor de base de datos. El valor se fija como MongoDB.	MongoDB
HiddenZoneId	string	No	El tipo de almacenamiento. Valores válidos: cloud_essd1: ESSD PL1. cloud_essd2: ESSD PL2. cloud_essd3: ESSD PL3. cloud_auto: disco ESSD AutoPL. local_ssd: SSD local. Nota Para las instancias de un solo nodo, si especifica cloud_essd1, la instancia utiliza un disco cloud_essd. Los discos ESSD AutoPL actualmente solo están disponibles en el sitio de China. Para las instancias que ejecutan la versión 4.4 o posterior, el valor predeterminado es cloud_essd1. Para las instancias que ejecutan la versión 4.2 o anterior, el valor predeterminado es local_ssd.	cloud_essd1
Tag	array<object>	No	La zona donde se despliega el nodo secundario para implementar el despliegue multizona. Valores válidos: 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. Nota Este parámetro está disponible cuando la instancia utiliza discos en la nube. El valor de este parámetro no puede ser igual a los valores de ZoneId y HiddenZoneId.	cn-hangzhou-h
	object	No
Key	string	No	La clave de la etiqueta. Nota N especifica el número 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 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
GlobalSecurityGroupIds	string	No	La zona donde se despliega el nodo oculto para implementar el despliegue multizona. Valores válidos: 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. Nota Este parámetro está disponible cuando la instancia utiliza discos en la nube. El valor de este parámetro no puede ser igual a los valores de ZoneId y SecondaryZoneId.	cn-hangzhou-i
Encrypted	boolean	No	Las etiquetas definidas por el usuario.	true
EncryptionKey	string	No	Las plantillas globales de lista blanca de IP para la instancia. Separe varias plantillas con comas (,). No se permiten plantillas duplicadas. (Esta función se encuentra en versión canary).	g-qxieqf40xjst1ngpr3jz
ProvisionedIops	integer	No	Especifica si se debe habilitar el cifrado de discos en la nube.	true
RestoreType	string	No	El ID de la clave personalizada.	2axxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
SrcRegion	string	No	El rendimiento aprovisionado (IOPS). Valores válidos: 0 a 50000.	1960

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object
RequestId	string	El ID de la solicitud.	D8F1D721-6439-4257-A89C-F1E8E9C9****
DBInstanceId	string	El ID de la instancia.	dds-bp144a7f2db8****
OrderId	string	El ID del pedido.	21077576248****

Ejemplos

Respuesta exitosa

JSON Formato

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

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	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.	El nombre del nodo no es válido.
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.	El parámetro Storage, Version o InstanceClass está vacío.
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.	Los parámetros de zona principal, zona secundaria 1 y zona secundaria 2 no pueden ser todos iguales.
400	SameZoneId	The specified primary zone, secondary zone require two different zones.	Los parámetros de zona principal y zona secundaria especificados deben ser diferentes.
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.	El recurso está agotado.
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.

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.