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

Certifique-se de compreender totalmente os métodos de faturamento e a precificação

do ApsaraDB for MongoDB antes de chamar esta operação.
Para obter mais informações sobre os tipos de instância do ApsaraDB for MongoDB, consulte Tipos de instância.
Para criar instâncias standalone e replica set, chame a operação CreateDBInstance.

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Para sua conveniência, recomendamos chamar esta operação no OpenAPI Explorer. O OpenAPI Explorer gera dinamicamente o código de exemplo da operação para diferentes SDKs.

Parâmetros de solicitação

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
RegionId	String	Sim	cn-hangzhou	ID da região da instância. Chame a operação DescribeRegions para consultar a lista de regiões mais recente.
Action	String	Sim	CreateShardingDBInstance	Operação a ser executada. Defina o valor como CreateShardingDBInstance.
ZoneId	String	Não	cn-hangzhou-g	ID da zona da instância. Chame a operação DescribeRegions para consultar a lista de zonas mais recente.
Engine	String	Sim	MongoDB	Mecanismo da instância. Defina o valor como MongoDB.
EngineVersion	String	Sim	4,4	Versão do mecanismo de banco de dados. Valores válidos: 6,0 5,0 4,4 4,2 4,0 Nota Para obter mais informações sobre os limites de versões de banco de dados e mecanismos de armazenamento, consulte Versões do MongoDB e mecanismos de armazenamento. Ao clonar uma instância, defina o valor como o mecanismo da instância de origem.
DBInstanceDescription	String	Não	test	Nome da instância. Regras: Deve começar com uma letra. Pode conter dígitos, letras, sublinhados (_) e hifens (-). Deve ter entre 2 e 256 caracteres.
SecurityIPList	String	Não	192.168.xx.xx,192.168.xx.xx	Endereços IP na lista de permissões. Separe vários endereços IP com vírgulas (,). Cada endereço deve ser único. Formatos suportados: 0.0.0.0/0 Endereços IP individuais, como 10.23.12.24. Blocos Classless Inter-Domain Routing (CIDR), como 10.23.12.0/24. Neste caso, /24 indica um prefixo de 24 bits. Substitua 24 por qualquer valor entre 1 e 32. Nota Cada instância aceita até 1.000 endereços IP e blocos CIDR. O valor 0.0.0.0/0 permite acesso de todos os endereços IP, o que pode gerar riscos de segurança.
AccountPassword	String	Não	123456Aa	Senha da conta root. Requisitos: Deve conter pelo menos três dos seguintes tipos de caracteres: letras maiúsculas, letras minúsculas, dígitos e caracteres especiais. Caracteres especiais permitidos: ! # $ % ^ & * ( ) _ + - = Deve ter entre 8 e 32 caracteres.
ChargeType	String	Não	PrePaid	Método de faturamento da instância. Valores válidos: PostPaid: pagamento conforme o uso PrePaid: assinatura Nota Se definir este parâmetro como PrePaid, especifique também o parâmetro Period.
Period	Integer	Não	1	Período de assinatura da instância. Unidade: meses. Valores válidos: 1 a 9, 12, 24, 36 e 60. Nota Se definir ChargeType como PrePaid, configure esta propriedade.
NetworkType	String	Não	VPC	Tipo de rede da instância. Valor válido: VPC
VpcId	String	Sim	vpc-bp1n3i15v90el48nx****	ID da VPC da instância.
VSwitchId	String	Sim	vsw-bp1vj604nj5a9zz74****	ID do vSwitch da instância.
SrcDBInstanceId	String	Não	dds-bp11483712c1****	ID da instância de origem. Nota Necessário apenas ao clonar uma instância. Se especificado, o parâmetro RestoreTime também é obrigatório.
RestoreTime	String	Não	2022-03-08T02:30:25Z	Momento de restauração para clonagem (dentro dos últimos sete dias). Formato: aaaa-MM-ddTHH:mm:ssZ (UTC). Nota Necessário apenas ao clonar uma instância. Se especificado, o parâmetro SrcDBInstanceId também é obrigatório.
ClientToken	String	Não	ETnLKlblzczshOTUbOCz****	Token de cliente para garantir a idempotência da solicitação. Gere o valor no cliente, garantindo exclusividade entre solicitações distintas. Aceita apenas caracteres ASCII, com limite de 64 caracteres.
StorageEngine	String	Não	WiredTiger	Mecanismo de armazenamento da instância. Valor padrão: WiredTiger. Nota Ao clonar uma instância, defina o valor como o mecanismo da instância de origem. Para obter mais informações sobre os limites de versões de banco de dados e mecanismos de armazenamento, consulte Versões do MongoDB e mecanismos de armazenamento.
AutoRenew	String	Não	true	Define se a renovação automática está ativada para a instância. Valor padrão: false. Valores válidos: true false Nota Se definir o parâmetro ChargeType como PrePaid, configure este parâmetro opcional.
ProtocolType	String	Não	mongodb	Tipo de protocolo de acesso da instância. Valores válidos: mongodb: protocolo MongoDB dynamodb: protocolo DynamoDB
Mongos.N.Class	String	Sim	mdb.shard.2x.xlarge.d	Tipo de instância do nó mongos. Para obter mais informações, consulte Tipos de instância. Nota N indica o número sequencial do nó mongos. Por exemplo, Mongos.2.Class define o tipo do segundo nó mongos. Valores válidos para N: 2 a 32.
ReplicaSet.N.Class	String	Sim	dds.shard.standard	Tipo de instância do nó shard. Para obter mais informações, consulte Tipos de instância. Nota N indica o número sequencial do nó shard. Por exemplo, ReplicaSet.2.Class define o tipo do segundo nó shard. Valores válidos para N: 2 a 32.
ReplicaSet.N.Storage	Integer	Sim	10	Capacidade de armazenamento do nó shard. Unidade: GB. Nota Os valores disponíveis dependem do tipo de instância. Para obter mais informações, consulte Tipos de instância. N indica o número sequencial do nó shard. Por exemplo, ReplicaSet.2.Storage define a capacidade do segundo nó shard.
ReplicaSet.N.ReadonlyReplicas	Integer	Não	0	Número de nós somente leitura no nó shard N. Valores válidos: 0 a 5 (inteiro). Valor padrão: 0. Nota N indica o número sequencial do nó shard. ReplicaSet.2.ReadonlyReplicas define a quantidade de nós somente leitura no segundo nó shard.
ConfigServer.N.Class	String	Sim	mdb.shard.2x.xlarge.d	Tipo de instância do nó Configserver. Valores válidos: mdb.shard.2x.xlarge.d: 4 núcleos, 8 GB (dedicado). Compatível apenas com MongoDB 4,4 ou superior. dds.cs.mid: 1 núcleo, 2 GB (uso geral). Compatível apenas com MongoDB 4,2 ou inferior.
ConfigServer.N.Storage	Integer	Sim	20	Capacidade de armazenamento do nó Configserver. Unidade: GB. Nota Os valores disponíveis dependem do tipo de instância. Para obter mais informações, consulte Tipos de instância.
StorageType	String	Não	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 Nota Instâncias do MongoDB 4,4 ou superior aceitam apenas discos em nuvem. Se omitido, cloud_essd1 será selecionado. Instâncias do MongoDB 4,2 ou inferior aceitam apenas discos locais. Se omitido, local_ssd será selecionado.

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
RequestId	String	D8F1D721-6439-4257-A89C-F1E8E9C9****	ID da solicitação.
DBInstanceId	String	dds-bp114f14849d****	ID da instância.
OrderId	String	21010996721****	ID do pedido.

