Todos os produtos
Search
Central de documentação

:CreateDBInstance

Última atualização: Jul 08, 2026

Use a operação CreateDBInstance para criar ou clonar uma instância de conjunto de réplicas do ApsaraDB for MongoDB.

Antes de usar esta operação, verifique se você compreende os métodos de faturamento e os preços do ApsaraDB for MongoDB.

Para mais informações sobre os tipos de instância do ApsaraDB for MongoDB, consulte Tipos de instância.

Para criar uma instância de cluster com sharding, use a operação CreateShardingDBInstance.

Depuração

Use esta operação no OpenAPI Explorer para simplificar o processo. O OpenAPI Explorer calcula automaticamente a assinatura e gera códigos de exemplo do SDK para chamadas bem-sucedidas.

Parâmetros da solicitação

Name Type Required Example Description
Action String Yes CreateDBInstance

Parâmetro obrigatório. Defina o valor como CreateDBInstance.

RegionId String Yes cn-hangzhou

ID da região da instância. Use a operação DescribeRegions para consultar o ID da região.

ClientToken String No ETnLKlblzczshOTUbOCz****

Token de cliente usado para garantir a idempotência da solicitação. O cliente gera o token, mas é necessário garantir que ele seja único entre diferentes solicitações. O token pode conter apenas caracteres ASCII e não deve exceder 64 caracteres.

ZoneId String No cn-hangzhou-g

ID da zona da instância. Use a operação DescribeRegions para consultar o ID da zona.

Engine String Yes MongoDB

Mecanismo de banco de dados. Defina o valor como MongoDB.

EngineVersion String Yes 4.4

Versão do banco de dados. Valores válidos:

  • 5.0
  • 4.4
  • 4.2
  • 4.0
  • 3.4
Nota Ao usar esta operação para clonar uma instância, o valor deste parâmetro deve corresponder ao valor da instância de origem.
DBInstanceClass String Yes dds.mongo.standard

Tipo da instância. Use a operação DescribeAvailableResource para consultar os tipos de instância.

DBInstanceStorage Integer Yes 10

Capacidade de armazenamento da instância. Unidade: GB.

O valor deste parâmetro depende do tipo da instância. Para mais informações, consulte Tipos de instância de conjunto de réplicas.

DBInstanceDescription String No test

Nome da instância. O nome deve atender aos seguintes requisitos:

  • Deve começar com um caractere chinês ou uma letra.
  • Pode conter dígitos, caracteres chineses, letras, sublinhados (_) e hifens (-).
  • Deve ter de 2 a 256 caracteres.
SecurityIPList String No 192.168.xx.xx,192.168.xx.xx

Endereços IP na lista de permissões de IP da instância. Separe vários endereços IP com vírgulas (,). Não adicione endereços IP duplicados. Os seguintes formatos são suportados:

  • 0.0.0.0/0
  • Um endereço IP, como 10.23.12.24.
  • Um bloco CIDR, como 10.23.12.0/24. O /24 no bloco CIDR indica que o prefixo do endereço IP tem 24 bits. É possível especificar um valor de 1 a 32 para o comprimento do prefixo.
    Nota
    • É possível adicionar no máximo 1.000 endereços IP ou blocos CIDR por instância.
    • Se você definir a lista de permissões como 0.0.0.0/0, todos os endereços IP poderão acessar a instância. Esta é uma configuração de alto risco. Configure-a com cautela.
AccountPassword String No 123456Aa

Senha da conta root. A senha deve atender aos seguintes requisitos:

  • Deve conter pelo menos três dos seguintes tipos de caracteres: letras maiúsculas, letras minúsculas, dígitos e caracteres especiais.
  • Os caracteres especiais incluem !#$%^&*()_+-=
  • Deve ter de 8 a 32 caracteres.
ChargeType String No PrePaid

Método de faturamento da instância. Valores válidos:

  • PostPaid: pagamento conforme o uso. Este é o valor padrão.
  • PrePaid: assinatura.
Nota Se você definir este parâmetro como PrePaid, também deverá especificar o parâmetro Period.
Period Integer No 1

Duração da assinatura da instância. Unidade: mês.

Valores válidos: 1 a 9 (inteiro), 12, 24, 36 e 60.

Nota Este parâmetro está disponível e é obrigatório apenas quando você define o parâmetro ChargeType como PrePaid.
NetworkType String No VPC

Tipo de rede da instância. Valor válido:

VPC: VPC.

VpcId String Yes vpc-bp175iuvg8nxqraf2****

ID da VPC.

VSwitchId String Yes vsw-bp1gzt31twhlo0sa5****

ID do vSwitch.

SrcDBInstanceId String No dds-bp1ee12ad351****

ID da instância de origem.

Nota Especifique este parâmetro e o parâmetro BackupId ou RestoreTime apenas ao clonar uma instância.
BackupId String No 32994****

ID do ponto de backup. Use a operação DescribeBackups para consultar o ID do ponto de backup.

Nota Especifique este parâmetro e o parâmetro SrcDBInstanceId apenas ao clonar uma instância a partir de um ponto de backup.
RestoreTime String No 2022-03-13T12:11:14Z

