Criar uma instância somente leitura - : Central de Documentação do Alibaba Cloud

Antes de chamar esta operação, observe os seguintes limites:

A instância primária não pode pertencer a um cluster dedicado e deve executar uma das seguintes versões de mecanismo de banco de dados e edições do RDS:
- MySQL 8.0 no RDS High-availability Edition ou RDS Enterprise Edition.
- MySQL 5.7 no RDS High-availability Edition ou RDS Enterprise Edition.
- MySQL 5.6.
- SQL Server 2017 no RDS Cluster Edition.
- PostgreSQL 10, PostgreSQL 11, PostgreSQL 12, PostgreSQL 13, PostgreSQL 14 ou PostgreSQL 15 no RDS High-availability Edition. Se a instância primária executar PostgreSQL 10, ela deverá usar SSDs locais e ser uma instância dedicada com pelo menos 8 núcleos e 32 GB de memória.
Para instâncias primárias MySQL, é possível criar até 10 instâncias somente leitura.
Para instâncias primárias SQL Server, o limite é de sete instâncias somente leitura.
Se a instância primária executar PostgreSQL com SSDs locais, você poderá criar até cinco instâncias somente leitura. Caso utilize SSDs padrão ou ESSDs, esse limite sobe para 32 instâncias somente leitura.

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 da solicitação

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Sim	CreateReadOnlyDBInstance	A operação a ser executada. Defina o valor como CreateReadOnlyDBInstance.
ClientToken	String	Não	ETnLKlblzczshOTUbOC****	Token do cliente usado para garantir a idempotência da solicitação. Use o cliente para gerar o valor, mas certifique-se de que ele seja único entre diferentes solicitações. O token pode conter apenas caracteres ASCII e não deve exceder 64 caracteres.
RegionId	String	Sim	cn-hangzhou	ID da região da instância somente leitura. A instância somente leitura e a instância primária devem residir na mesma região. Chame a operação DescribeRegions para consultar a lista de regiões mais recente.
ZoneId	String	Sim	cn-hangzhou-b	ID da zona da instância somente leitura. Chame a operação DescribeRegions para consultar a lista de zonas mais recente.
DBInstanceId	String	Sim	rm-uf6wjk5****	ID da instância primária.
DBInstanceClass	String	Sim	rds.mys2.small	Tipo da instância somente leitura. Para obter mais informações, consulte Tipos de instância somente leitura do ApsaraDB RDS. Recomendamos especificar um tipo de instância cujas especificações sejam superiores ou iguais às da instância primária. Especificações inferiores podem causar problemas como alta latência e sobrecarga.
DBInstanceStorage	Integer	Sim	20	Capacidade de armazenamento da instância somente leitura. Para mais detalhes, veja a coluna Espaço de armazenamento em Tipos de instância somente leitura. Este valor deve ser múltiplo de 5 GB. Unidade: GB.
EngineVersion	String	Sim	5.6	Versão principal do mecanismo da instância somente leitura. Ela deve corresponder à versão principal da instância primária. Para MySQL, defina este parâmetro como 5.6, 5.7 ou 8.0. Para SQL Server, defina este parâmetro como 2017_ent ou 2019_ent. Para PostgreSQL, defina este parâmetro como 10.0, 11.0, 12.0, 13.0, 14.0 ou 15.0.
PayType	String	Sim	Postpaid	Método de faturamento da instância somente leitura. Valores válidos: Postpaid: pagamento conforme o uso Prepaid: assinatura
DBInstanceDescription	String	Não	Instância somente leitura de teste	Descrição da instância somente leitura. Deve ter entre 2 e 256 caracteres, podendo conter letras, dígitos, sublinhados (_) e hifens (-). O valor deve começar com uma letra. Nota Não pode começar com http:// ou https://.
InstanceNetworkType	String	Não	Classic	Tipo de rede da instância somente leitura. Valores válidos: VPC Classic Valor padrão: VPC. Se definir este parâmetro como VPC, você também deverá especificar os parâmetros VPCId e VSwitchId. Nota O tipo de rede da instância somente leitura pode ser diferente do tipo de rede da instância primária.
VPCId	String	Não	vpc-uf6f7l4fg90****	ID da Virtual Private Cloud (VPC) à qual a instância somente leitura pertence. Se deixar o parâmetro InstanceNetworkType vazio ou defini-lo como VPC, será obrigatório especificar também este parâmetro. Nota Se a instância primária usar SSDs locais, ambas as instâncias poderão pertencer à mesma VPC ou a VPCs diferentes. Caso a instância primária utilize SSDs padrão ou ESSDs, ambas devem pertencer obrigatoriamente à mesma VPC.
VSwitchId	String	Não	vsw-uf6adz52c2p****	ID do vSwitch ao qual a instância somente leitura pertence. Se deixar o parâmetro InstanceNetworkType vazio ou defini-lo como VPC, será obrigatório especificar também este parâmetro.
PrivateIpAddress	String	Não	172.16.XX.XX	Endereço IP privado da instância somente leitura. Ele deve estar dentro do bloco CIDR suportado pelo vSwitch especificado. O sistema atribui automaticamente um endereço IP privado com base nos valores dos parâmetros VPCId e VSwitchId.
ResourceGroupId	String	Não	rg-acfmy****	ID do grupo de recursos ao qual a instância somente leitura pertence.
Category	String	Não	HighAvailability	Edição do RDS da nova instância. Valores válidos: Basic: RDS Basic Edition. HighAvailability: RDS High-availability Edition. Este é o valor padrão. AlwaysOn: RDS Cluster Edition. Nota Se a instância somente leitura executar PostgreSQL com SSDs padrão ou ESSDs, você deverá definir este parâmetro como Basic.
DBInstanceStorageType	String	Não	local_ssd	Tipo de armazenamento da instância somente leitura. Valores válidos: local_ssd: SSD local cloud_ssd: SSD padrão cloud_essd: ESSD de nível de desempenho 1 (PL1) cloud_essd2: ESSD de PL2 cloud_essd3: ESSD de PL3 Nota Se a instância primária executar MySQL com SSDs locais, defina este parâmetro como local_ssd. Para MySQL com SSDs padrão ou ESSDs, defina como cloud_ssd, cloud_essd, cloud_essd2 ou cloud_essd3. Para instâncias primárias SQL Server, defina como cloud_ssd, cloud_essd, cloud_essd2 ou cloud_essd3.
DedicatedHostGroupId	String	Não	dhg-4n****	ID do cluster dedicado ao qual a instância somente leitura pertence. Este parâmetro é válido apenas ao criar a instância somente leitura em um cluster dedicado.
TargetDedicatedHostIdForMaster	String	Não	i-bp****	ID do host da instância primária à qual a instância somente leitura está anexada. Este parâmetro é válido apenas ao criar a instância somente leitura em um cluster dedicado.
GdnInstanceName	String	Não	None	Parâmetro reservado.
TddlBizType	String	Não	None	Parâmetro reservado.
TddlRegionConfig	String	Não	None	Parâmetro reservado.
InstructionSetArch	String	Não	None	Parâmetro reservado.
UsedTime	String	Não	1	Período de assinatura da instância somente leitura. Valores válidos: Se definir o parâmetro Period como Year, o valor do parâmetro UsedTime varia de 1 a 5. Se definir o parâmetro Period como Month, o valor do parâmetro UsedTime varia de 1 a 9. Nota Se definir o parâmetro PayType como Prepaid, será obrigatório especificar também este parâmetro.
Period	String	Não	Month	Ciclo de renovação da instância somente leitura. Valores válidos: Year Month
AutoRenew	String	Não	true	Define se a renovação automática será ativada para a instância somente leitura. Se definir o parâmetro PayType como Prepaid, será obrigatório especificar também este parâmetro. Valores válidos: true: ativa a renovação automática. false: desativa a renovação automática. Nota Se definir o parâmetro Period como Month, o ciclo de renovação automática será mensal. Se definir o parâmetro Period como Year, o ciclo de renovação automática será anual.
DeletionProtection	Boolean	Não	true	Define se a proteção contra liberação será ativada para a instância somente leitura. Valores válidos: true: ativa a proteção contra liberação. false: desativa a proteção contra liberação. Este é o valor padrão. Nota Este recurso só pode ser ativado quando o parâmetro PayType for definido como Postpaid.

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
DBInstanceId	String	rr-uf6wjk5****	ID da instância somente leitura.
RequestId	String	1E43AAE0-BEE8-43DA-860D-EAF2AA0724DC	ID da solicitação.
Port	String	3306	Número da porta interna usada para conectar-se à instância somente leitura.
ConnectionString	String	rr-****.mysql.rds.aliyuncs.com	Endpoint interno usado para conectar-se à instância somente leitura.
OrderId	String	10078937****	ID do pedido.

