CreateDBCluster - PolarDB: Central de Documentação do Alibaba Cloud

Cria um cluster PolarDB.

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

polardb:CreateDBCluster

create

*DBCluster.

acs:polardb:{#regionId}:{#accountId}:dbcluster/{#DbClusterId}

polardb:EncryptionRequired

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
RegionId	string	Sim	O ID da região. Nota Você pode chamar a operação DescribeRegions para consultar as regiões disponíveis.	cn-hangzhou
ZoneId	string	Não	O ID da zona. Nota Você pode chamar a operação DescribeRegions para consultar as zonas disponíveis.	cn-hangzhou-j
Architecture	string	Não	A arquitetura da CPU. Valores válidos: X86 ARM	X86
DBType	string	Sim	O tipo de mecanismo de banco de dados. Valores válidos: MySQL PostgreSQL Oracle	MySQL
DBVersion	string	Sim	A versão do mecanismo de banco de dados. Valores válidos para MySQL: 5.6 5.7 8.0 Valores válidos para PostgreSQL: 11 14 15 Nota Para criar um cluster serverless para PolarDB for PostgreSQL, apenas a versão 14 é suportada. * Valores válidos para Oracle: * 11 * 14	5.6
DBNodeClass	string	Não	A especificação do nó. Para mais informações, consulte os seguintes tópicos: PolarDB for MySQL: Especificações de nós de computação. PolarDB for PostgreSQL (Compatível com Oracle): Especificações de nós de computação. PolarDB for PostgreSQL: Especificações de nós de computação. Nota Para criar um cluster serverless para PolarDB for MySQL Cluster Edition, defina este parâmetro como polar.mysql.sl.small. Para criar um cluster serverless para PolarDB for MySQL Standard Edition, defina este parâmetro como polar.mysql.sl.small.c. Para criar um cluster serverless para PolarDB for PostgreSQL Cluster Edition, defina este parâmetro como polar.pg.sl.small. Para criar um cluster serverless para PolarDB for PostgreSQL Standard Edition, defina este parâmetro como polar.pg.sl.small.c. Para criar um cluster serverless para PolarDB for PostgreSQL (Compatível com Oracle), defina este parâmetro como polar.o.sl.small.	polar.mysql.x4.medium
ClusterNetworkType	string	Não	O tipo de rede do cluster. Apenas Virtual Private Cloud (VPC) é suportado. Defina o valor como VPC.	VPC
DBClusterDescription	string	Não	O nome do cluster. O nome deve atender aos seguintes requisitos: Não pode começar com `http://` ou `https://`. Deve ter de 2 a 256 caracteres.	test
PayType	string	Sim	O método de cobrança. Valores válidos: Postpaid: pós-pago. Prepaid: assinatura.	Postpaid
AutoRenew	boolean	Não	Especifica se a renovação automática deve ser ativada. Valores válidos: true: A renovação automática é ativada. false: A renovação automática é desativada. Valor padrão: false. Nota Este parâmetro tem efeito apenas quando PayType é definido como Prepaid.	true
Period	string	Não	Este parâmetro é obrigatório quando PayType é definido como Prepaid. Passe este parâmetro para especificar se o cluster antecipado usa um ciclo de cobrança anual ou mensal. Year: O período de assinatura é medido em anos. Month: O período de assinatura é medido em meses.	Month
UsedTime	string	Não	Este parâmetro é obrigatório quando PayType é definido como Prepaid. Quando Period é definido como Month, os valores válidos de UsedTime são inteiros no intervalo de `[1-9]`. Quando Period é definido como Year, os valores válidos de UsedTime são inteiros no intervalo de `[1-3]`.	1
VPCId	string	Não	O ID da VPC.	vpc-**********
VSwitchId	string	Não	O ID do vSwitch. Nota Se você especificar VPCId, também deverá especificar VSwitchId.	vsw-**********
CreationOption	string	Não	O método usado para criar o cluster. Valores válidos: Normal: Cria um novo cluster PolarDB. Para operações no console, consulte os seguintes tópicos: Criar um cluster de banco de dados PolarDB for MySQL Criar um cluster de banco de dados PolarDB for PostgreSQL Criar um cluster de banco de dados PolarDB for PostgreSQL (Compatível com Oracle) CloneFromPolarDB: Clona dados de um cluster PolarDB existente para um novo cluster PolarDB. Para operações no console, consulte os seguintes tópicos: Clonar um cluster PolarDB for MySQL Clonar um cluster PolarDB for PostgreSQL Clonar um cluster PolarDB for PostgreSQL (Compatível com Oracle) RecoverFromRecyclebin: Recupera dados de um cluster PolarDB liberado para um novo cluster PolarDB. Para operações no console, consulte os seguintes tópicos: Restaurar um cluster PolarDB for MySQL liberado Restaurar um cluster PolarDB for PostgreSQL liberado Restaurar um cluster PolarDB for PostgreSQL (Compatível com Oracle) liberado CloneFromRDS: Clona dados de uma instância ApsaraDB RDS existente para um novo cluster PolarDB. Para operações no console, consulte Clonar uma instância ApsaraDB RDS for MySQL para um cluster PolarDB for MySQL. MigrationFromRDS: Migra dados de uma instância ApsaraDB RDS existente para um novo cluster PolarDB. O cluster PolarDB criado está em modo somente leitura e tem o log binário ativado por padrão. Para operações no console, consulte Atualizar uma instância ApsaraDB RDS for MySQL para um cluster PolarDB for MySQL. CreateGdnStandby: Cria um cluster secundário. Para operações no console, consulte Adicionar um cluster secundário. UpgradeFromPolarDB: Realiza a migração de instância do PolarDB. Para operações no console, consulte Atualização de versão principal do mecanismo. Valor padrão: Normal. Nota Quando DBType é definido como MySQL e DBVersion é definido como 8.0, você pode definir este parâmetro como CreateGdnStandby.	Normal
SourceResourceId	string	Não	O ID da instância ApsaraDB RDS de origem ou do cluster PolarDB de origem. Este parâmetro é obrigatório apenas quando CreationOption é definido como MigrationFromRDS, CloneFromRDS, CloneFromPolarDB ou RecoverFromRecyclebin. Se CreationOption for definido como MigrationFromRDS ou CloneFromRDS, defina este parâmetro como o ID da instância ApsaraDB RDS de origem. A instância ApsaraDB RDS de origem deve executar RDS MySQL 5.6, 5.7 ou 8.0 na RDS High-availability Edition. Se CreationOption for definido como CloneFromPolarDB, defina este parâmetro como o ID do cluster PolarDB de origem. O cluster clonado e o cluster de origem têm o mesmo DBType por padrão. Por exemplo, se o cluster de origem executa MySQL 8.0, defina DBType como MySQL e DBVersion como 8.0 para o cluster clonado. Se CreationOption for definido como RecoverFromRecyclebin, defina este parâmetro como o ID do cluster PolarDB de origem liberado. O cluster recuperado e o cluster de origem devem ter o mesmo DBType. Por exemplo, se o cluster de origem executa MySQL 8.0, defina DBType como MySQL e DBVersion como 8.0 para o cluster recuperado.	rm-*************
CloneDataPoint	string	Não	O ponto no tempo em que os dados são clonados. Valores válidos: LATEST: O ponto no tempo mais recente. BackupID: Um ID de conjunto de backup histórico. Especifique o ID real do conjunto de backup. Timestamp: Um ponto no tempo histórico. Especifique o horário real no formato `YYYY-MM-DDThh:mm:ssZ` (UTC). Valor padrão: LATEST. Nota Se CreationOption for definido como CloneFromRDS, este parâmetro só pode ser definido como LATEST.	LATEST
ClientToken	string	Não	O token do cliente usado para garantir a idempotência da solicitação. O valor é gerado pelo cliente e deve ser único entre diferentes solicitações. É sensível a maiúsculas e minúsculas e não pode exceder 64 caracteres ASCII.	6000170000591aed949d0f5********************
ResourceGroupId	string	Não	O ID do grupo de recursos.	rg-************
SecurityIPList	string	Não	Os endereços IP na lista de permissões do cluster PolarDB. Nota Você pode especificar vários endereços IP. Separe vários endereços IP com vírgulas (,).	10.*..**
TDEStatus	boolean	Não	Especifica se o Transparent Data Encryption (TDE) deve ser ativado. Valores válidos: true: O TDE é ativado. false: O TDE é desativado. Este é o valor padrão. Nota Este parâmetro tem efeito apenas quando DBType é definido como PostgreSQL ou Oracle. Você pode chamar a operação ModifyDBClusterTDE para ativar o TDE para um cluster PolarDB for MySQL. O TDE não pode ser desativado após ser ativado.	true
GDNId	string	Não	O ID da rede de banco de dados global (GDN). Nota Este parâmetro é obrigatório quando CreationOption é definido como CreateGdnStandby.	gdn-***********
CreationCategory	string	Não	A edição do cluster. Valores válidos: Normal: Cluster Edition. Este é o valor padrão. Basic: Single Node Edition. ArchiveNormal: X-Engine Edition. NormalMultimaster: Multi-master Cluster Edition. SENormal: Standard Edition. Nota MySQL 5.6, 5.7, 8.0, PostgreSQL 14 e Oracle syntax-compatible 2.0 suportam Basic. MySQL 8.0 suporta ArchiveNormal e NormalMultimaster. MySQL 5.6, 5.7, 8.0 e PostgreSQL 14 suportam SENormal. Para mais informações sobre edições, consulte Edições do produto.	Normal
DefaultTimeZone	string	Não	O fuso horário padrão do cluster (UTC). O valor pode ser qualquer intervalo de tempo dentro do intervalo de -12:00 a +13:00, como 00:00. Valor padrão: SYSTEM, que indica que o fuso horário padrão é o mesmo que o fuso horário da região. Nota Este parâmetro tem efeito apenas quando DBType é definido como MySQL.	SYSTEM
LowerCaseTableNames	string	Não	Especifica se os nomes de tabelas são sensíveis a maiúsculas e minúsculas. Valores válidos: 1: Os nomes de tabelas não são sensíveis a maiúsculas e minúsculas. 0: Os nomes de tabelas são sensíveis a maiúsculas e minúsculas. Valor padrão: 1. Nota Este parâmetro tem efeito apenas quando DBType é definido como MySQL.	1
BackupRetentionPolicyOnClusterDeletion	string	Não	A política de retenção de dados aplicada quando o cluster é excluído. Valores válidos: ALL: Todos os backups são retidos para retenção de longo prazo (LTR). LATEST: O último backup é retido para retenção de longo prazo (LTR). Um backup automático é realizado antes da exclusão. NONE: Nenhum backup é retido quando o cluster é excluído. Valor padrão: NONE, o que significa que nenhum backup é retido quando o cluster é excluído. Nota Este parâmetro tem efeito apenas quando DBType é definido como MySQL. Clusters serverless não suportam este parâmetro.	NONE
StorageSpace	integer	Não	O espaço de armazenamento para cobrança por assinatura (pagamento por espaço). Unidade: GB. Nota Valores válidos para PolarDB for MySQL Enterprise Edition: 10 a 50000. Valores válidos para PolarDB for MySQL Standard Edition: 20 a 64000. Quando o tipo de armazenamento da Standard Edition é ESSDAUTOPL, os valores válidos são de 40 a 64000 com um incremento mínimo de 10. Apenas valores como 40, 50, 60 e assim por diante são aceitos.	50
DBMinorVersion	string	Não	A versão secundária do mecanismo. Valores válidos: 8.0.2 8.0.1 Nota Este parâmetro tem efeito apenas quando DBType é definido como MySQL e DBVersion é definido como 8.0.	8.0.1
ParameterGroupId	string	Não	O ID do modelo de parâmetros. Nota Você pode chamar a operação DescribeParameterGroups para consultar a lista de modelos de parâmetros na região especificada, incluindo o ID do modelo de parâmetros.	pcpg-**************
Tag	array<object>	Não	A lista de tags.
	object	Não
Key	string	Não	A chave da tag. Para adicionar várias tags ao cluster de uma vez, clique em Adicionar para adicionar chaves de tag. Nota Você pode adicionar até 20 pares de tags por vez. `Tag.N.Key` corresponde a `Tag.N.Value`.	type
Value	string	Não	O valor da tag. Para adicionar várias tags ao cluster de uma vez, clique em Adicionar para adicionar valores de tag. Nota Você pode adicionar até 20 pares de tags por vez. `Tag.N.Value` corresponde a `Tag.N.Key`.	test
ServerlessType	string	Não	O tipo serverless. Defina o valor como AgileServerless (ágil). Nota Apenas clusters serverless suportam este parâmetro.	AgileServerless
ScaleMin	string	Não	O limite mínimo de escalabilidade para um único nó. Valores válidos: 1 PCU a 31 PCU. Nota Apenas clusters serverless suportam este parâmetro.	1
ScaleMax	string	Não	O limite máximo de escalabilidade para um único nó. Valores válidos: 1 PCU a 32 PCU. Nota Apenas clusters serverless suportam este parâmetro.	3
AllowShutDown	string	Não	Especifica se a Suspensão por Inatividade deve ser ativada. Valores válidos: true: Ativada. false: Desativada. Este é o valor padrão. Nota Apenas clusters serverless suportam este parâmetro.	true
ScaleRoNumMin	string	Não	O número mínimo de nós somente leitura para escalabilidade. Valores válidos: 0 a 15. Nota Apenas clusters serverless suportam este parâmetro.	2
ScaleRoNumMax	string	Não	O número máximo de nós somente leitura para escalabilidade. Valores válidos: 0 a 15. Nota Apenas clusters serverless suportam este parâmetro.	4
StorageType	string	Não	Valores válidos para o tipo de armazenamento da Enterprise Edition: PSL5 PSL4 Valores válidos para o tipo de armazenamento da Standard Edition: ESSDPL0 ESSDPL1 ESSDPL2 ESSDPL3 ESSDAUTOPL	PSL4
DBNodeNum	integer	Não	O número de nós para Standard Edition e Enterprise Edition. Valores válidos: Standard Edition: 1 a 8 (suporta 1 nó de leitura/gravação e 7 nós somente leitura). Enterprise Edition: 1 a 16 (suporta 1 nó de leitura/gravação e 15 nós somente leitura). Nota A Enterprise Edition tem 2 nós por padrão. A Standard Edition tem 1 nó por padrão. Apenas PolarDB for MySQL suporta este parâmetro. A alteração do número de nós para clusters Multi-master Cluster Edition não é suportada.	1
HotStandbyCluster	string	Não	Especifica se o cluster hot standby deve ser ativado. Valores válidos: ON (padrão): Ativa o cluster de armazenamento hot standby. OFF: Desativa o cluster hot standby. STANDBY: Ativa o cluster hot standby. EQUAL: Ativa tanto o cluster de armazenamento hot standby quanto o cluster de computação hot standby. 3AZ: Ativa a consistência forte de dados multi-zona. Nota STANDBY tem efeito apenas para PolarDB for PostgreSQL.	ON
StrictConsistency	string	Não	Especifica se a consistência forte de dados multi-zona está ativada para o cluster. Valores válidos: ON: A consistência forte de dados multi-zona está ativada. Este valor se aplica ao cenário 3AZ da Standard Edition. OFF: A consistência forte de dados multi-zona está desativada.	ON
StandbyAZ	string	Não	A zona do cluster hot standby. Nota Este parâmetro tem efeito apenas quando o cluster hot standby ou a consistência forte de dados multi-zona está ativada.	cn-hangzhou-g
ProxyType	string	Não	O tipo do proxy de banco de dados. Valores válidos: EXCLUSIVE: Dedicated Enterprise Edition. GENERAL: Standard Enterprise Edition. Nota O tipo de proxy deve corresponder ao tipo que corresponde às especificações de nó do cluster: Se as especificações de nó forem General-purpose, defina o tipo de proxy como Standard Enterprise Edition. Se as especificações de nó forem Dedicated, defina o tipo de proxy como Dedicated Enterprise Edition.	Exclusive
ProxyClass	string	Não	A especificação do proxy de banco de dados para Standard Edition. Valores válidos: polar.maxscale.g2.medium.c: 2 núcleos. polar.maxscale.g2.large.c: 4 núcleos. polar.maxscale.g2.xlarge.c: 8 núcleos. polar.maxscale.g2.2xlarge.c: 16 núcleos. polar.maxscale.g2.3xlarge.c: 24 núcleos. polar.maxscale.g2.4xlarge.c: 32 núcleos. polar.maxscale.g2.8xlarge.c: 64 núcleos.	polar.maxscale.g2.medium.c
LoosePolarLogBin	string	Não	Especifica se o recurso de log binário deve ser ativado. Valores válidos: ON: O log binário é ativado para o cluster. OFF: O log binário é desativado para o cluster. Nota Este parâmetro tem efeito apenas quando DBType é definido como MySQL.	ON
LooseXEngine	string	Não	Especifica se o mecanismo de armazenamento X-Engine deve ser ativado. Valores válidos: ON: O mecanismo X-Engine é ativado para o cluster. OFF: O mecanismo X-Engine é desativado para o cluster. Nota Este parâmetro tem efeito apenas quando CreationOption não é definido como CreateGdnStandby, DBType é definido como MySQL e DBVersion é definido como 8.0. A especificação de memória dos nós com X-Engine ativado deve ser de 8 GB ou mais.	ON
LooseXEngineUseMemoryPct	string	Não	A porcentagem de memória alocada para o mecanismo de armazenamento X-Engine. Valores válidos: inteiros de 10 a 90. Nota Este parâmetro tem efeito apenas quando LooseXEngine é definido como ON.	50
StoragePayType	string	Não	O tipo de cobrança para armazenamento. Valores válidos: Postpaid: pagamento por capacidade (pós-pago). Prepaid: pagamento por espaço (assinatura).	Prepaid
StorageAutoScale	string	Não	Especifica se a escalabilidade automática de armazenamento deve ser ativada para clusters Standard Edition. Valores válidos: Enable: A escalabilidade automática de armazenamento é ativada. Disable: A escalabilidade automática de armazenamento é desativada.	Enable
StorageUpperBound	integer	Não	Define o limite superior para a escalabilidade automática de armazenamento de clusters Standard Edition. Unidade: GB. Nota O valor máximo é 32000.	800
ProvisionedIops	integer	Não		1000
BurstingEnabled	string	Não	Especifica se o burst de desempenho de I/O deve ser ativado para o disco em nuvem ESSD AutoPL. Valores válidos: true: Ativado. false: Desativado. Este é o valor padrão. Nota Este parâmetro é suportado apenas quando StorageType é definido como ESSDAUTOPL.	false
TargetMinorVersion	string	Não	A versão secundária de destino do mecanismo.	8.0.1.1.54
StorageEncryption	boolean	Não	Especifica se a criptografia de disco em nuvem deve ser ativada. Valores válidos: true: A criptografia de disco em nuvem é ativada. false: A criptografia de disco em nuvem é desativada. Este é o valor padrão. Nota Este parâmetro tem efeito apenas quando DBType é definido como MySQL. Nota Este parâmetro tem efeito apenas quando StorageType é definido como um tipo de armazenamento da Standard Edition.
StorageEncryptionKey	string	Não	O ID da chave de criptografia personalizada para criptografia de disco em nuvem na mesma região da instância. Especificar este parâmetro ativa automaticamente a criptografia de disco em nuvem, que não pode ser desativada após ser ativada. Deixe este parâmetro vazio para usar a chave de serviço padrão para criptografia de disco em nuvem. Você pode visualizar o ID da chave no console do Key Management Service (KMS) ou criar uma nova chave. Nota Este parâmetro tem efeito apenas quando DBType é definido como MySQL. Nota Este parâmetro tem efeito apenas quando StorageType é definido como um tipo de armazenamento da Standard Edition.	1022xxxxxxxx
SourceUid	integer	Não	O UID da conta proprietária do conjunto de backup de origem em cenários de restauração de backup entre contas.	1022xxxxxxxx
CloudProvider	string	Não	O provedor de serviços em nuvem da instância.	ENS
EnsRegionId	string	Não	O ID do nó ENS necessário ao criar um banco de dados ENS.	vn-hanoi-3
AutoUseCoupon	boolean	Não	Especifica se os cupons devem ser usados automaticamente. Valores válidos: true (padrão): Os cupons são usados. false: Os cupons não são usados.	true
PromotionCode	string	Não	O código do cupom. Se não especificado, o cupom padrão é usado.	727xxxxxx934

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
DBClusterId	string	O ID do cluster.	pc-bp1s826a1up******
OrderId	string	O ID do pedido.	211454967******
RequestId	string	O ID da solicitação.	E56531A4-E552-40BA-9C58-137B80******
ResourceGroupId	string	O ID do grupo de recursos.	rg-***************
AgenticDbClusterId	string
AgenticDbClusterDescription	string

Exemplos

Resposta de sucesso

JSON formato

{
  "DBClusterId": "pc-bp1s826a1up******",
  "OrderId": "211454967******",
  "RequestId": "E56531A4-E552-40BA-9C58-137B80******",
  "ResourceGroupId": "rg-***************",
  "AgenticDbClusterId": "",
  "AgenticDbClusterDescription": ""
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	InvalidBackupRetentionPolicyOnClusterDeletion.Malformed	The specified BackupRetentionPolicyOnClusterDeletion is invalid.	O parâmetro BackupRetentionPolicyOnClusterDeletion especificado para a política de retenção de backup ao excluir o cluster é inválido.
400	InvalidLowerCaseTableNames.Malformed	The specified LowerCaseTableNames is invalid.	O parâmetro de sensibilidade a maiúsculas e minúsculas especificado (LowerCaseTableNames) é inválido.
400	InvalidDefaultTimeZone.Malformed	The specified DefaultTimeZone is invalid.	O parâmetro de fuso horário padrão especificado (DefaultTimeZone) é inválido.
400	Location.FailedGetSubDomain	The specified regionId does not match the zoneId or the zoneId does not exist.	O ID da região especificado não corresponde ao ID da zona, ou o ID da zona não existe.
400	MissParameter.GDNId	The GDNId parameter is required.	O parâmetro GDNId é obrigatório.
400	EntityNotExist.ResourceGroup	The resource group does not exist..	O grupo de recursos não existe.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.