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

Crea el endpoint que se utiliza para conectarse al proxy dedicado de una instancia.

Descripción de la operación

Motores de base de datos compatibles

MySQL
PostgreSQL

Referencias

Nota

Antes de llamar a esta operación, lea detenidamente la siguiente documentación. Asegúrese de comprender completamente los requisitos previos y los impactos de llamar a esta operación.

Configurar el endpoint del proxy dedicado de una instancia de ApsaraDB RDS for MySQL
Configurar el endpoint del proxy dedicado de una instancia de ApsaraDB RDS for PostgreSQL

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:CreateDBProxyEndpointAddress

create

*DBInstance

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

rds:DBProxyConnectStringNetType

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
RegionId	string	No	El ID de la región. Puede llamar a la operación DescribeRegions para consultar la lista de regiones más reciente.	cn-hangzhou
DBInstanceId	string	Sí	El ID de la instancia. Puede llamar a la operación DescribeDBInstances para consultar el ID de la instancia.	rm-t4n3****
DBInstanceId	string	Sí	El ID de la instancia. Puede llamar a la operación DescribeDBInstances para consultar el ID de la instancia.	rm-t4n3****
DBProxyEndpointId	string	Sí	El ID del endpoint del proxy. Puede llamar a la operación DescribeDBProxyEndpoint para consultar el ID del endpoint del proxy.	ta9um4****
ConnectionStringPrefix	string	Sí	El prefijo del endpoint del proxy. Introduzca un prefijo personalizado.	test1234
DBProxyNewConnectStringPort	string	No	El número de puerto asociado con el endpoint del proxy. Si la instancia ejecuta MySQL, el valor predeterminado es 3306. Si la instancia ejecuta PostgreSQL, el valor predeterminado es 5432.	3306
DBProxyConnectStringNetType	string	Sí	El tipo de red del endpoint del proxy. Valores válidos: Public: Internet VPC: Virtual Private Cloud (VPC) Classic: red clásica Valor predeterminado: Classic	Public
VPCId	string	No	El ID de la VPC a la que pertenece el endpoint del proxy. Puede llamar a la operación DescribeDBInstanceAttribute para consultar la información. Nota Este parámetro debe especificarse cuando DBProxyConnectStringNetType se establece en VPC.	vpc-bp****
VSwitchId	string	No	El ID del vSwitch asociado con la VPC especificada. Puede llamar a la operación DescribeDBInstanceAttribute para consultar el ID del vSwitch. Nota Este parámetro debe especificarse cuando DBProxyConnectStringNetType se establece en VPC.	vsw-bp****
DBProxyEngineType	string	No	Un parámetro reservado. No necesita especificar este parámetro.	normal
ResourceGroupId	string	No	El ID del grupo de recursos.	rg-acfmy****

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Los parámetros de respuesta.
RequestId	string	El ID de la solicitud.	F2911788-25E8-42E5-A3A3-1B38D263F01E

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "F2911788-25E8-42E5-A3A3-1B38D263F01E"
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error	Descripción
400	InvalidPort.Malformed	Specified port is not valid.	The port number is invalid.
400	NetTypeExists	Specified net type already existed.
400	IncorrectDBInstanceNetType	Current DB instance net type does not support this operation.	The operation failed. The operation is not supported for the network type of the RDS instance.
400	InvalidConnectionString.Duplicate	Specified connection string already exists in the Aliyun RDS.
400	InvalidConnVPCId	Specified conn vpc id is not valid.
400	InvalidVpcInstanceId	Specified vpc instance id is not valid.	The specified VPC ID is invalid.
400	InvalidDBInstanceName	Specified parameter DBInstanceName is not valid.	The value of the DBInstanceName parameter is invalid. Check that the value of this parameter is not null or an empty string.
400	InvalidVpcIdOrVswitchId.NotSupported	The specified vpcId or vSwitchId is not supported.	The VPC that is specified by the vpcId parameter or the vSwitch that is specified by the vSwitchId parameter is not supported. Check the values of these parameters.
400	InvalidPrivateIpAddress.Mismatch	Specified private IP address is not in the CIDR block of virtual switch.	The VPC endpoint is invalid.
400	InvalidVpcParameter	Specified VPCId VSwitchId or IPAddress or TunnelId is not valid.	The values of the VPCId parameter and the VSwitchId parameter are invalid. Check the values of these parameters.
400	InvalidBizType.Format	Specified biz type is not valid.
400	InvalidVSwitchId.NotFound	Specified vSwitch is not found in specified VPC.	No vSwitch is found in the VPC.
400	InvalidVSwitchId.Mismatch	Specified instance and virtual switch are not in the same zone.	The RDS instance and the vSwitch are not in the same zone.
400	InvalidPrivateIpAddress.AlreadyUsed	The specified IP is already used.	The IP address has been used.
400	VswitchIpExhausted	No available ip in the specified vswitch.	No available IP address exists in the specified vSwitch.
400	MaxscaleNotSupport	Current custins can not support Maxscale.	This operation is not supported for instances with maxscale.
400	InvalidConnectionString.Format	Specified connection string is not valid.	The endpoint of the RDS instance is invalid. The prefix of the endpoint must be 5 to 40 characters in length.
400	Order.ComboInstanceNotAllowOperate	A package instance is not allowed to operate independently.	A package instance is not allowed to operate independently.
400	Price.PricingPlanResultNotFound	Pricing plan price result not found.	Pricing plan price result not found.
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.	You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.
400	InsufficientAvailableQuota	Your account quota limit is less than 0, please recharge before trying to purchase.	Your account available limit is less than 0, please recharge before trying to purchase.
400	CommodityServiceCalling.Exception	Failed to call commodity service.	Failed to call commodity service return.
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.	Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, 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.	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.	Hello customer, this area has been abolished.
400	Price.CommoditySys	Commodity system call exception.	Commodity system call exception.
400	Pay.InsufficientBalance	Insufficient available balance.	Insufficient available balance.
400	Order.PeriodInvalid	There is a problem with the period you selected, please choose again.	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.	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.	No payment method has been specified for your account. We recommend that you add a payment method.
400	BasicInfoUncompleted	Your information is incomplete. Complete your information before the operation.	Your basic information is not complete, please complete your basic information before operation.
400	Risk.RiskControlRejection	Your account is abnormal, please contact customer service for details.	Your account is abnormal, please contact customer service for details.
400	Api.NotSupport	Specified api is not supported.	The current interface does not support.
400	ContainForbiddenLabelError	There is a label that prohibits placing orders. Please contact your distributor for assistance.	You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.
400	InvalidDBInstanceId.NotFound	The DBInstanceId provided does not exist in records.	The DBInstanceId provided does not exist.
400	InvalidInstanceLevel.DiskType	Specified instance level not support request disk type	The current instance type does not support the specified storage type.
400	InvalidParam	Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.	The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.
400	KmsApiError	User secret key invalid.	The user key is invalid.
400	System.SaleValidateFailed	Sales expression validation system error.	A system error occurs when the sales expression is verified.
400	Abs.InvalidAccount.NotFound	account is not found.	The account does not exist.
400	SqlExecuteFailedOrTimeout	sql command execution failed or timed out:%s.	SQL command execution failed or timed out
400	ColdData.EngineVersionNotSupport	The current instance engine version not support coldDataEnabled.	The current instance engine version not support coldDataEnabled.
400	ColdData.MinorVersionNotSupport	The current instance minor version not support coldDataEnabled.	The current instance minor version not support coldDataEnabled.
400	IncorrectTargetClasscode	The current instance type does not support this operation.	This operation is not supported by the instance type.
400	RequiredParam.NotFound	Required input param is not found.
400	Parameters.Invalid	Parameter error, please check the parameters.	Parameter error, please check the parameters.
400	BackupPolicyNotSupport	Cold Data won't open with CrossBackup or Flash Backup, please check Backup Policy.	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.	Specified Released Keep Policy is not valid.
400	InvalidDBInstanceEngineType.Format	the DB instance engine type does not support this operation.	This operation is not supported for the database engine of the instance.
400	Pay.NoCreditCard	No credit cards.	No credit cards.
400	VpcNetworkTypeNotSupport	The vpc network type instance does not support this operation.	The vpc network type instance does not support this operation.
400	MirrorInsExists	Specified DB instance mirror ins already existed.	Specified DB instance mirror ins already existed.
400	UnsupportedClassCode	The specified DB instance class stops selling.	The specified DB instance class stops selling.
400	InvalidBackupSet	The specified database does not exist in the backup set.	The specified database does not exist in the backup set.
400	OrdTCommodityQueryError	Failed to query for product.	Failed to query product.
400	ProductInstanceReleased	The instance has been released. Please check before placing the order.	The instance has been released, please verify and place an order.
400	RegionEndTimeDissolvedIndia	The region is no longer supported.	The region is no longer supported.
400	APICallingFailed	Api calling failed.	An internal error occurred.
400	InvalidVSwitchId.Format	The specified vswitch Id format is incorrect.
400	InvalidDBProxyConnectStringNetType.NotSupported	The Specified DBProxyConnectStringNetType is not supported.	The specified DBProxyConnectStringNetType value is not supported.
500	ExternalFailure	The request processing has failed due to external service failure.	The request processing has failed due to external service failure.
500	RequestMetaDataFailed	The service request failed. Please try again later or contact service personnel.	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.	The request failed to be processed due to an RDS API failure.
403	IncorrectDBInstanceType	Current DB instance type does not support this operation.	The operation failed. The RDS instance is not in a ready state.
403	IncorrectDBInstanceState	Current DB instance state does not support this operation.
403	IncorrectDBInstanceEngine	Current DB Instance engine does not support this operation.	The operation failed. The operation is not supported for the database engine that is run on the RDS instance.
403	IncorrectKindCode	Current custins kindCode does not support this operation.	The operation failed. The operation is not supported for the database engine that is run on the RDS instance.
403	IncorrectDBInstanceConnType	Current DB instance conn type does not support this operation.	The operation is not supported for the connection type of the RDS instance.
403	OrderStatus.UnPaid	The specified db instance has unpaid order.	The instance has an unpaid order. Please pay first and try again.
403	InvalidReduceDiskSize	The storage capacity after the scale-down must be larger than the used amount.	The scale-in target capacity cannot be less than the current storage space usage
403	CloudSSDNotSupport	Cloud ssd does not support this operation, please upgrade to essd.
403	InvalidUserOperatorPermission	The user permission does not support this operation.	The user is not authorized to perform this operation.
403	InvalidVswitchId	Specified conn vswitch id is not valid.
403	IncorrectMinorVersion	Current engine minor version does not support operations.	This operation is not supported for the current minor engine version.
403	OperationDenied.ZoneResource	There is no available zone for inventory.	There is no available zone for inventory.
403	NotInFlowController	Sorry,no permission.	Sorry,no permission.
403	InvalidKmsKey	Kms key is disabled.
403	InvalidInstanceLevel.Malformed	Current DB instance level does not support this operation.	The specified database instance type does not support this operation.
404	Endpoint.NotFound	Specified endpoint is not found.	The port that is associated with the dedicated proxy endpoint cannot be found.
404	Maxscale.NotFound	The related maxscale instance is not found.	The operation failed. No associated MaxScale instances can be found.
404	IncorrectVswitchId	The specified parameter VSwitchId is not valid.	The vSwitch ID is invalid.
404	InvalidDBInstanceName.NotFound	Invalid DBInstanceId NotFound.	The instance ID cannot be found.
404	InvalidDBInstance.NotFound	Specified instance does not exist or not support.	The RDS instance cannot be found, is deleted, or does not support the operation.
404	InsufficientResourceCapacity	Current cluster resources are insufficient. Try again later.	Current cluster resources are insufficient. Try again later.
404	InvalidClusterKms	The current instance does not authorized to access the Key Management Service.	The instance does not have permissions to access Key Management Service (KMS).
404	Request.NotFound	The requested resource is not available.	The requested resources are unavailable.
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.