ApsaraDB RDS:CreateDBInstance

O ID da região. Você pode chamar DescribeRegions para consultar as regiões disponíveis.

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, 8.0

  • SQL Server: 08r2_ent_ha (edição disco em nuvem, descontinuada), 2008r2 (SSDs locais premium, descontinuado), 2012 (Enterprise Edition Basic), 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, 2025_std

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

  • MariaDB: 10.3, 10.6

• Instâncias Serverless

  • MySQL: 5.7, 8.0

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

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

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

Para criar uma instância Serverless, especifique um dos seguintes valores:

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

• MySQL High-Availability Edition: mysql.n2.serverless.2c

• SQL Server: mssql.mem2.serverless.s2

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

• PostgreSQL High-Availability Edition: pg.n2.serverless.2c

A capacidade de armazenamento da instância. Unidade: GB. O valor é incrementado em intervalos de 5 GB. Para o intervalo de valores, consulte Tipos de instância primária.

Um parâmetro obsoleto. Você não precisa configurar este parâmetro.

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

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

A lista de permissões de endereços IP da instância. Separe várias entradas com vírgulas (,). As entradas não podem ser duplicadas. Você pode adicionar até 1.000 endereços IP ou blocos CIDR para uma única instância. Os dois formatos a seguir são suportados:

• Formato de endereço IP, como 10.10.XX.XX.

• Formato CIDR, como 10.10.XX.XX/24 (roteamento entre domínios sem classe, onde 24 indica o comprimento do prefixo, variando de 1 a 32).

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 único 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: cobrança Serverless. Este valor não é suportado para instâncias MariaDB. Para mais informações, consulte Introdução às instâncias Serverless do MySQL, Introdução às instâncias Serverless do SQL Server e Introdução às instâncias Serverless do PostgreSQL.

O ID da zona do nó primário.

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

• Para instâncias High-Availability Edition, você também deve especificar ZoneIdSlave1 para determinar se a instância usa implantação de zona única ou multizona.

• Para instâncias RDS Enterprise Edition, você também deve especificar ZoneIdSlave1 e ZoneIdSlave2 para determinar se a instância usa implantação de zona única ou multizona.

• Para instâncias RDS Cluster Edition, você deve especificar ZoneIdSlave1 para clusters de dois nós, e ZoneIdSlave1 e ZoneIdSlave2 para clusters de três nós.

O ID da zona do nó secundário.

• Se você definir este parâmetro como Auto, o sistema selecionará automaticamente uma zona para o nó secundário em uma implantação multizona.

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

• Se este parâmetro for definido com um valor diferente de ZoneId, a instância usará implantação multizona.

As instâncias RDS MySQL Cluster Edition suportam a criação de um ou dois nós secundários quando você cria uma instância. Você pode usar este parâmetro para especificar o ID da zona do segundo nó secundário.

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

• VPC: nuvem privada virtual.

• Classic: rede clássica.

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

• Standard: modo padrão.

• Safe: modo de proxy de banco de dados.

Valor padrão: alocado pelo sistema RDS.

O ID da VPC.

O ID do vSwitch.

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

• Restrição de tipo de rede: InstanceNetworkType deve ser definido como VPC.

• Requisito de múltiplos vSwitches: Se você especificar ZoneSlaveId1 (ID da zona do nó secundário) e ele não estiver definido como Auto, você deverá especificar dois IDs de vSwitch separados por vírgula (,).

• Restrição de caracteres: O ID do vSwitch não pode conter caracteres especiais como espaços, !, #, ￥, & ou %.

O endereço IP interno da instância. O endereço IP deve estar dentro do intervalo de endereços IP do vSwitch especificado. O sistema atribui automaticamente um endereço IP interno com base nos valores de 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 1 a 5.

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

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

• Year

• Month

O ID do grupo de recursos.

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

• local_ssd: SSDs locais premium (recomendado).

• general_essd: ESSD premium (recomendado).

• cloud_essd: ESSD PL1.

• cloud_essd2: ESSD PL2.

• cloud_essd3: ESSD PL3.

• cloud_ssd: SSD padrão (não recomendado, descontinuado em algumas regiões).

O valor padrão deste parâmetro é determinado pelo tipo de instância especificado no parâmetro DBInstanceClass:

• Se o tipo de instância for para SSDs locais premium, o valor padrão é local_ssd.

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

O parâmetro de extensão de negócios.

O ID da chave de 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 chave. Para mais informações, consulte Criar uma chave.

O descritor global de recursos (ARN) usado para a autorização da conta primária permitir que a conta de serviço em nuvem RDS acesse o KMS. Você pode chamar a operação CheckCloudResourceAuthorized para consultar o ARN.

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

• true

• false

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

• Instâncias regulares

  • Basic: Basic Edition.

  • HighAvailability: High-Availability Edition.

  • cluster: MySQL ou PostgreSQL Cluster Edition.

  • AlwaysOn: SQL Server Cluster Edition.

  • Finance: RDS Enterprise Edition.

  Nota

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

• Instâncias Serverless

  • serverless_basic: Serverless Basic Edition. (Aplicável apenas a MySQL e PostgreSQL)

  • serverless_standard: Serverless High-Availability Edition. (Aplicável apenas a MySQL e PostgreSQL)

  • serverless_ha: SQL Server Serverless High-Availability Edition.

  Nota

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

O ID do grupo de hosts de cluster dedicado.

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

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

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

O ID do host da instância primária no cluster dedicado.

Este parâmetro é obrigatório quando você cria uma instância ApsaraDB RDS 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 as informações de hosts no grupo de hosts RDS.

• Se você não tiver um host, pode chamar a operação CreateDedicatedHost para adicionar um.

O ID do host da instância secundária no cluster dedicado.

