CreateReadOnlyDBInstance - ApsaraDB RDS - Centro de documentación de Alibaba Cloud

Crea una instancia de solo lectura para una instancia de ApsaraDB RDS.

Descripción de la operación

Motores admitidos

RDS MySQL
RDS PostgreSQL
RDS SQL Server

Documentación relacionada

Importante Antes de llamar a esta operación, lea atentamente la siguiente documentación, asegúrese de comprender completamente los requisitos previos y los impactos de esta operación y, a continuación, proceda.

Pruébelo ahora

Pruebe esta API en OpenAPI Explorer sin necesidad de firma manual. Las llamadas exitosas generan automáticamente código SDK acorde a sus parámetros. Descárguelo con seguridad de credenciales integrada para uso local.

Test

Autorización de RAM

La siguiente tabla describe la autorización necesaria para invocar esta API. Puede definirla en una directiva de Resource Access Management (RAM). A continuación, se detallan las columnas de la tabla:

Action: Estas acciones se utilizan en el elemento Action de las declaraciones de directivas de permisos de RAM para otorgar permisos que permitan realizar la operación.
API: La API que debe invocarse para llevar a cabo la acción.
Nivel de acceso: Nivel de acceso predefinido que se concede para cada API. Valores válidos: create, list, get, update y delete.
Tipo de recurso: Tipo de recurso que admite autorización para ejecutar la acción. Indica si la acción es compatible con permisos a nivel de recurso. El recurso especificado debe ser compatible con la acción; de lo contrario, la directiva no surtirá efecto.
- En las API con permisos a nivel de recurso, los tipos de recursos obligatorios se marcan con un asterisco (*). Especifique el Alibaba Cloud Resource Name (ARN) correspondiente en el elemento Resource de la directiva.
- Para las API sin permisos a nivel de recurso, se muestra All Resources. Utilice un asterisco (*) en el elemento Resource de la directiva.
Clave de condición: Claves de condición definidas por el servicio. Permiten un control granular y se aplican ya sea solo a acciones o a acciones asociadas con recursos específicos. Además de las claves de condición específicas del servicio, Alibaba Cloud proporciona un conjunto de common condition keys aplicables a todos los servicios compatibles con RAM.
Acción dependiente: Acciones dependientes necesarias para ejecutar la acción principal. Para completar la operación, el usuario de RAM o el rol de RAM debe contar con permisos para realizar todas las acciones dependientes.

Action

Nivel de acceso

Tipo de recurso

Clave de condición

Acción dependiente

rds:CreateReadOnlyDBInstance

create

*DBInstance.

acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