Exemplos

Exemplos de solicitações

http(s)://mongodb.aliyuncs.com/?RegionId=cn-hangzhou
&Action=CreateShardingDBInstance
&ZoneId=cn-hangzhou-g
&Engine=MongoDB
&EngineVersion=4.4
&DBInstanceDescription=test
&SecurityIPList=192.168.xx.xx,192.168.xx.xx
&AccountPassword=123456Aa
&ChargeType=PrePaid
&Period=1
&NetworkType=VPC
&VpcId=vpc-bp1n3i15v90el48nx****
&VSwitchId=vsw-bp1vj604nj5a9zz74****
&SrcDBInstanceId=dds-bp11483712c1****
&RestoreTime=2022-03-08T02:30:25Z
&ClientToken=ETnLKlblzczshOTUbOCz****
&StorageEngine=WiredTiger
&AutoRenew=true
&ProtocolType=mongodb
&Mongos=[{"Class":"mdb.shard.2x.xlarge.d"}]
&ReplicaSet=[{"Class":"dds.shard.standard","Storage":10,"ReadonlyReplicas":0}]
&ConfigServer=[{"Class":"mdb.shard.2x.xlarge.d","Storage":20}]
&StorageType=cloud_essd1
&<Common request parameters>

Exemplos de respostas de sucesso

Formato XML

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

<CreateShardingDBInstanceResponse>
    <RequestId>D8F1D721-6439-4257-A89C-F1E8E9C9****</RequestId>
    <DBInstanceId>dds-bp114f14849d****</DBInstanceId>
    <OrderId>21010996721****</OrderId>
</CreateShardingDBInstanceResponse>

Formato JSON

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

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

Códigos de erro

Para obter uma lista de códigos de erro, consulte Códigos de erro do serviço.