ApsaraDB RDS:CreateDBInstance

O ID da região. Você pode chamar a operação DescribeRegions para consultar a lista de regiões mais recente.

O mecanismo de banco de dados. Valores válidos:

• MySQL

• SQLServer

• PostgreSQL

• MariaDB

A versão do mecanismo de banco de dados. Valores válidos:

• Instâncias regulares

  • MySQL: 5.5, 5.6, 5.7 e 8.0

  • SQL Server: 08r2_ent_ha (edição de disco em nuvem, descontinuada), 2008r2 (edição de alta disponibilidade com SSD local, descontinuada), 2012 (Enterprise Edition standalone), 2012_ent_ha, 2012_std_ha, 2012_web, 2014_ent_ha, 2014_std_ha, 2016_ent_ha, 2016_std_ha, 2016_web, 2017_ent, 2017_std_ha, 2017_web, 2019_ent, 2019_std_ha, 2019_web, 2022_ent, 2022_std_ha, 2022_web, 2025_ent e 2025_std

  • PostgreSQL: 10.0, 11.0, 12.0, 13.0, 14.0, 15.0, 16.0, 17.0 e 18.0

  • MariaDB: 10.3 e 10.6

• Instâncias serverless

  • MySQL: 5.7 e 8.0

  • SQL Server: 2016_std_sl, 2017_std_sl e 2019_std_sl

  • PostgreSQL: 14.0, 15.0, 16.0, 17.0 e 18.0

O tipo de instância. Você pode especificar um tipo de instância padrão ou um tipo de instância Yitian. Para obter detalhes, consulte Tipos de instância primária do ApsaraDB RDS.

Para criar uma instância serverless, defina este parâmetro com um dos seguintes valores:

• MySQL Basic Edition: mysql.n2.serverless.1c

• Série de alta disponibilidade do MySQL: mysql.n2.serverless.2c

• SQL Server: mssql.mem2.serverless.s2

• PostgreSQL Basic Edition: pg.n2.serverless.1c

• Série de alta disponibilidade do PostgreSQL: pg.n2.serverless.2c

A capacidade de armazenamento da instância. Unidade: GB. A capacidade de armazenamento da instância aumenta em incrementos de 5 GB. Para obter mais informações sobre os valores válidos, consulte Tipos de instância do ApsaraDB RDS.

[Descontinuado] Este parâmetro foi descontinuado e não precisa ser configurado.

O tipo de conexão de rede da instância. Defina o valor como Intranet, que indica uma conexão de rede interna.

O nome da instância. O nome deve ter de 2 a 255 caracteres. Deve começar com uma letra ou um caractere chinês e pode conter letras, dígitos, caracteres chineses e hifens (-).

A lista de permissões de endereços IP da instância. Separe vários endereços IP ou blocos CIDR com vírgulas (,). Endereços IP ou blocos CIDR duplicados não são permitidos. Você pode adicionar até 1.000 endereços IP ou blocos CIDR à lista de permissões de uma única instância. Os seguintes formatos são suportados:

• Formato de endereço IP. Exemplo: 10.10.XX.XX.

• Formato de bloco CIDR. Exemplo: 10.10.XX.XX/24. Neste exemplo, 24 indica o comprimento do prefixo no bloco CIDR, e os valores válidos do comprimento do prefixo variam de 1 a 32.

O token de cliente usado para garantir a idempotência da solicitação e evitar envios duplicados. 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.

O método de cobrança da instância. Valores válidos:

• Postpaid: pay-as-you-go.

• Prepaid: assinatura.

• Serverless: serverless. As instâncias do MariaDB não suportam este método de cobrança. Para obter mais informações, consulte Visão geral das instâncias serverless do ApsaraDB RDS for MySQL, Visão geral das instâncias serverless do ApsaraDB RDS for SQL Server e Visão geral das instâncias serverless do ApsaraDB RDS for PostgreSQL.

O ID da zona do nó primário.