rds:ResourceTag

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
ClientToken	string	No	El token de cliente que se usa para garantizar la idempotencia de la solicitud. Puede usar el cliente para generar el token, pero debe asegurarse de que el token sea único entre diferentes solicitudes. El token solo puede contener caracteres ASCII y no puede exceder los 64 caracteres de longitud.	ETnLKlblzczshOTUbOC****
RegionId	string	Sí	El ID de la región. La instancia de solo lectura debe residir en la misma región que la instancia principal. Puede llamar a DescribeRegions para consultar el ID de la región.	cn-hangzhou
ZoneId	string	Sí	El ID de la zona. Puede invocar DescribeRegions para consultar el ID de la zona. Para desplegar la instancia de solo lectura en una sola zona, especifique una zona, como `cn-hangzhou-b`. Para desplegar la instancia de solo lectura en varias zonas, especifique varias zonas separadas por dos puntos (:), como `cn-hangzhou-b:cn-hangzhou-c`. La cantidad de zonas especificadas debe ser menor o igual que la cantidad de nodos de la instancia de solo lectura. Una instancia de solo lectura de edición básica contiene solo un nodo. Una instancia de solo lectura de serie de alta disponibilidad contiene dos nodos (un nodo principal y un nodo secundario).	cn-hangzhou-b
DBInstanceId	string	Sí	El ID de la instancia principal. Puede llamar a DescribeDBInstances para consultar el ID de la instancia.	rm-uf6wjk5****
DBInstanceClass	string	Sí	El tipo de instancia. Para obtener más información, consulte Tipos de instancia de solo lectura. El tipo de instancia de la instancia de solo lectura debe ser igual o superior al de la instancia principal. De lo contrario, la instancia de solo lectura puede experimentar alta latencia y cargas elevadas.	mysqlro.n2.small.1c
DBInstanceStorage	integer	Sí	La capacidad de almacenamiento de la instancia. La capacidad de almacenamiento de la instancia de solo lectura debe ser mayor o igual que la de la instancia principal. Para obtener más información, consulte la columna Capacidad de almacenamiento en Tipos de instancia de solo lectura. El valor se incrementa en unidades de 5 GB. Unidad: GB.	20
EngineVersion	string	Sí	La versión del motor de base de datos. La versión debe ser la misma que la de la instancia principal. MySQL: 5.6, 5.7 y 8.0. SQL Server: 2017_ent, 2019_ent y 2022_ent. PostgreSQL: 10.0, 11.0, 12.0, 13.0, 14.0 y 15.0.	5.6
PayType	string	Sí	El método de facturación. Valores válidos: Postpaid: pago por uso. Prepaid: suscripción.	Postpaid
DBInstanceDescription	string	No	La descripción de la instancia. La descripción debe tener de 2 a 256 caracteres y puede contener letras, dígitos, guiones bajos (_) y guiones (-). Debe comenzar con una letra o un carácter chino. Nota La descripción no puede comenzar con http:// o https://.	testReadOnly
InstanceNetworkType	string	No	El tipo de red de la instancia de solo lectura. Valores válidos: VPC: nube privada virtual (VPC). Classic: red clásica. De forma predeterminada, se crea una instancia conectada a una VPC. También debe especificar VPCId y VSwitchId. Nota El tipo de red de la instancia de solo lectura puede ser diferente del de la instancia principal.	Classic
VPCId	string	No	El ID de VPC de la instancia de solo lectura. Este parámetro es obligatorio cuando InstanceNetworkType se deja vacío o se establece en VPC. Nota Si el tipo de almacenamiento de la instancia principal es Premium Local SSDs, la instancia de solo lectura puede usar cualquier VPC. Si el tipo de almacenamiento de la instancia principal es discos en la nube, la VPC de la instancia de solo lectura debe ser la misma que la de la instancia principal.	vpc-uf6f7l4fg90****
VSwitchId	string	No	El ID de vSwitch de la instancia de solo lectura. Este parámetro es obligatorio cuando InstanceNetworkType se deja vacío o se establece en VPC.	vsw-uf6adz52c2p****
PrivateIpAddress	string	No	La configuración de la dirección IP de red interna de la instancia de solo lectura. La dirección IP debe estar dentro del rango de direcciones del vSwitch especificado. De forma predeterminada, el sistema asigna automáticamente una dirección IP de red interna según los valores de VPCId y VSwitchId.	172.16.XX.XX
ResourceGroupId	string	No	El ID del grupo de recursos.	rg-acfmy****
Category	string	No	La edición de la instancia. Valores válidos: Basic: edición básica. HighAvailability: serie de alta disponibilidad (HA) (predeterminada). AlwaysOn: edición de clúster. Nota Las instancias de solo lectura de instancias de discos en la nube de PostgreSQL usan la edición básica. Debe establecer este parámetro en Basic.	HighAvailability
DBInstanceStorageType	string	No	El tipo de almacenamiento de la instancia. Valores válidos: local_ssd: Premium Local SSDs. cloud_ssd: SSD estándar. cloud_essd: ESSD PL1. cloud_essd2: ESSD PL2. cloud_essd3: ESSD PL3. general_essd: Premium ESSD. Nota Si la instancia principal de RDS MySQL usa Premium Local SSDs, solo se admite local_ssd. Si la instancia principal de RDS MySQL usa discos en la nube, se admiten los tipos de almacenamiento de discos de rendimiento premium. SQL Server admite los tipos de almacenamiento de discos de rendimiento premium.	local_ssd
DedicatedHostGroupId	string	No	El ID del clúster dedicado. Este parámetro es obligatorio cuando crea una instancia de solo lectura en un clúster dedicado.	dhg-4n****
TargetDedicatedHostIdForMaster	string	No	El ID del host de la instancia principal. Este parámetro es obligatorio cuando crea una instancia de solo lectura en un clúster dedicado.	i-bp****
GdnInstanceName	string	No	Es un parámetro reservado. No necesita especificar este parámetro.	test
TddlBizType	string	No	Es un parámetro reservado. No necesita especificar este parámetro.	test
TddlRegionConfig	string	No	Es un parámetro reservado. No necesita especificar este parámetro.	test
InstructionSetArch	string	No	Es un parámetro reservado. No necesita especificar este parámetro.	test
UsedTime	string	No	La duración de la suscripción. Valores válidos: Si Period se establece en Year, los valores válidos de UsedTime son de 1 a 5. Si Period se establece en Month, los valores válidos de UsedTime son de 1 a 9. Nota Este parámetro es obligatorio cuando PayType se establece en Prepaid.	1
Period	string	No	La unidad de la duración de la suscripción. Valores válidos: Year: año. Month: mes.	Month
AutoRenew	string	No	Especifica si se debe habilitar la renovación automática. Este parámetro es obligatorio solo para instancias de suscripción. Valores válidos: true: habilita la renovación automática. false: deshabilita la renovación automática. Nota Si compra la instancia mensualmente, el ciclo de renovación automática es de un mes. Si compra la instancia anualmente, el ciclo de renovación automática es de un año.	true
DeletionProtection	boolean	No	Especifica si se debe habilitar la función de protección contra liberación. Valores válidos: true: habilita la función. false: deshabilita la función (predeterminado). Nota Esta función solo se admite para las instancias que usan el método de facturación de pago por uso.	true
Port	string	No	El puerto que se inicializa cuando crea una instancia de solo lectura para una instancia principal RDS MySQL. Valores válidos: de 1000 a 65534.	3306
BurstingEnabled	boolean	No	Es un parámetro obsoleto. No necesita especificar este parámetro.	0
IsAnalyticReadOnlyIns	boolean	No	Especifica si se debe habilitar la función de ráfaga de E/S para un disco en la nube Premium ESSD. Valores válidos: true: habilita la función. false: deshabilita la función.	false
AutoPay	boolean	No	Especifica si se debe crear una instancia de análisis DuckDB. Valores válidos: true: crea una instancia de análisis DuckDB. false: no crea una instancia de análisis DuckDB. Nota Solo RDS MySQL y RDS PostgreSQL admiten instancias de análisis DuckDB.	false
AutoCreateProxy	boolean	No	Especifica si se debe habilitar el pago automático. Valores válidos: true: habilita el pago automático. Asegúrese de que el saldo de su cuenta sea suficiente. false: genera un pedido sin cargar a su cuenta. Nota Valor predeterminado: true. Si su método de pago tiene saldo insuficiente, establezca AutoPay en false. En este caso, se genera un pedido no pagado. Puede iniciar sesión en la consola de ApsaraDB RDS para completar el pago.	false
IoAccelerationEnabled	string	No	Especifica si se debe habilitar la creación automática de un proxy de base de datos. Valores válidos: true: habilita la creación automática. De forma predeterminada, se crea un proxy de base de datos de uso general. false: no habilita la creación automática.	false
AutoUseCoupon	boolean	No	Especifica si se debe habilitar la función Buffer Pool Extension (BPE) para un disco en la nube Premium ESSD. Valores válidos: 1: habilita la función. 0: no habilita la función.	0
PromotionCode	string	No	Especifica si se deben usar cupones. Valores válidos: true: usa cupones. false (predeterminado): no usa cupones.	true
CustomExtraInfo	string	No	El código de cupón.	71744626****
		No	Es un parámetro reservado. No necesita especificar este parámetro.	Ninguna

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Los parámetros de respuesta.
ConnectionString	string	La dirección de conexión interna de la base de datos de la instancia de solo lectura.	rr-****.mysql.rds.aliyuncs.com
DBInstanceId	string	El ID de la instancia de solo lectura.	rr-uf6wjk5****
OrderId	string	El ID del pedido.	10078937****
Port	string	El puerto de conexión interna de la base de datos de la instancia de solo lectura.	3306
RequestId	string	El ID de la solicitud.	1E43AAE0-BEE8-43DA-860D-EAF2AA0724DC

