Todos os produtos
Search

Este produto

    ApsaraDB for MongoDB:CreateShardingDBInstance

    Central de documentação

    ApsaraDB for MongoDB:CreateShardingDBInstance

    Última atualização: Sep 23, 2026

    Cria ou clona uma instância de cluster sharded do ApsaraDB for MongoDB.

    Descrição da operação

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

    • Para obter mais informações sobre as especificações de instância do ApsaraDB for MongoDB, consulte Especificações de instância.

    • Para criar uma instância autônoma ou de conjunto de réplicas, chame 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

    *Instância.

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

    		 Nenhuma 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.

    Valores válidos:

    • MongoDB :

      Mecanismo de banco de dados MongoDB.

    MongoDB
    EngineVersion

    string

    Sim

    O número da versão do banco de dados. Valores válidos:

    • 8.0

    • 7.0

    • 6.0

    • 5.0

    • 4.4

    • 4.2

    • 4.0

    Nota

    4.4
    DBInstanceDescription

    string

    Não

    O nome da instância. Valores válidos:

    • O nome deve começar com uma letra.

    • O nome pode conter dígitos, letras, sublinhados (_), pontos (.) e hifens (-).

    • O nome 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 (,). Os endereços IP não podem ser duplicados. Os três formatos a seguir são suportados:

    • 0.0.0.0/0

    • Endereço IP, como 10.23.12.24.

    • Bloco CIDR, como 10.23.12.0/24, onde 24 indica o comprimento do prefixo no endereço IP e o valor varia de 1 a 32.

    Nota

    • Você pode adicionar até 1.000 endereços IP ou blocos CIDR a todos os grupos de lista de permissões de endereços IP de uma instância.

    • Se você definir este parâmetro como 0.0.0.0/0, todos os endereços IP poderão acessar a instância. Tenha cuidado ao usar esta configuração.

    192.168.xx.xx,192.168.xx.xx
    AccountPassword

    string

    Não

    A senha da conta root. Valores válidos:

    • A senha 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 !@#$%^&*()_+-=

    • A senha deve ter de 8 a 32 caracteres.

    Nota

    Para obter mais informações sobre como solucionar problemas de falha de conexão com o banco de dados causados por caracteres especiais na string de conexão, consulte Como solucionar problemas de falhas de conexão causadas por caracteres especiais na senha da conta de uma string de conexão?.

    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á configurar o parâmetro Period.

    Valores válidos:

    • PostPaid :

      Pós-pago.

    • PrePaid :

      Assinatura.

    PrePaid
    Period

    integer

    Não

    O período de assinatura da instância. Unidade: meses.

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

    Nota

    Este parâmetro está disponível e é obrigatório apenas quando você define ChargeType como PrePaid.

    1
    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-bp1n3i15v90el48nx****
    VSwitchId

    string

    Não

    O ID do vSwitch.

    vsw-bp1vj604nj5a9zz74****
    SrcDBInstanceId

    string

    Não

    O ID da instância de origem.

    Nota

    Este parâmetro é obrigatório apenas quando você chama esta operação para clonar uma instância. Você também deve configurar o parâmetro RestoreTime.

    dds-bp11483712c1****
    RestoreTime

    string

    Não

    O ponto no tempo para o qual você deseja recuperar os dados. Você pode especificar qualquer ponto no tempo dentro dos últimos sete dias. Especifique a hora no formato aaaa-MM-ddTHH:mm:ssZ (UTC).

    Nota

    Este parâmetro é obrigatório apenas quando você chama esta operação para clonar uma instância. Você também deve configurar o parâmetro SrcDBInstanceId.

    2022-03-08T02:30:25Z
    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 certifique-se de que o token seja exclusivo entre diferentes solicitações. O token pode conter apenas caracteres ASCII e não pode exceder 64 caracteres.

    ETnLKlblzczshOTUbOCz****
    StorageEngine

    string

    Não

    O mecanismo de armazenamento da instância. Defina o valor como WiredTiger.

    Nota

    WiredTiger
    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: desativa a renovação automática. Você deve renovar a instância manualmente. Este é o valor padrão.

    Nota

    Este parâmetro está disponível e é opcional apenas quando você define ChargeType como PrePaid.

    true
    ProtocolType

    string

    Não

    O tipo do protocolo de acesso. Valores válidos:

    • mongodb: protocolo MongoDB.

    • dynamodb: protocolo DynamoDB.

    Valores válidos:

    • mongodb :

      Protocolo MongoDB.

    • dynamodb :

      Protocolo DynamoDB.

    mongodb
    Mongos

    array<object>

    Sim

    As informações sobre os nós Mongos.

    object

    Sim

    As informações sobre os nós Mongos.

    Class

    string

    Sim

    A especificação do nó Mongos. Para obter mais informações, consulte Especificações de instância de cluster sharded.

    Nota

    • N no nome do parâmetro especifica o número de sequência do nó Mongos. Por exemplo, Mongos.2.Class especifica a especificação do segundo nó Mongos.

    • Valores válidos de N: 2 a 32.

    mdb.shard.2x.xlarge.d
    ReplicaSet

    array<object>

    Sim

    As informações sobre os nós Shard.

    object

    Não

    As informações sobre os nós Shard.

    Class

    string

    Sim

    A especificação do nó Shard. Para obter mais informações, consulte Especificações de instância de cluster sharded.

    Nota

    • N no nome do parâmetro especifica o número de sequência do nó Shard. Por exemplo, ReplicaSet.2.Class especifica a especificação do segundo nó Shard.

    • Valores válidos de N: 2 a 32.

    dds.shard.standard
    Storage

    integer

    Sim

    A capacidade de armazenamento do nó Shard. Unidade: GB.

    Nota

    • Os valores válidos estão sujeitos às especificações da instância. Para obter mais informações, consulte Especificações de instância de cluster sharded.

    • N no nome do parâmetro especifica o número de sequência do nó Shard. Por exemplo, ReplicaSet.2.Storage especifica a capacidade de armazenamento do segundo nó Shard.

    10
    ReadonlyReplicas

    integer

    Não

    O número de nós somente leitura para o nó Shard.

    Valores válidos: 0 a 5 (número inteiro). Valor padrão: 0.

    Nota

    N no nome do parâmetro especifica o número de sequência do nó Shard. Por exemplo, ReplicaSet.2.ReadonlyReplicas especifica o número de nós somente leitura para o segundo nó Shard.

    0
    ConfigServer

    array<object>

    Sim

    As informações sobre os nós ConfigServer.

    object

    Não

    As informações sobre os nós ConfigServer.

    Class

    string

    Sim

    A especificação do nó ConfigServer. Valores válidos:

    • mdb.shard.2x.xlarge.d: 4 vCPUs, 8 GB de memória (dedicado). Este valor é suportado apenas para instâncias que executam a versão 4.4 ou posterior.

    • dds.cs.mid: 1 vCPU, 2 GB de memória (uso geral). Este valor é suportado apenas para instâncias que executam a versão 4.2 ou anterior.

    mdb.shard.2x.xlarge.d
    Storage

    integer

    Sim

    A capacidade de armazenamento do nó ConfigServer. Unidade: GB.

    Nota

    Os valores válidos estão sujeitos às especificações da instância. Para obter mais informações, consulte Especificações de instância de cluster sharded.

    20
    SecondaryZoneId

    string

    Não

    O ID do grupo de recursos. Para obter mais informações, consulte Visualizar informações básicas de um grupo de recursos.

    rg-acfmyiu4ekp****
    HiddenZoneId

    string

    Não

    A zona secundária 1 para implantação multizona. Valores válidos:

    • cn-hangzhou-g: Hangzhou Zona G.

    • cn-hangzhou-h: Hangzhou Zona H.

    • cn-hangzhou-i: Hangzhou Zona I.

    • cn-hongkong-b: Hong Kong (China) Zona B.

    • cn-hongkong-c: Hong Kong (China) Zona C.

    • cn-hongkong-d: Hong Kong (China) Zona D.

    • cn-wulanchabu-a: Ulanqab Zona A.

    • cn-wulanchabu-b: Ulanqab Zona B.

    • cn-wulanchabu-c: Ulanqab Zona C.

    • ap-southeast-1a: Singapura Zona A.

    • ap-southeast-1b: Singapura Zona B.

    • ap-southeast-1c: Singapura Zona C.

    • ap-southeast-5a: Jacarta Zona A.

    • ap-southeast-5b: Jacarta Zona B.

    • ap-southeast-5c: Jacarta Zona C.

    • eu-central-1a: Frankfurt Zona A.

    • eu-central-1b: Frankfurt Zona B.

    • eu-central-1c: Frankfurt Zona C.

    Nota

    • Este parâmetro está disponível apenas quando a instância usa discos em nuvem.

    • O valor deste parâmetro não pode ser igual aos valores de ZoneId ou HiddenZoneId.

    • Para obter mais informações sobre a estratégia de implantação multizona para instâncias de cluster sharded, consulte Criar uma instância de cluster sharded multizona.

    cn-hangzhou-h
    StorageType

    string

    Não

    A zona secundária 2 para implantação multizona. Valores válidos:

    • cn-hangzhou-g: Hangzhou Zona G.

    • cn-hangzhou-h: Hangzhou Zona H.

    • cn-hangzhou-i: Hangzhou Zona I.

    • cn-hongkong-b: Hong Kong (China) Zona B.

    • cn-hongkong-c: Hong Kong (China) Zona C.

    • cn-hongkong-d: Hong Kong (China) Zona D.

    • cn-wulanchabu-a: Ulanqab Zona A.

    • cn-wulanchabu-b: Ulanqab Zona B.

    • cn-wulanchabu-c: Ulanqab Zona C.

    • ap-southeast-1a: Singapura Zona A.

    • ap-southeast-1b: Singapura Zona B.

    • ap-southeast-1c: Singapura Zona C.

    • ap-southeast-5a: Jacarta Zona A.

    • ap-southeast-5b: Jacarta Zona B.

    • ap-southeast-5c: Jacarta Zona C.

    • eu-central-1a: Frankfurt Zona A.

    • eu-central-1b: Frankfurt Zona B.

    • eu-central-1c: Frankfurt Zona C.

    Nota

    • Este parâmetro está disponível apenas quando a instância usa discos em nuvem.

    • O valor deste parâmetro não pode ser igual aos valores de ZoneId ou SecondaryZoneId.

    • Para obter mais informações sobre a estratégia de implantação multizona para instâncias de cluster sharded, consulte Criar uma instância de cluster sharded multizona.

    cn-hangzhou-i
    GlobalSecurityGroupIds

    string

    Não

    O tipo de armazenamento. Valores válidos:

    • cloud_essd1: ESSD PL1.

    • cloud_essd2: ESSD PL2.

    • cloud_essd3: ESSD PL3.

    • local_ssd: SSD local.

    Nota

    • Instâncias que executam a versão 4.4 ou posterior suportam apenas discos em nuvem. Se você não especificar este parâmetro, cloud_essd1 será usado por padrão.

    • Instâncias que executam a versão 4.2 ou anterior suportam apenas discos locais. Se você não especificar este parâmetro, local_ssd será usado por padrão.

    cloud_essd1
    Tag

    array<object>

    Não

    Os modelos globais de lista de permissões de endereços IP da instância. Separe vários modelos com vírgulas (,). Os modelos não podem ser duplicados.

    g-qxieqf40xjst1ngpr3jz

    object

    Não

    As tags personalizadas adicionadas à instância.

    Key

    string

    Não

    A chave da tag.

    Nota

    • N especifica o número de série 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 de série da tag. Por exemplo, Tag.1.Value especifica o valor da primeira tag e Tag.2.Value especifica o valor da segunda tag.

    apitest
    Encrypted

    boolean

    Não

    As tags personalizadas.

    true
    EncryptionKey

    string

    Não

    Especifica se a criptografia de disco em nuvem deve ser ativada.

    true
    ProvisionedIops

    integer

    Não

    O ID da chave de criptografia personalizada.

    2axxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
    SrcRegion

    string

    Não

    O IOPS provisionado.

    1960
    BackupId

    string

    Não

    A região onde a instância de origem reside.

    Nota

    • Este parâmetro é obrigatório quando o tipo de recuperação de backup é a reconstrução de uma instância excluída.

    • Este parâmetro é obrigatório quando o tipo de recuperação de backup é a clonagem a partir de um backup com georredudância.

    cn-beijing
    RestoreType

    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
    DestRegion

    string

    Não

    O tipo de recuperação de backup. Valores válidos:

    • 1: Recuperar a instância para um ponto específico no tempo.

    • 2: Recuperar uma instância liberada a partir de um conjunto de backups especificado.

    • 3: Recuperar a instância a partir de um conjunto de backups com georredudância especificado.

    1

    Elementos de resposta

    Elemento

    Tipo

    Descrição

    Exemplo

    object

    Os parâmetros de resposta.

    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. O parâmetro de entrada é inválido.
    400 RestoreTypeNotSupported The specified restoreType is not supported for the instance, check the input parameters 'RestoreType/BackupID/RestoreTime'. O tipo de instância de restauração especificado não é suportado. Verifique os parâmetros de entrada RestoreType, BackupID e RestoreTime.
    500 VpcServiceError Invoke vpc service error. Ocorreu um erro ao chamar o serviço VPC.
    403 InvalidBackupLogStatus Current backup log enable status does not support this operation.
    403 ReduceDiskNotSupport Reduce disk size is not supported in clone/restore. A redução do espaço do disco em nuvem não é suportada para clonagem ou restauração de instâncias.

    Consulte Códigos de Erro para uma lista completa.

    Notas de versão

    Consulte Notas de Versão para uma lista completa.