• Se você especificar uma VPC e um vSwitch, deverá definir este parâmetro com o ID da zona do vSwitch. Caso contrário, a instância não poderá ser criada.

• Para uma instância da série de alta disponibilidade, você também deve especificar ZoneIdSlave1 para determinar se a instância usa implantação em zona única ou implantação em várias zonas.

• Para uma instância do RDS Enterprise Edition, você também deve especificar ZoneIdSlave1 e ZoneIdSlave2 para determinar se a instância usa implantação em zona única ou implantação em várias zonas.

• Para uma instância da Cluster Edition, você também deve especificar ZoneIdSlave1 para uma instância de dois nós, ou ZoneIdSlave1 e ZoneIdSlave2 para uma instância de três nós.

O ID da zona do nó secundário.

• Se você definir este parâmetro como Auto, a instância usará a implantação em várias zonas e o sistema selecionará automaticamente uma zona para o nó secundário.

• Se você definir este parâmetro com o mesmo valor de ZoneId, a instância usará a implantação em zona única.

• Se você definir este parâmetro com um valor diferente de ZoneId, a instância usará a implantação em várias zonas.

As instâncias da Cluster Edition do ApsaraDB RDS for MySQL suportam a criação de um ou dois nós secundários ao criar a instância. Se você quiser criar dois nós secundários, poderá usar este parâmetro para especificar a zona do segundo nó secundário.

O tipo de rede da instância. Valores válidos:

• VPC: VPC.

• Classic: rede clássica.

O modo de acesso da instância. Valores válidos:

• Standard: modo de acesso padrão.

• Safe: modo de proxy de banco de dados.

O valor padrão é alocado pelo sistema.

O ID da VPC.

O ID do vSwitch.

• Mapeamento de zona: A zona do vSwitch especificado por VSwitchId deve corresponder à zona do nó primário (ZoneId) e à zona do nó secundário (ZoneIdSlave1). Se você especificar dois IDs de vSwitch, a sequência deles deve corresponder à sequência de ZoneId e ZoneIdSlave1.

• Limite de tipo de rede: InstanceNetworkType deve ser definido como VPC.

• Vários vSwitches: Se você especificar ZoneIdSlave1 e o valor não for Auto, deverá especificar dois IDs de vSwitch e separá-los com vírgulas (,).