Exemplos

Exemplos de solicitações

http(s)://rds.aliyuncs.com/?Action=CreateReadOnlyDBInstance
&ClientToken=ETnLKlblzczshOTUbOC****
&RegionId=cn-hangzhou
&ZoneId=cn-hangzhou-b
&DBInstanceId=rm-uf6wjk5****
&DBInstanceClass=rds.mys2.small
&DBInstanceStorage=20
&EngineVersion=5.6
&PayType=Postpaid
&DBInstanceDescription=Test read-only instance
&InstanceNetworkType=Classic
&VPCId=vpc-uf6f7l4fg90****
&VSwitchId=vsw-uf6adz52c2p****
&PrivateIpAddress=172.16.XX.XX
&ResourceGroupId=rg-acfmy****
&Category=HighAvailability
&DBInstanceStorageType=local_ssd
&DedicatedHostGroupId=dhg-4n****
&TargetDedicatedHostIdForMaster=i-bp****
&GdnInstanceName=None
&TddlBizType=None
&TddlRegionConfig=None
&InstructionSetArch=None
&UsedTime=1
&Period=Month
&AutoRenew=true
&DeletionProtection=true
&<Common request parameters>

Exemplos de respostas de sucesso

Formato XML

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

<CreateReadOnlyDBInstanceResponse>
    <DBInstanceId>rr-uf6wjk5****</DBInstanceId>
    <RequestId>1E43AAE0-BEE8-43DA-860D-EAF2AA0724DC</RequestId>
    <Port>3306</Port>
    <ConnectionString>rr-****.mysql.rds.aliyuncs.com</ConnectionString>
    <OrderId>10078937****</OrderId>
