CreateDBInstance - ApsaraDB for MongoDB: Central de Documentação do Alibaba Cloud

Cria ou clona uma instância de conjunto de réplicas do ApsaraDB for MongoDB.

Descrição da operação

Antes de chamar esta operação, certifique-se de compreender os métodos de cobrança e os preços do ApsaraDB for MongoDB.

Para obter 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 fragmentado, chame a operação CreateShardingDBInstance.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

dds:CreateDBInstance

create

*Instance

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

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
RegionId	string	Sim	O ID da região. Para consultar o ID da região, chame a operação DescribeRegions. Nota Ao clonar uma instância ou restaurar uma instância da lixeira, este parâmetro deve ser igual ao ID da região da instância de origem.	cn-hangzhou
ClientToken	string	Não	Um token de cliente usado para garantir a idempotência da solicitação. Você pode usar o cliente para gerar o token. Certifique-se de que o token seja exclusivo entre diferentes solicitações. O token pode conter apenas caracteres ASCII e não pode ter mais de 64 caracteres.	ETnLKlblzczshOTUbOCz****
ZoneId	string	Não	O ID da zona. Para consultar o ID da zona, chame a operação DescribeRegions.	cn-hangzhou-g
EngineVersion	string	Sim	A versão do mecanismo de banco de dados. Valores válidos: 8.0 7.0 6.0 5.0 4.4 4.2 4.0 Nota Ao clonar uma instância ou restaurar uma instância da lixeira, este parâmetro deve ser igual à versão do mecanismo da instância de origem. Aviso As versões 3.4 e anteriores foram descontinuadas.	4.4
DBInstanceClass	string	Sim	O tipo de instância. Para consultar os tipos de instância, chame a operação DescribeAvailableResource.	dds.mongo.standard
DBInstanceStorage	integer	Sim	O espaço de armazenamento da instância em GB. O valor deste parâmetro varia de acordo com o tipo de instância. Para obter mais informações, consulte Tipos de instância de conjunto de réplicas.	10
DBInstanceDescription	string	Não	O nome da instância. O nome deve atender aos seguintes requisitos: Deve começar com uma letra ou um caractere chinês. Pode conter letras, caracteres chineses, dígitos, sublinhados (_), pontos (.) e hifens (-). Deve ter de 2 a 256 caracteres.	test
SecurityIPList	string	Não	A lista de permissões de endereços IP da instância. Separe vários endereços IP com vírgulas (,). Cada endereço IP na lista de permissões deve ser exclusivo. A lista de permissões pode estar em um dos seguintes formatos: 0.0.0.0/0 Um endereço IP, por exemplo, 10.23.12.24. Um bloco CIDR, por exemplo, 10.23.12.0/24. O /24 indica que o prefixo do bloco CIDR tem 24 bits de comprimento. Você pode definir o prefixo com um valor de 1 a 32. Nota Você pode adicionar no máximo 1.000 endereços IP ou blocos CIDR a todas as listas de permissões de endereços IP. 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. Use com cautela.	192.168.xx.xx,192.168.xx.xx
AccountPassword	string	Não	A 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 são !@#$%^&()_+-= Deve ter de 8 a 32 caracteres. Nota* Para obter mais informações sobre falhas de conexão causadas por caracteres especiais em senhas, consulte Como corrigir uma falha de conexão causada por caracteres especiais em uma senha?.	123456Aa
Period	integer	Não	A duração da assinatura da instância em meses. Valores válidos: 1 a 9 (números inteiros), 12, 24, 36 e 60. Nota Este parâmetro é obrigatório e entra em vigor apenas quando você define o parâmetro ChargeType como PrePaid.	1
ChargeType	string	Não	O método de cobrança da instância. Valores válidos: PostPaid: O valor padrão. Pós-pago. PrePaid: Assinatura. Nota Se você definir este parâmetro como PrePaid, também deverá especificar o parâmetro Period.	PrePaid
NetworkType	string	Não	O tipo de rede da instância. Valores válidos: VPC: nuvem privada virtual (VPC).	VPC
VpcId	string	Não	O ID da VPC.	vpc-bp175iuvg8nxqraf2****
VSwitchId	string	Não	O ID do vSwitch.	vsw-bp1gzt31twhlo0sa5****
SrcDBInstanceId	string	Não	O ID da instância de origem. Nota Ao clonar uma instância, você deve especificar este parâmetro e o parâmetro BackupId ou RestoreTime. Ao restaurar uma instância da lixeira, você só precisa especificar este parâmetro. Não é necessário especificar o parâmetro BackupId ou RestoreTime.	dds-bp1ee12ad351****
BackupId	string	Não	O ID do ponto de backup. Para consultar o ID do ponto de backup, chame a operação DescribeBackups. Nota Você deve especificar este parâmetro e o parâmetro SrcDBInstanceId apenas ao clonar uma instância com base em um ponto de backup.	32994****
RestoreTime	string	Não	O ponto no tempo para o qual você deseja restaurar a instância. Você pode especificar qualquer ponto no tempo dentro dos últimos sete dias. O horário deve estar no formato aaaa-MM-ddTHH:mm:ssZ e em UTC. Nota Você deve especificar este parâmetro e o parâmetro SrcDBInstanceId apenas ao clonar uma instância com base em um ponto no tempo.	2022-03-13T12:11:14Z
BusinessInfo	string	Não	As informações comerciais. Este é um parâmetro opcional.	{“ActivityId":"000000000"}
AutoRenew	string	Não	Especifica se a renovação automática deve ser ativada para a instância. Valores válidos: true: Ativa a renovação automática. false: O valor padrão. Desativa a renovação automática. Você deve renovar a instância manualmente. Nota Este parâmetro é opcional e entra em vigor apenas quando você define o parâmetro ChargeType como PrePaid.	true
DatabaseNames	string	Não	O nome do banco de dados. Nota Ao clonar uma instância, você pode especificar este parâmetro para clonar bancos de dados específicos. Se você não especificar este parâmetro, todos os bancos de dados da instância serão clonados.	mongodbtest
CouponNo	string	Não	Especifica se um cupom deve ser usado. Valores válidos: default ou null (padrão): Usa um cupom. youhuiquan_promotion_option_id_for_blank: Não usa um cupom.	default
StorageEngine	string	Não	O mecanismo de armazenamento da instância. O valor é fixo como WiredTiger. Nota Ao clonar uma instância ou restaurar uma instância da lixeira, este parâmetro deve ser igual ao mecanismo de armazenamento da instância de origem. Para obter mais informações sobre as restrições de mecanismos de armazenamento e versões de banco de dados, consulte Versões e mecanismos de armazenamento.	WiredTiger
ReplicationFactor	string	Não	O número de nós primários e secundários na instância de conjunto de réplicas. Valores válidos: 3 (padrão) 5 7 Importante Não é necessário especificar este parâmetro para instâncias autônomas.	3
ReadonlyReplicas	string	Não	O número de nós somente leitura na instância de conjunto de réplicas. Os valores válidos são números inteiros de 0 a 5. O valor padrão é 0.	0
Engine	string	Não	O mecanismo de banco de dados. O valor é fixo como MongoDB.	MongoDB
StorageType	string	Não	A classe de armazenamento. Valores válidos: cloud_essd1: Disco ESSD PL1. cloud_essd2: Disco ESSD PL2. cloud_essd3: Disco ESSD PL3. cloud_auto: Disco ESSD AutoPL. local_ssd: SSD local. Nota Para instâncias autônomas, se você passar o valor cloud_essd1, um disco ESSD será usado. Os discos ESSD AutoPL estão disponíveis apenas no site da China (aliyun.com). Para instâncias da versão 4.4 ou posterior, o valor padrão é cloud_essd1. Para instâncias da versão 4.2 ou anterior, o valor padrão é local_ssd.	cloud_essd1
SecondaryZoneId	string	Não	A zona onde o nó secundário está implantado. Este parâmetro é usado para implantação em várias zonas. Valores válidos: cn-hangzhou-g: Zona G em Hangzhou. cn-hangzhou-h: Zona H em Hangzhou. cn-hangzhou-i: Zona I em Hangzhou. cn-hongkong-b: Zona B em Hong Kong (China). cn-hongkong-c: Zona C em Hong Kong (China). cn-hongkong-d: Zona D em Hong Kong (China). cn-wulanchabu-a: Zona A em Ulanqab. cn-wulanchabu-b: Zona B em Ulanqab. cn-wulanchabu-c: Zona C em Ulanqab. ap-southeast-1a: Zona A em Singapura. ap-southeast-1b: Zona B em Singapura. ap-southeast-1c: Zona C em Singapura. ap-southeast-5a: Zona A em Jacarta. ap-southeast-5b: Zona B em Jacarta. ap-southeast-5c: Zona C em Jacarta. eu-central-1a: Zona A em Frankfurt. eu-central-1b: Zona B em Frankfurt. eu-central-1c: Zona C em Frankfurt. Nota Este parâmetro está disponível quando a instância usa discos. O valor deste parâmetro não pode ser igual ao valor do parâmetro ZoneId ou HiddenZoneId.	cn-hangzhou-h
HiddenZoneId	string	Não	A zona onde o nó oculto está implantado. Este parâmetro é usado para implantação em várias zonas. Valores válidos: cn-hangzhou-g: Zona G em Hangzhou. cn-hangzhou-h: Zona H em Hangzhou. cn-hangzhou-i: Zona I em Hangzhou. cn-hongkong-b: Zona B em Hong Kong (China). cn-hongkong-c: Zona C em Hong Kong (China). cn-hongkong-d: Zona D em Hong Kong (China). cn-wulanchabu-a: Zona A em Ulanqab. cn-wulanchabu-b: Zona B em Ulanqab. cn-wulanchabu-c: Zona C em Ulanqab. ap-southeast-1a: Zona A em Singapura. ap-southeast-1b: Zona B em Singapura. ap-southeast-1c: Zona C em Singapura. ap-southeast-5a: Zona A em Jacarta. ap-southeast-5b: Zona B em Jacarta. ap-southeast-5c: Zona C em Jacarta. eu-central-1a: Zona A em Frankfurt. eu-central-1b: Zona B em Frankfurt. eu-central-1c: Zona C em Frankfurt. Nota Este parâmetro está disponível quando a instância usa discos. O valor deste parâmetro não pode ser igual ao valor do parâmetro ZoneId ou SecondaryZoneId.	cn-hangzhou-i
Tag	array<object>	Não	As tags personalizadas.
	object	Não	The custom tags added to the instance.
Key	string	Não	The tag key. Nota N specifies the Nth tag. For example, Tag.1.Key specifies the key of the first tag, and Tag.2.Key specifies the key of the second tag.	testdatabase
Value	string	Não	The tag value. Nota N specifies the Nth tag. For example, Tag.1.Value specifies the value of the first tag, and Tag.2.Value specifies the value of the second tag.	apitest
GlobalSecurityGroupIds	string	Não	Os modelos globais de lista de permissões de endereços IP para a instância. Separe vários modelos com vírgulas (,). Os modelos não podem ser repetidos. Este recurso está em versão canário.	g-qxieqf40xjst1ngpr3jz
Encrypted	boolean	Não	Especifica se a criptografia de disco deve ser ativada.	true
EncryptionKey	string	Não	O ID da chave personalizada.	2axxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
ProvisionedIops	integer	Não	As IOPS provisionadas (operações de entrada/saída por segundo). Valores válidos: 0 a 50000.	1960
RestoreType	string	Não	O método para restaurar uma instância a partir de um backup. 0: Restaura a instância para um conjunto de backup especificado. 1: Restaura a instância para um ponto no tempo especificado. 2: Restaura uma instância liberada para um conjunto de backup especificado. 3: Restaura a instância para um conjunto de backup com redundância geográfica especificado.	0
SrcRegion	string	Não	A região onde a instância de origem está localizada. Nota Este parâmetro é obrigatório quando RestoreType é definido como 2 ou 3.	2

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
RequestId	string	O ID da solicitação.	D8F1D721-6439-4257-A89C-F1E8E9C9****
DBInstanceId	string	O ID da instância.	dds-bp144a7f2db8****
OrderId	string	O ID do pedido.	21077576248****

Exemplos

Resposta de sucesso

JSON formato

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

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
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.	Invalid node name.
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.	Storage or Version or InstanceClass is empty.
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.	The parameters of the primary zone, secondary zone and hidden zone cannot be the same.
400	SameZoneId	The specified primary zone, secondary zone require two different zones.	The specified primary zone, secondary zone require two different zones.
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.
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 Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.