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

Solicita un endpoint público para una instancia de ApsaraDB RDS.

Descripción de la operación

Motores compatibles

RDS MySQL
RDS PostgreSQL
RDS SQL Server
RDS MariaDB

Documentación relacionada

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

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

update

*DBInstance.

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

rds:ResourceTag
rds:ResourceTag
rds:ResourceTag

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
DBInstanceId	string	Sí	El ID de la instancia. Puede llamar a DescribeDBInstances para obtener el ID de la instancia.	rm-uf6wjk5****
ConnectionStringPrefix	string	Sí	El prefijo del endpoint público. El endpoint público completo tiene el formato `prefijo.motor.rds.aliyuncs.com`. Ejemplo: `test1234.mysql.rds.aliyuncs.com`. Nota El prefijo debe tener entre 5 y 40 caracteres de longitud y no puede contener caracteres chinos ni caracteres especiales (~!#%^&*=+\|{};:'",<>/?). El prefijo puede contener letras, dígitos y guiones (-).	test1234
Port	string	Sí	El puerto público. Valores válidos: 1000 a 5999.	3306
BabelfishPort	string	No	El número de puerto TDS de Babelfish para RDS PostgreSQL. Nota Este parámetro solo es aplicable a instancias de ApsaraDB RDS for PostgreSQL. Para obtener más información sobre Babelfish para RDS PostgreSQL, consulte Introducción a Babelfish.	1433
GeneralGroupName	string	No	El nombre del grupo de clúster dedicado al que pertenece la instancia de ApsaraDB RDS for MySQL de uso general.	rgc-bp1tkv8****
PGBouncerPort	string	No	El puerto de PgBouncer.	6432

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Los parámetros de respuesta.
ConnectionString	string	El endpoint de la base de datos.	test****.mysql.rds.aliyuncs.com
DbInstanceName	string	El ID de la instancia.	rm-bp1****
RequestId	string	El ID de la solicitud.	65BDA532-28AF-4122-AA39-B382721EEE64

Ejemplos

Respuesta exitosa

JSON Formato

{
  "ConnectionString": "test****.mysql.rds.aliyuncs.com",
  "DbInstanceName": "rm-bp1****",
  "RequestId": "65BDA532-28AF-4122-AA39-B382721EEE64"
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error
400	OtherEndpoint.Exist	Other endpoint exist.
400	IncorrectDBInstanceState	The current instance state does not support this operation.
400	ConnectionStringContainIllegalCharacterFault	The connection string contain Illegal character.
400	InvalidInstanceNetworkType	The specified InstanceNetworkType is invalid.
400	InvalidConnectionString.Format	Specified connection string is not valid.
400	InvalidPort.Malformed	Specified port is not valid.
400	InvalidVpcIdRegion.NotSupported	The specified region does not allow you to create a VPC instance.
400	InvalidInstanceNetworkType.ValueNotSupported	The specified parameter "InstanceNetworkType" is not valid.
400	InvalidBizType.Format	Specified biz type is not valid.
400	EndpointNum.Error	The number of endpoint is too many.
400	EndpointType.NotSupport	Current db type is not support specified endpoint type.
400	Order.ComboInstanceNotAllowOperate	A package instance is not allowed to operate independently.
400	Price.PricingPlanResultNotFound	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.
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	InvalidInstanceLevel.DiskType	Specified instance level not support request disk type
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	NetworkConnectionCreating	The existing network connection is already being created, please do not create it repeatedly.
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	Invalid.DbInstanceNetType	The specified parameter DbInstanceNetType is not valid.
403	OperationDenied.SwitchToVPC	Specified instance cannot be switched to VPC.
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	UnsupportedByBlueGreenDeployment	Operation prohibited due to blue green deployment.
403	GuardDBInstanceNotSupport	Guard instance does not support this operation.
404	InvalidConnectionString.Duplicate	Specified connection string already exists in the Aliyun RDS.
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.