</CreateReadOnlyDBInstanceResponse>

Formato JSON

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

{
  "DBInstanceId" : "rr-uf6wjk5****",
  "RequestId" : "1E43AAE0-BEE8-43DA-860D-EAF2AA0724DC",
  "Port" : 3306,
  "ConnectionString" : "rr-****.mysql.rds.aliyuncs.com",
  "OrderId" : "10078937****"
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	InvalidSecurityIPList.Duplicate	The Security IP address is not in the available range or occupied.	Mensagem retornada porque o endereço IP especificado está em uso ou fora do intervalo válido. Especifique um endereço IP válido e tente novamente.
400	OperationDenied	VPC IP is in use, please check.	Mensagem retornada porque o endereço IP da VPC especificado já está em uso.
400	InvalidZoneId.NotSupported	The Specified vpc Zone not supported.	Mensagem retornada porque a zona especificada não suporta a criação de instâncias do tipo de rede VPC. Escolha outra zona e tente novamente.
400	CDDC.AvailableHostsNotEnoughInZone	Not enough available hosts are in the target zone.	Mensagem retornada porque não há hosts disponíveis na zona especificada. Crie um host na zona e tente novamente.
403	OperationDenied.PrimaryDBInstanceStatus	The operation is not permitted due to status of primary instance.	Mensagem retornada porque a instância pertence a um cluster dedicado e não está no estado Running.
404	IncorrectDBInstanceConnType	Current DB instance conn type does not support this operation.	Mensagem retornada porque o tipo de conexão de rede da instância não suporta esta operação.
500	CannotDecreaseEssdPerfLevel	cannot decrease cloud essd performance level.	Mensagem retornada porque a alteração do tipo de armazenamento falhou na validação. O tipo de armazenamento de uma instância SQL Server com discos em nuvem só pode ser convertido para outro tipo de disco em nuvem. Instâncias SQL Server com SSDs padrão podem ser atualizadas para SSDs padrão ou ESSDs com as novas especificações.
500	InvalidEssdStorageSize	invalid cloud essd storage size.	Mensagem retornada porque o tipo de instância especificado é inválido. Selecione um tipo de instância válido e tente novamente.

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