Ponto no tempo para o qual você deseja restaurar os dados. É possível especificar qualquer ponto dentro dos últimos sete dias. Especifique a hora no formato aaaa-MM-ddTHH:mm:ssZ. A hora deve estar em UTC.

Nota Especifique este parâmetro e o parâmetro SrcDBInstanceId apenas ao clonar uma instância para um ponto específico no tempo.
BusinessInfo String No {“ActivityId":"000000000"}

Informações comerciais. Este é um parâmetro adicional.

AutoRenewStringDisabledtrue

Define se a renovação automática deve ser ativada para a instância. Valores válidos:

  • true: a renovação automática está ativada.
  • false: a renovação automática está desativada. Este é o valor padrão.
Nota Este parâmetro está disponível e é opcional apenas quando você define o parâmetro ChargeType como PrePaid.
DatabaseNames String No mongodbtest

Nome do banco de dados.

Nota Ao clonar uma instância, especifique este parâmetro para clonar apenas os bancos de dados indicados. Se você não especificar este parâmetro, todos os bancos de dados da instância de origem serão clonados.
CouponNo String No youhuiquan_promotion_option_id_for_blank

Código do cupom. O valor padrão é youhuiquan_promotion_option_id_for_blank.

StorageEngine String No WiredTiger

Mecanismo de armazenamento da instância. Valores válidos:

  • WiredTiger (padrão)
  • RocksDB
  • TerarkDB
Nota
  • Ao clonar uma instância, o mecanismo de armazenamento da nova instância deve ser igual ao da instância de origem.
  • Para mais informações sobre as restrições de versões de banco de dados e mecanismos de armazenamento, consulte Versões e mecanismos de armazenamento.
ReplicationFactor String No 3

Número de nós na instância de conjunto de réplicas. Valores válidos:

  • 3 (padrão)
  • 5
  • 7
ReadonlyReplicas String No 0

Número de nós somente leitura na instância de conjunto de réplicas. Valores válidos: 0 a 5 (inteiro). O valor padrão é 0.

StorageType String No cloud_essd1

Tipo de armazenamento da instância. Valores válidos:

  • cloud_essd1: ESSD PL1.
  • cloud_essd2: ESSD PL2.
  • cloud_essd3: ESSD PL3.
  • local_ssd: SSD local.

Dados de retorno

Name

Type

Example

Description

RequestId

String

D8F1D721-6439-4257-A89C-F1E8E9C9****

ID da solicitação.

DBInstanceId

String

dds-bp144a7f2db8****

ID da instância.

OrderId

String

21077576248****

ID do pedido.

Exemplos

Exemplo de solicitação

http(s)://mongodb.aliyuncs.com/?Action=CreateDBInstance
&RegionId=cn-hangzhou
&ClientToken=ETnLKlblzczshOTUbOCz****
&ZoneId=cn-hangzhou-g
&Engine=MongoDB
&EngineVersion=4.4
&DBInstanceClass=dds.mongo.standard
&DBInstanceStorage=10
&DBInstanceDescription=test
&SecurityIPList=192.168.xx.xx,192.168.xx.xx
&AccountPassword=123456Aa
&ChargeType=PrePaid
&Period=1
&NetworkType=VPC
&VpcId=vpc-bp175iuvg8nxqraf2****
&VSwitchId=vsw-bp1gzt31twhlo0sa5****
&BusinessInfo={“ActivityId":"000000000"}
&AutoRenew=true
&CouponNo=youhuiquan_promotion_option_id_for_blank
&StorageEngine=WiredTiger
&ReplicationFactor=3
&ReadonlyReplicas=0
&StorageType=cloud_essd1
&Common request parameters

Exemplos de resposta

Formato XML

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

<CreateDBInstanceResponse>
    <RequestId>D8F1D721-6439-4257-A89C-F1E8E9C9****</RequestId>
    <DBInstanceId>dds-bp144a7f2db8****</DBInstanceId>
    <OrderId>21077576248****</OrderId>
</CreateDBInstanceResponse>

Formato JSON

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

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

Códigos de erro

HttpCode

Error code

Error message

Description

400

InvalidDBInstanceDescription.Malformed

Specified parameter DBInstanceDescription is not valid.

O nome do nó é inválido.

400

InsufficientBalance

Your account does not have enough balance.

O pagamento falhou. Adicione outro método de pagamento ou fundos à sua conta e tente novamente.

400

InvalidCapacity.NotFound

The Capacity provided does not exist in our records.

A capacidade de armazenamento especificada para a instância é inválida. Defina um valor válido. Unidade: MB.

400

IdempotentParameterMismatch

Request uses a client token in a previous request but is not identical to that request.

O ClientToken especificado já foi utilizado. Especifique um ClientToken que ainda não tenha sido usado. O cliente gera o token, mas é necessário garantir que ele seja único entre diferentes solicitações. O token pode conter apenas caracteres ASCII e não deve exceder 64 caracteres.

403

RealNameAuthenticationError

Your account has not passed the real-name authentication yet.

Sua conta Alibaba Cloud não passou pela verificação de identidade. Conclua a verificação de identidade e tente novamente.

403

IncorrectBackupSetState

Current backup set state does not support operations.

O conjunto de backup mais recente não está pronto. Tente novamente mais tarde.

Para obter uma lista de códigos de erro, visite a Central de Erros de API.