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

Cria ou clona uma instância de cluster sharded do 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 standalone ou de conjunto de réplicas, você pode chamar a operação CreateDBInstance.

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

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. Você pode chamar a operação DescribeRegions para consultar o ID da região.	cn-hangzhou
ZoneId	string	Não	O ID da zona. Você pode chamar a operação DescribeRegions para consultar o ID da zona.	cn-hangzhou-g
Engine	string	Sim	O mecanismo de banco de dados. Defina o valor como MongoDB.	MongoDB
EngineVersion	string	Sim	A versão do banco de dados. Valores válidos: 8.0 7.0 6.0 5.0 4.4 4.2 4.0 Nota 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. Ao clonar uma instância chamando esta operação, o valor deste parâmetro deve ser igual ao da instância de origem.	4.4
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 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 único. Os seguintes formatos são suportados: 0.0.0.0/0 Endereços IP, como 10.23.12.24. Blocos CIDR, como 10.23.12.0/24. A parte /24 indica o comprimento do prefixo do bloco CIDR. O comprimento do prefixo varia 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. A entrada 0.0.0.0/0 permite o acesso de todos os endereços IP. Esta é uma configuração de alto risco. Configure-a 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 causadas por caracteres especiais em senhas, consulte Como corrigir falhas de conexão causadas por caracteres especiais em uma senha?.	123456Aa
ChargeType	string	Não	O método de cobrança da instância. Valores válidos: PostPaid: pós-pago. Este é o valor padrão. PrePaid: assinatura. Nota Se você definir este parâmetro como PrePaid, também deverá especificar o parâmetro Period.	PrePaid
Period	integer	Não	A 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 é obrigatório e entra em vigor apenas quando você define o parâmetro ChargeType como PrePaid.	1
NetworkType	string	Não	O tipo de rede da instância. Valores válidos: VPC: nuvem privada virtual.	VPC
VpcId	string	Não	O ID da nuvem privada virtual (VPC).	vpc-bp1n3i15v90el48nx****
VSwitchId	string	Não	O ID do switch virtual.	vsw-bp1vj604nj5a9zz74****
SrcDBInstanceId	string	Não	O ID da instância de origem. Nota Este parâmetro é obrigatório apenas quando você clona uma instância chamando esta operação. Você também deve especificar o parâmetro RestoreTime.	dds-bp11483712c1****
RestoreTime	string	Não	O ponto no tempo para o qual você deseja restaurar os dados. Você pode especificar qualquer ponto no tempo dentro dos últimos sete dias. O horário está no formato aaaa-MM-ddTHH:mm:ssZ. O horário está no Tempo Universal Coordenado (UTC). Nota Este parâmetro é obrigatório apenas quando você clona uma instância chamando esta operação. Você também deve especificar o parâmetro SrcDBInstanceId.	2022-03-08T02:30:25Z
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, 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****
StorageEngine	string	Não	O mecanismo de armazenamento da instância. Defina o valor como WiredTiger. Nota Ao clonar uma instância chamando esta operação, o valor deste parâmetro deve ser igual ao 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
AutoRenew	string	Não	Especifica 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. Você deve renovar a instância manualmente. Este é o valor padrão. Nota Este parâmetro é opcional e entra em vigor apenas quando você define o parâmetro ChargeType como PrePaid.	true
ProtocolType	string	Não	O tipo de protocolo da instância. Valores válidos: mongodb: Protocolo MongoDB. dynamodb: Protocolo DynamoDB.	mongodb
Mongos	array<object>	Sim	As informações dos nós Mongos.
	object	Sim	As informações dos nós Mongos.
Class	string	Sim	O tipo de instância do nó Mongos. Para obter mais informações, consulte Tipos de instância de cluster sharded. Nota N no nome do parâmetro especifica o número de série do nó Mongos. Por exemplo, Mongos.2.Class especifica o tipo de instância do segundo nó Mongos. O valor de N varia de 2 a 32.	mdb.shard.2x.xlarge.d
ReplicaSet	array<object>	Sim	As informações dos nós de shard.
	object	Não	As informações dos nós de shard.
Class	string	Sim	O tipo de instância do nó de shard. Para obter mais informações, consulte Tipos de instância de cluster sharded. Nota N no nome do parâmetro especifica o número de série do nó de shard. Por exemplo, ReplicaSet.2.Class especifica o tipo de instância do segundo nó de shard. O valor de N varia de 2 a 32.	dds.shard.standard
Storage	integer	Sim	O espaço de armazenamento do nó de shard. Unidade: GB. Nota O valor deste parâmetro é restrito pelo tipo de instância. Para obter mais informações, consulte Tipos de instância de cluster sharded. N no nome do parâmetro especifica o número de série do nó de shard. Por exemplo, ReplicaSet.2.Storage especifica o espaço de armazenamento do segundo nó de shard.	10
ReadonlyReplicas	integer	Não	O número de nós somente leitura no nó de shard. Valores válidos: 0 a 5. O valor padrão é 0. Nota N no nome do parâmetro especifica o número de série do nó de shard. Por exemplo, ReplicaSet.2.ReadonlyReplicas especifica o número de nós somente leitura no segundo nó de shard.	0
ConfigServer	array<object>	Sim	As informações dos nós Configserver.
	object	Não	As informações dos nós Configserver.