Ejemplos

Respuesta exitosa

JSON Formato

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

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error
400	InvalidEngineVersion.Malformed	The specified parameter EngineVersion is not valid.
400	InvalidNetworkTypeClassicWhenCloudStorage	The Specified InstanceNetworkType value Classic is not valid when choose cloud storage type.
400	InvalidSecurityIPList.Malformed	The specified parameter SecurityIPList is not valid.
400	InvalidSecurityIPList.Duplicate	The Security IP address is not in the available range or occupied.
400	InvalidParameter	The specified parameter dbInstanceId is not valid.
400	OperationDenied	VPC IP is in use, please check.
400	InvalidZoneId.NotSupported	The Specified vpc Zone not supported.
400	InvalidAvZone.NotSupport	Specified availableArea multiZone does not support in RDS.
400	CDDC.AvailableHostsNotEnoughInZone	Not enough available hosts are in the target zone.
400	InvalidReadEngineVersionPattern	The engine versions of the primary instance and the read-only instance do not match.
400	InvalidDBInstanceClass.Offline	The specified instance type is no longer provided. Please specify another instance type.
400	SYSTEM.CONCURRENT_OPERATE	Concurrent operation is detected.
400	Price.PricingPlanResultNotFound	Pricing plan price result not found.
400	InvalidDBInstanceName.Duplicate	Specified DB instance name already exists in the Aliyun RDS.
400	InvalidInstanceLevel.DiskType	Specified instance level not support request disk type
400	InvalidRequestId	The request is copy, check your token.
400	InvalidParam.InstanceNetworkType	Creation of classic network instances is not supported.
400	Order.ComboInstanceNotAllowOperate	A package instance is not allowed to operate independently.
400	Order.NoRealNameAuthentication	You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.
400	InsufficientAvailableQuota	Your account quota limit is less than 0, please recharge before trying to purchase.
400	CommodityServiceCalling.Exception	Failed to call commodity service.
400	RegionDissolvedEOM	Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.
400	Commodity.InvalidComponent	The module you purchased is not legal, please buy it again.
400	RegionEndTimeDissolvedAustralia	Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.
400	Price.CommoditySys	Commodity system call exception.
400	Pay.InsufficientBalance	Insufficient available balance.
400	Order.PeriodInvalid	There is a problem with the period you selected, please choose again.
400	pay.noCreditCard	Account not bound to credit card.
400	Order.InstHasUnpaidOrder	There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.
400	noAvailablePaymentMethod	No payment method is specified for your account. We recommend that you add a payment method.
400	BasicInfoUncompleted	Your information is incomplete. Complete your information before the operation.
400	Risk.RiskControlRejection	Your account is abnormal, please contact customer service for details.
400	Api.NotSupport	Specified api is not supported.
400	ContainForbiddenLabelError	There is a label that prohibits placing orders. Please contact your distributor for assistance.
400	InvalidDBInstanceId.NotFound	The DBInstanceId provided does not exist in records.
400	InvalidParam	Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.
400	KmsApiError	User secret key invalid.
400	System.SaleValidateFailed	Sales expression validation system error.
400	Abs.InvalidAccount.NotFound	account is not found.
400	SqlExecuteFailedOrTimeout	sql command execution failed or timed out:%s.
400	ColdData.EngineVersionNotSupport	The current instance engine version not support coldDataEnabled.
400	ColdData.MinorVersionNotSupport	The current instance minor version not support coldDataEnabled.
400	IncorrectTargetClasscode	The current instance type does not support this operation.
400	InvalidConnectionString.Duplicate	Specified connection string already exists in the RDS.
400	RequiredParam.NotFound	Required input param is not found.
400	Parameters.Invalid	Parameter error, please check the parameters.
400	BackupPolicyNotSupport	Cold Data won't open with CrossBackup or Flash Backup, please check Backup Policy.
400	InvalideStatus.Format	The instance status does not support this operation.
400	InvalidReleasedKeepPolicy.Format	Specified Released Keep Policy is not valid.
400	InvalidDBInstanceEngineType.Format	the DB instance engine type does not support this operation.
400	Pay.NoCreditCard	No credit cards.
400	VpcNetworkTypeNotSupport	The vpc network type instance does not support this operation.
400	MirrorInsExists	Specified DB instance mirror ins already existed.
400	UnsupportedClassCode	The specified DB instance class stops selling.
400	InvalidBackupSet	The specified database does not exist in the backup set.
400	OrdTCommodityQueryError	Failed to query for product.
400	ProductInstanceReleased	The instance has been released. Please check before placing the order.
400	RegionEndTimeDissolvedIndia	The region is no longer supported.
400	InvalidVSwitchId.Format	The specified vswitch Id format is incorrect.
400	InvalidParameterValue.NotStandard	Invalid parameter format.
400	AtLeastThreeVSwitchAvailableIp	The primary vswitch requires at least three available IP addresses.
400	AtLeastTwoVSwitchAvailableIp	The primary vswitch requires at least two available IP addresses.
400	DuckDBOperationConflictBetweenPrimaryAndReadOnlyInstance	Current instance is already attached to another duckdb instance, operation is conflict.
500	CannotDecreaseEssdPerfLevel	cannot decrease cloud essd performance level.
500	InvalidEssdStorageSize	invalid cloud essd storage size.
500	ExternalFailure	The request processing has failed due to external service failure.
500	RequestMetaDataFailed	The service request failed. Please try again later or contact service personnel.
500	InvokeProxyFailure	The request processing has failed due to service failure of rds api.
403	OperationDenied.PrimaryDBInstanceStatus	The operation is not permitted due to status of primary instance.
403	InvalidReadStorageTypePattern	The storage type of the primary instance and the read-only instance do not match.
403	IncorrectCharacterType	Current DB instance character type does not support this operation.
403	InvalidMultiparamZoneInfoList	Zoneinfo list is invaild.
403	OrderStatus.UnPaid	The specified db instance has unpaid order.
403	InvalidReduceDiskSize	The storage capacity after the scale-down must be larger than the used amount.
403	CloudSSDNotSupport	Cloud ssd does not support this operation, please upgrade to essd.
403	InvalidUserOperatorPermission	The user permission does not support this operation.
403	InvalidVswitchId	Specified conn vswitch id is not valid.
403	IncorrectMinorVersion	Current engine minor version does not support operations.
403	OperationDenied.ZoneResource	There is no available zone for inventory.
403	NotInFlowController	Sorry,no permission.
403	InvalidKmsKey	Kms key is disabled.
403	InvalidInstanceLevel.Malformed	Current DB instance level does not support this operation.
403	BasicCategoryNotSupport	The Basic category is not supported.
403	GuardDBInstanceNotSupport	Guard instance does not support this operation.
404	IncorrectDBInstanceConnType	Current DB instance conn type does not support this operation.
404	InvalidDBInstance.NotFound	The specified instance does not exist or is not supported.
404	InvalidClusterKms	The current instance does not authorized to access the Key Management Service.
404	Request.NotFound	The requested resource is not available.
404	HostInfo.NotFound	The specified host info is not found.

Consulte Códigos de error para ver la lista completa.

Notas de la versión

Consulte Notas de la versión para ver la lista completa.