• Limite de caracteres: VSwitchId não pode conter caracteres especiais como espaços, pontos de exclamação (!), cerquilhas (#), sinais de iene (¥), e comerciais (&) e sinais de porcentagem (%).

O endereço IP interno da instância. O endereço IP deve estar dentro do intervalo de endereços IP do vSwitch especificado. Por padrão, o sistema aloca automaticamente um endereço IP com base em VPCId e VSwitchId.

A duração da assinatura. Valores válidos:

• Se Period estiver definido como Year, os valores válidos de UsedTime são de 1 a 5.

• Se Period estiver definido como Month, os valores válidos de UsedTime são de 1 a 11.

O período da assinatura da instância de assinatura. Valores válidos:

• Year: assinatura anual.

• Month: assinatura mensal.

O ID do grupo de recursos.

O tipo de armazenamento da instância. Valores válidos:

• local_ssd: SSD local premium (recomendado).

• general_essd: disco em nuvem de desempenho premium (recomendado).

• cloud_essd: ESSD PL1.

• cloud_essd2: ESSD PL2.

• cloud_essd3: ESSD PL3.

• cloud_ssd: SSD padrão (não recomendado e indisponível em algumas regiões).

O valor padrão deste parâmetro é determinado automaticamente com base no tipo de instância especificado por DBInstanceClass:

• Se o tipo de instância for um tipo de instância de SSD local premium, o valor padrão é local_ssd.

• Se o tipo de instância for um tipo de instância de disco em nuvem, o valor padrão é cloud_essd.

Os parâmetros de negócios estendidos.

O ID da chave usada para criptografia de disco em nuvem na mesma região. Se você especificar este parâmetro, a criptografia de disco em nuvem será ativada e não poderá ser desativada. Você também deve especificar RoleARN.

Você pode visualizar o ID da chave no console do Key Management Service (KMS) ou criar uma nova chave. Para obter mais informações, consulte Criar uma CMK.

O descritor de recurso global (ARN) para a autorização da conta de serviço em nuvem do ApsaraDB RDS pela conta primária para acessar o KMS. Você pode chamar a operação CheckCloudResourceAuthorized para consultar o descritor.

Especifica se a renovação automática deve ser ativada para a instância. Este parâmetro é válido apenas quando você cria uma instância de assinatura. Valores válidos:

• true

• false

A edição da instância. Valores válidos:

• Instâncias regulares

  • Basic: Basic Edition.

  • HighAvailability: série de alta disponibilidade.

  • cluster: Cluster Edition do MySQL ou PostgreSQL.

  • AlwaysOn: Cluster Edition do SQL Server.

  • Finance: RDS Enterprise Edition.

  Nota

  Este parâmetro é obrigatório ao criar uma instância da Enterprise Cluster Edition do SQL Server ou Basic Edition Enterprise Edition. Por exemplo, ao criar uma instância da Enterprise Cluster Edition 2022 da Basic Edition (2022_ent), você deve definir este parâmetro como Basic.

• Instâncias serverless

  • serverless_basic: Serverless Basic Edition. Este valor é aplicável apenas ao MySQL e PostgreSQL.

  • serverless_standard: série de alta disponibilidade Serverless. Este valor é aplicável apenas ao MySQL e PostgreSQL.

  • serverless_ha: série de alta disponibilidade Serverless do SQL Server.

  Nota

  Este parâmetro é obrigatório quando PayType está definido como Serverless.

O ID do grupo de hosts dedicados.

Este parâmetro é obrigatório quando você cria uma instância do ApsaraDB RDS em um cluster dedicado.

• Você pode chamar a operação DescribeDedicatedHostGroups para consultar as informações sobre o grupo de hosts dedicados.

• Se você não criou um grupo de hosts dedicados, pode chamar a operação CreateDedicatedHostGroup para criar um.

O ID do host no qual a instância primária é criada no cluster dedicado.

Este parâmetro é obrigatório quando você cria uma instância em um cluster dedicado. Se você não especificar este parâmetro, o sistema atribuirá automaticamente um host.

• Você pode chamar a operação DescribeDedicatedHosts para consultar os hosts no cluster dedicado.

• Se nenhum host estiver disponível, você pode chamar a operação CreateDedicatedHost para criar um host.

O ID do host no qual a instância secundária é criada no cluster dedicado.

Este parâmetro é obrigatório quando você cria uma instância da série de alta disponibilidade ou do RDS Enterprise Edition em um cluster dedicado. Se você não especificar este parâmetro, o sistema alocará automaticamente um host por padrão.

• Você pode chamar a operação DescribeDedicatedHosts para consultar os hosts no cluster dedicado.

• Se nenhum host estiver disponível, você pode chamar a operação CreateDedicatedHost para criar um host.

O ID do host no qual a instância de logger é criada no cluster dedicado.

Este parâmetro é obrigatório quando você cria uma instância do RDS Enterprise Edition em um cluster dedicado. Se você não especificar este parâmetro, o sistema atribuirá automaticamente um host.

• Você pode chamar a operação DescribeDedicatedHosts para consultar os hosts no cluster dedicado.

• Se nenhum host estiver disponível, você pode chamar a operação CreateDedicatedHost para criar um host.

O ID do modelo de parâmetros. Você pode chamar a operação DescribeParameterGroups para consultar modelos de parâmetros.

O fuso horário da instância. Este parâmetro só entra em vigor quando Engine está definido como MySQL ou PostgreSQL.

• Se Engine estiver definido como MySQL:

  • As configurações do parâmetro especificam o fuso horário UTC. Valores válidos: -12:59 a +13:00.

  • Para uma instância com SSDs locais premium, você pode especificar um fuso horário nomeado, como Asia/Hong_Kong. Para obter mais informações sobre fusos horários nomeados, consulte Fusos horários nomeados.

• Se Engine estiver definido como PostgreSQL:

  • As configurações do parâmetro especificam um fuso horário nomeado. Fusos horários UTC não são suportados. Para obter mais informações sobre fusos horários nomeados, consulte Fusos horários nomeados.

  • Este parâmetro pode ser configurado apenas para instâncias do ApsaraDB RDS for PostgreSQL com discos em nuvem.

Especifica se os nomes das tabelas diferenciam maiúsculas de minúsculas. Valores válidos:

• true: Os nomes das tabelas não diferenciam maiúsculas de minúsculas. Este é o valor padrão.

• false: Os nomes das tabelas diferenciam maiúsculas de minúsculas.

A versão secundária do mecanismo da instância. Este parâmetro é obrigatório apenas quando você cria uma instância do MySQL ou PostgreSQL. Formato:

• MySQL: <Versão da instância>_<Número da versão numérica>. Exemplos: rds_20200229, xcluster_20200229 e xcluster80_20200229. Descrição:

  • rds: série de alta disponibilidade ou Basic Edition.

  • xcluster: RDS Enterprise Edition do MySQL 5.7.

  • xcluster80: RDS Enterprise Edition do MySQL 8.0.

  Nota

  Você pode chamar a operação DescribeDBMiniEngineVersions para consultar o número da versão numérica. Para obter mais informações sobre as diferenças entre as versões secundárias do kernel, consulte Notas de versão do AliSQL.

• PostgreSQL: rds_postgres_<Versão principal>00_<Número da versão secundária>. Exemplo: rds_postgres_1400_20220830. Descrição:

  • 1400: A versão principal do mecanismo é o PostgreSQL 14.

  • 20220830: A versão secundária do kernel AliPG. Você pode chamar a operação DescribeDBMiniEngineVersions para consultar a versão secundária do kernel. Para obter mais informações sobre as diferenças entre as versões secundárias do kernel, consulte Notas de versão do AliPG.

  Nota

  Se o Babelfish estiver ativado em BabelfishConfig, o formato da versão secundária do mecanismo para a instância do ApsaraDB RDS for PostgreSQL é rds_postgres_<Versão principal>00_<Versão secundária do kernel AliPG>_babelfish.

Especifica se a expansão automática de armazenamento deve ser ativada. Este parâmetro é suportado apenas para MySQL e PostgreSQL. Valores válidos:

• Enable: ativa a expansão automática de armazenamento.

• Disable: desativa a expansão automática de armazenamento. Este é o valor padrão.

A porcentagem de limite que aciona a expansão automática de armazenamento. Valores válidos:

• 10

• 20

• 30

• 40

• 50

O limite superior da capacidade total de armazenamento para a expansão automática de armazenamento. A expansão automática de armazenamento não faz com que a capacidade total de armazenamento da instância exceda este valor. Unidade: GB.

Especifica se uma pré-verificação deve ser realizada antes da criação da instância. Valores válidos:

• true: realiza uma pré-verificação, mas não cria a instância. O sistema verifica itens como parâmetros de solicitação, formato de solicitação, limites de negócios e inventário.

• false: envia uma solicitação normal e cria a instância imediatamente após a solicitação passar na pré-verificação. Este é o valor padrão.

O ID do backup do usuário. Você pode chamar a operação ListUserBackupFiles para consultar os backups do usuário. Se você especificar este parâmetro, a instância será criada com base no backup do usuário.

Para especificar este parâmetro, os seguintes limites devem ser atendidos:

• PayType deve estar definido como Postpaid.

• Engine deve estar definido como MySQL.

• EngineVersion deve estar definido como 5.7.

• Category deve estar definido como Basic.

O número de instâncias do ApsaraDB RDS for MySQL que você deseja criar. Este parâmetro é aplicável apenas quando você cria várias instâncias do ApsaraDB RDS for MySQL ao mesmo tempo.

Valores válidos: 1 a 20. Valor padrão: 1.

A estratégia para criar várias instâncias ao mesmo tempo. Este parâmetro só entra em vigor quando Amount é maior que 1. Valores válidos:

• Atomicity: atomicidade. Todas as instâncias no mesmo lote são criadas com sucesso, ou nenhuma delas é criada se uma instância falhar ao ser criada. Este é o valor padrão.

• Partial: não atomicidade. A criação de uma instância não é afetada pela criação de outras instâncias no mesmo lote.

Especifica se a proteção contra liberação deve ser ativada para a instância. Este parâmetro é suportado apenas para instâncias pay-as-you-go. Valores válidos:

• true: ativa a proteção contra liberação.

• false: desativa a proteção contra liberação. Este é o valor padrão.

As informações de configuração do Babelfish for ApsaraDB RDS for PostgreSQL.

Formato de configuração: {"babelfishEnabled":"true","migrationMode":"xxxxxxx","masterUsername":"xxxxxxx","masterUserPassword":"xxxxxxxx"}

Descrição do parâmetro:

• babelfishEnabled: especifica se o Babelfish deve ser ativado. Defina o valor como true para ativar o Babelfish. Por padrão, o Babelfish é desativado se este parâmetro não for especificado.

• migrationMode: o modo de banco de dados. Defina o valor como single-db para o modo de banco de dados único ou multi-db para o modo de vários bancos de dados.

• masterUsername: a conta de administrador inicial. O nome de usuário pode conter letras minúsculas, dígitos e sublinhados (_). Deve começar com uma letra e terminar com uma letra ou dígito. Pode ter até 63 caracteres de comprimento e não pode começar com pg.

• masterUserPassword: a senha da conta de administrador. A senha deve conter pelo menos três dos seguintes tipos de caracteres: letras maiúsculas, letras minúsculas, dígitos e caracteres especiais. Deve ter de 8 a 32 caracteres de comprimento. Os caracteres especiais incluem ! @ # $ % ^ & * () _ + - =.

O endpoint interno do banco de dados.

Formato do endpoint: xxx.mysql.rds.aliyuncs.com, onde xxx é o prefixo do ID da instância, como rm-uf6wjk5***.

A porta usada para conectar à instância. Você pode inicializar a porta ao criar a instância. Valores válidos:

• MySQL: 1000 a 65534

• PostgreSQL, SQL Server e MariaDB: 1000 a 5999

[Descontinuado] Este parâmetro foi descontinuado e não precisa ser configurado.

Especifica se o recurso de pico de desempenho de E/S deve ser ativado para discos em nuvem de desempenho premium. Valores válidos:

• true: ativa o recurso.

• false: desativa o recurso.

Especifica se o pagamento automático deve ser ativado. Valores válidos:

• true: ativa o pagamento automático. Certifique-se de que o saldo da sua conta seja suficiente.

• false: gera um pedido, mas não deduz taxas.

Especifica se o recurso Buffer Pool Extension (BPE) deve ser ativado para discos em nuvem de desempenho premium. Valores válidos:

• 1: ativa o recurso.

• 0: desativa o recurso.

Especifica se o recurso de arquivamento de dados deve ser ativado para discos em nuvem de desempenho premium. Valores válidos:

• true: ativa o recurso.

• false: desativa o recurso.

The whitelist. To specify multiple IP addresses, separate the IP addresses or CIDR blocks with commas (,). Do not include spaces before or after the commas. Example: 192.168.0.1,172.16.213.9.

Specifies whether to automatically create a proxy. Valid values:

• true: enables automatic creation. By default, a general-purpose proxy is created.

• false: disables automatic creation.

Specifies whether to use a voucher. Valid values:

• true: uses a voucher.

• false: does not use a voucher. This is the default value.

The coupon code.

Specifies whether to enable the 16KB atomic write feature. Valid values:

• optimized: enables the feature.

• none: disables the feature. This is the default value.

Specifies whether to enable native replication for ApsaraDB RDS for MySQL. Valid values:

• ON: enables native replication.

• OFF: disables native replication.