Class	string	Sim	O tipo de instância do nó Configserver. Valores válidos: mdb.shard.2x.xlarge.d: 4 núcleos e 8 GB (dedicado). Este tipo de instância está disponível apenas para instâncias que executam o MongoDB 4.4 ou posterior. dds.cs.mid: 1 núcleo e 2 GB (uso geral). Este tipo de instância está disponível apenas para instâncias que executam o MongoDB 4.2 ou anterior.	mdb.shard.2x.xlarge.d
Storage	integer	Sim	O espaço de armazenamento do nó Configserver. Unidade: GB. Nota O valor deste parâmetro é restrito pelo tipo de instância. Para obter mais informações, consulte Tipos de instância de cluster sharded.	20
SecondaryZoneId	string	Não	A zona secundária 1 para 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 para instâncias baseadas em disco. O valor deste parâmetro não pode ser igual ao valor de ZoneId ou HiddenZoneId. Para obter mais informações sobre a política de implantação multizona para instâncias de cluster sharded, consulte Criar uma instância de cluster sharded multizona.	cn-hangzhou-h
HiddenZoneId	string	Não	A zona secundária 2 para 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 para instâncias baseadas em disco. O valor deste parâmetro não pode ser igual ao valor de ZoneId ou SecondaryZoneId. Para obter mais informações sobre a política de implantação multizona para instâncias de cluster sharded, consulte Criar uma instância de cluster sharded multizona.	cn-hangzhou-i
StorageType	string	Não	O tipo de armazenamento. Valores válidos: cloud_essd1: SSD aprimorado (ESSD) PL1. cloud_essd2: ESSD PL2. cloud_essd3: ESSD PL3. local_ssd: SSD local. Nota Instâncias que executam o MongoDB 4.4 ou posterior suportam apenas discos. Se você não especificar este parâmetro, cloud_essd1 será usado. Instâncias que executam o MongoDB 4.2 ou anterior suportam apenas discos locais. Se você não especificar este parâmetro, local_ssd será usado.	cloud_essd1
GlobalSecurityGroupIds	string	Não	Os modelos globais de lista de permissões de endereços IP da instância. Separe vários modelos com vírgulas (,). Cada modelo deve ser único.	g-qxieqf40xjst1ngpr3jz
Tag	array<object>	Não	As tags personalizadas.
	object	Não	The custom tags added to the instance.
Key	string	Não	The key of the tag. Nota N specifies the serial number of the 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 value of the tag. Nota N specifies the serial number of the 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
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	O IOPS provisionado.	1960
SrcRegion	string	Não	A região da instância de origem. Nota Este parâmetro é obrigatório quando você recria uma instância liberada a partir de um backup. Este parâmetro é obrigatório quando você clona uma instância a partir de um backup com redundância geográfica.	cn-beijing
BackupId	string	Não	O ID do backup do cluster. Nota Este parâmetro é obrigatório apenas quando RestoreType é definido como 2 ou 3.	cb-xxx
RestoreType	string	Não	O método de restauração de instância baseado em backup. 1: Restaurar a instância para um ponto específico no tempo. 2: Restaurar uma instância liberada a partir de um conjunto de backups específico. 3: Restaurar a instância a partir de um conjunto de backups com redundância geográfica específico.	1
DestRegion	string	Não	A região onde o backup com redundância geográfica está armazenado.	cn-hangzhou

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	As informações retornadas.
RequestId	string	O ID da solicitação.	D8F1D721-6439-4257-A89C-F1E8E9C9****
DBInstanceId	string	O ID da instância.	dds-bp114f14849d****
OrderId	string	O ID do pedido.	21010996721****

Exemplos

Resposta de sucesso

JSON formato

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

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	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.	The parameter entered is invalid.
400	RestoreTypeNotSupported	The specified restoreType is not supported for the instance, check the input parameters 'RestoreType/BackupID/RestoreTime'.	The specified restoreType is not supported for the instance, check the input parameters 'RestoreType/BackupID/RestoreTime'.
500	VpcServiceError	Invoke vpc service error.
403	InvalidBackupLogStatus	Current backup log enable status does not support this operation.
403	ReduceDiskNotSupport	Reduce disk size is not supported in clone/restore.	Reduce disk size is not supported in clone/restore.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.