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 usar esta operação, certifique-se de compreender os métodos de cobrança e a precificação do ApsaraDB for MongoDB.

Para obter informações sobre as especificações da instância, consulte Especificações da 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

*Instância.

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. Você pode chamar a operação DescribeRegions para consultar o ID da região. Nota Se você chamar esta operação para clonar uma instância ou restaurar uma instância da lixeira, defina este parâmetro com o mesmo valor da instância de origem.	cn-hangzhou
ClientToken	string	Não	O token de cliente usado para garantir a idempotência da solicitação. Você pode usar o cliente para gerar o token, mas deve garantir que o token seja exclusivo entre diferentes solicitações. O token pode conter apenas caracteres ASCII e não pode exceder 64 caracteres de comprimento.	ETnLKlblzczshOTUbOCz****
ZoneId	string	Não	O ID da zona. Você pode chamar a operação DescribeRegions para consultar o ID da zona.	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 Se você chamar esta operação para clonar uma instância ou restaurar uma instância da lixeira, defina este parâmetro com o mesmo valor da instância de origem. Aviso As versões 3.4 e anteriores não estão mais disponíveis para compra.	4.4
DBInstanceClass	string	Sim	O tipo de instância. Você pode chamar a operação DescribeAvailableResource para consultar os tipos de instância disponíveis.	dds.mongo.standard
DBInstanceStorage	integer	Sim	A capacidade de armazenamento da instância. Unidade: GB. Os valores válidos dependem do tipo de instância. Para obter detalhes, consulte Especificações da 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 um caractere chinês ou uma letra. Pode conter dígitos, caracteres chineses, letras, sublinhados (_), pontos (.) e hifens (-). Deve ter de 2 a 256 caracteres de comprimento.	test
SecurityIPList	string	Não	A lista de permissões de IP da instância. Separe vários endereços IP com vírgulas (,). Endereços IP duplicados não são permitidos. Os seguintes formatos são suportados: 0.0.0.0/0 Formato de endereço IP, como 10.23.12.24. Formato de bloco CIDR, como 10.23.12.0/24. Neste exemplo, 24 indica que o prefixo do bloco CIDR tem 24 bits de comprimento. O comprimento do prefixo varia de 1 a 32. Nota Cada instância suporta no máximo 1.000 endereços IP ou blocos CIDR em todos os grupos de lista de permissões de IP. 0.0.0.0/0 permite que todos os endereços IP acessem o banco de dados da instância. Esta é uma configuração de alto risco. Prossiga 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 incluem !@#$%^&()_+-=. Deve ter de 8 a 32 caracteres de comprimento. Nota* Para obter informações sobre como resolver falhas de conexão com o banco de dados causadas por caracteres especiais na senha, consulte Como resolver falhas de conexão com o banco de dados causadas por caracteres especiais na string de conexão?.	123456Aa
Period	integer	Não	A duração da assinatura da instância. Unidade: meses. Valores válidos: 1 a 9 (inteiros), 12, 24, 36 e 60. Nota Este parâmetro está disponível e é obrigatório quando ChargeType é definido como PrePaid.	1
ChargeType	string	Não	O método de cobrança da instância. Valores válidos: PostPaid: valor padrão. Pós-pago. PrePaid: Assinatura. Nota Se você definir este parâmetro como PrePaid, também deverá configurar o parâmetro Period. Valores válidos: PostPaid : pós-pago. PrePaid : assinatura.	PrePaid
NetworkType	string	Não	O tipo de rede da instância. Valores válidos: VPC: Virtual Private Cloud. Valores válidos: VPC : Virtual Private Cloud.	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 Se você chamar esta operação para clonar uma instância, deverá configurar este parâmetro junto com o parâmetro BackupId ou RestoreTime. Se você chamar esta operação para restaurar uma instância da lixeira, precisará configurar apenas este parâmetro. Os parâmetros BackupId e RestoreTime não são obrigatórios.	dds-bp1ee12ad351****
BackupId	string	Não	O ID do backup. Você pode chamar a operação DescribeBackups para consultar o ID do backup. Nota Este parâmetro é obrigatório apenas quando você chama esta operação para clonar uma instância a partir de um ponto de backup. Você também deve configurar o parâmetro SrcDBInstanceId.	32994****
RestoreTime	string	Não	O ponto no tempo para o qual a instância será recuperada. Você pode especificar qualquer ponto no tempo dentro dos últimos 7 dias. Especifique a hora no formato aaaa-MM-ddTHH:mm:ssZ. A hora deve estar em UTC. Nota Este parâmetro é obrigatório apenas quando você chama esta operação para clonar uma instância para um ponto no tempo. Você também deve configurar o parâmetro SrcDBInstanceId.	2022-03-13T12:11:14Z
BusinessInfo	string	Não	As informações adicionais sobre o negócio.	{“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: valor padrão. Desativa a renovação automática. Você deve renovar a instância manualmente. Nota Este parâmetro está disponível e é opcional quando ChargeType é definido como PrePaid.	true
DatabaseNames	string	Não	O nome do banco de dados. Nota Ao chamar esta operação para 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 serão clonados.	mongodbtest
CouponNo	string	Não	Especifica se deve ser usado um cupom. 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 Se você chamar esta operação para clonar uma instância ou restaurar uma instância da lixeira, defina este parâmetro com o mesmo valor da instância de origem. Para obter informações sobre as restrições de mecanismos de armazenamento e versões, consulte Versões e mecanismos de armazenamento. Valores válidos: WiredTiger : Mecanismo de armazenamento WiredTiger.	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 Este parâmetro não é obrigatório para instâncias de nó único.	3
ReadonlyReplicas	string	Não	O número de nós somente leitura na instância de conjunto de réplicas. Valores válidos: 0 a 5 (inteiros). Valor padrão: 0.	0
Engine	string	Não	O ID do grupo de recursos. Valores válidos: MongoDB : Mecanismo de banco de dados MongoDB.	rg-acfmyiu4ekp****
StorageType	string	Não	O ID do cluster dedicado.	dhg-2x78****
SecondaryZoneId	string	Não	O mecanismo de banco de dados. O valor é fixo como MongoDB.	MongoDB
HiddenZoneId	string	Não	O tipo de armazenamento. 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 instâncias de nó único, se você especificar cloud_essd1, a instância usará um disco cloud_essd. Os discos ESSD AutoPL estão disponíveis atualmente apenas no site da China. Para instâncias executando a versão 4.4 ou posterior, o valor padrão é cloud_essd1. Para instâncias executando a versão 4.2 ou anterior, o valor padrão é local_ssd.	cloud_essd1
Tag	array<object>	Não	A zona onde o nó secundário é implantado para implementar a implantação 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 Singapura. ap-southeast-1b: Zona B de Singapura. ap-southeast-1c: Zona C de Singapura. ap-southeast-5a: Zona A de Jacarta. ap-southeast-5b: Zona B de Jacarta. ap-southeast-5c: Zona C de Jacarta. eu-central-1a: Zona A de Frankfurt. eu-central-1b: Zona B de Frankfurt. eu-central-1c: Zona C de Frankfurt. Nota Este parâmetro está disponível quando a instância usa discos em nuvem. O valor deste parâmetro não pode ser igual aos valores de ZoneId e HiddenZoneId.	cn-hangzhou-h
	object	Não
Key	string	Não	A chave da tag. Nota N especifica o número da tag. Por exemplo, Tag.1.Key especifica a chave da primeira tag e Tag.2.Key especifica a chave da segunda tag.	testdatabase
Value	string	Não	O valor da tag. Nota N especifica o número da tag. Por exemplo, Tag.1.Value especifica o valor da primeira tag e Tag.2.Value especifica o valor da segunda tag.	apitest
GlobalSecurityGroupIds	string	Não	A zona onde o nó oculto é implantado para implementar a implantação 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 Singapura. ap-southeast-1b: Zona B de Singapura. ap-southeast-1c: Zona C de Singapura. ap-southeast-5a: Zona A de Jacarta. ap-southeast-5b: Zona B de Jacarta. ap-southeast-5c: Zona C de Jacarta. eu-central-1a: Zona A de Frankfurt. eu-central-1b: Zona B de Frankfurt. eu-central-1c: Zona C de Frankfurt. Nota Este parâmetro está disponível quando a instância usa discos em nuvem. O valor deste parâmetro não pode ser igual aos valores de ZoneId e SecondaryZoneId.	cn-hangzhou-i
Encrypted	boolean	Não	As tags definidas pelo usuário.	true
EncryptionKey	string	Não	Os modelos globais de lista de permissões de IP para a instância. Separe vários modelos com vírgulas (,). Modelos duplicados não são permitidos. (Este recurso está em versão canary.)	g-qxieqf40xjst1ngpr3jz
ProvisionedIops	integer	Não	Especifica se a criptografia de disco em nuvem deve ser ativada.	true
RestoreType	string	Não	O ID da chave personalizada.	2axxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
SrcRegion	string	Não	O desempenho provisionado (IOPS). Valores válidos: 0 a 50000.	1960

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.	O nome do nó é invá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.	O parâmetro Storage, Version ou InstanceClass está vazio.
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.	Os parâmetros de zona primária, zona secundária 1 e zona secundária 2 não podem ser todos iguais.
400	SameZoneId	The specified primary zone, secondary zone require two different zones.	Os parâmetros de zona primária e zona secundária especificados devem 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.	O recurso está fora de uso.
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.