Este parâmetro é obrigatório quando você cria uma instância ApsaraDB RDS High-Availability Edition ou 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 as informações de hosts no cluster dedicado RDS.

• Se você não tiver um host, pode chamar a operação CreateDedicatedHost para adicionar um.

O ID do host da instância de log no cluster dedicado.

Este parâmetro é obrigatório quando você cria uma instância ApsaraDB 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 as informações de hosts no cluster dedicado RDS.

• Se você não tiver um host, pode chamar a operação CreateDedicatedHost para adicionar um.

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

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

• Se Engine estiver definido como MySQL:

  • Este parâmetro especifica o fuso horário UTC. Valores válidos: -12:59 a +13:00.

  • Instâncias com SSDs locais premium podem usar fusos horários nomeados, como Asia/Hong_Kong. Para mais informações sobre fusos horários nomeados, consulte Referência de fuso horário nomeado.

• Se Engine estiver definido como PostgreSQL:

  • Este parâmetro especifica um fuso horário nomeado. Fusos horários UTC não são suportados. Para mais informações sobre fusos horários nomeados, consulte Referência de fuso horário nomeado.

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

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

• true: não diferencia maiúsculas de minúsculas (padrão).

• false: diferencia maiúsculas de minúsculas.

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

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

  • rds: High-Availability Edition ou Basic Edition.

  • xcluster: MySQL 5.7 RDS Enterprise Edition.

  • xcluster80: MySQL 8.0 RDS Enterprise Edition.

  Nota

  Você pode chamar a operação DescribeDBMiniEngineVersions para consultar o número da versão numérica. Para informações sobre diferenças de versão, consulte Notas de lançamento da versão menor do AliSQL.

• PostgreSQL: rds_postgres_<versão principal>00_<versão menor do kernel>. Exemplo: rds_postgres_1400_20220830. Descrição:

  • 1400: Versão principal 14 do PostgreSQL.

  • 20220830: Versão menor do kernel AliPG. Você pode chamar a operação DescribeDBMiniEngineVersions para consultar a versão. Para informações sobre diferenças de versão, consulte Notas de lançamento da versão menor do PostgreSQL.

  Nota

  Se o Babelfish estiver ativado em BabelfishConfig, o formato da versão menor para a instância ApsaraDB RDS for PostgreSQL será: rds_postgres_<versão principal>00_<versão menor 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: ativado.

• Disable: desativado (padrão).

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

• 10

• 20

• 30

• 40

• 50

A capacidade máxima de armazenamento para expansão automática de armazenamento. A expansão automática não fará com que a capacidade total de armazenamento exceda este valor. Unidade: GB.

Especifica se deve ser realizado um dry run para esta solicitação de criação de instância. Valores válidos:

• true: realiza um dry run sem criar a instância. O sistema verifica itens como parâmetros da solicitação, formato da solicitação, limites de negócios e recursos disponíveis.

• false: envia a solicitação e cria a instância após a solicitação passar na verificação (padrão).

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

As seguintes restrições se aplicam quando você especifica este parâmetro:

• PayType deve ser definido como Postpaid.

• Engine deve ser definido como MySQL.

• EngineVersion deve ser definido como 5.7.

• Category deve ser definido como Basic.

O número de instâncias ApsaraDB RDS for MySQL a serem criadas. Este parâmetro aplica-se apenas à criação em lote de instâncias ApsaraDB RDS for MySQL.

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

A estratégia para criação de instâncias em lote. Este parâmetro entra em vigor apenas quando o parâmetro Amount é maior que 1. Valores válidos:

• Atomicity (padrão): atômico. Todas as instâncias no mesmo lote são criadas com sucesso ou falham juntas. Se uma instância falhar ao ser criada, todas as instâncias falharão.

• Partial: não atômico. A criação de cada instância é independente das outras instâncias no mesmo lote.

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

• true: ativado.

• false: desativado (padrão).

A configuração do Babelfish for RDS PostgreSQL.

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

Descrição dos parâmetros:

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

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

• masterUsername: o nome da conta de administrador inicial. O nome 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. A senha 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***.

O número da porta a ser inicializado ao criar a instância ApsaraDB RDS. Valores válidos:

• MySQL: 1000 a 65534

• PostgreSQL, SQL Server, MariaDB: 1000 a 5999

Um parâmetro obsoleto. Você não precisa configurar este parâmetro.

Especifica se o recurso de burst de E/S para ESSDs premium deve ser ativado. Valores válidos:

• true: ativado.

• false: desativado.

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

• true: ativado. Certifique-se de que o saldo da sua conta seja suficiente.

• false: gera um pedido sem deduzir taxas.

Especifica se o recurso Buffer Pool Extension (BPE) para ESSDs premium deve ser ativado. Valores válidos:

• 1: ativado.

• 0: desativado.

Especifica se o recurso de arquivamento de dados frios para ESSDs premium deve ser ativado. Valores válidos:

• true: ativado.

• false: desativado.

A lista de permissões de endereços IP. Para especificar vários endereços IP, separe-os com vírgulas (,). Não são permitidos espaços antes ou depois das vírgulas. Exemplo: 192.168.0.1,172.16.213.9.

Especifica se a criação automática de um proxy de banco de dados deve ser ativada. Valores válidos:

• true: ativado. Um proxy de banco de dados de uso geral é criado por padrão.

• false: desativado.

Especifica se cupons devem ser usados. Valores válidos:

• true: usa cupons.

• false (padrão): não usa cupons.

O código do cupom.

Especifica se o recurso de gravação atômica de 16 KB deve ser ativado. Valores válidos:

• optimized: ativado.

• none (padrão): desativado.

Especifica se a replicação nativa do RDS MySQL deve ser ativada ou desativada. Valores válidos:

• ON: ativado.

• OFF: desativado.