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

Esta API se utiliza para consultar la configuración de PolarProxy de una instancia de RDS.

Descripción de la operación

Motores compatibles

RDS MySQL
RDS 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

No se requiere autorización para esta operación. Si experimenta problemas al ejecutarla, póngase en contacto con el soporte técnico.

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
DBInstanceId	string	Sí	El ID de la instancia. Puede llamar a la operación DescribeDBInstances para consultar el ID de la instancia.	rm-bp1ja4f56s7us****
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-bp1ja4f56s7us****
DBProxyEngineType	string	No	Un parámetro obsoleto. 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.
DBProxyInstanceMinorVersions	object
DBProxyInstanceMinorVersions	array	La colección de versiones menores a las que se puede actualizar la instancia de proxy.	2.25.9
	string	Versiones actualizables para el proxy.	2.25.9_20251028
DBProxyConnectStringItems	object
DBProxyConnectStringItems	array<object>	Una matriz que consiste en la información sobre el endpoint de proxy de base de datos creado para la instancia.
	object	El endpoint de proxy creado para la instancia.
DBProxyConnectString	string	The database proxy endpoint.	gos787jog2wk0ye1****-rw4rm.rwlb.rds.aliyuncs.com
DBProxyConnectStringNetType	string	El tipo de red del endpoint de proxy de base de datos. Anteriormente, un endpoint de proxy de base de datos se denominaba terminal de proxy. Valores válidos: OuterString: Internet InnerString: red interna	InnerString
DBProxyConnectStringNetWorkType	string	El tipo de red del proxy de base de datos. Valores válidos: 0: Internet 1: red clásica 2: nube privada virtual (VPC)	2
DBProxyConnectStringPort	string	El puerto asociado al endpoint de proxy de base de datos.	3306
DBProxyEndpointId	string	El ID del endpoint de proxy de base de datos backend.	20****
DBProxyEndpointName	string	El nombre del endpoint de proxy de base de datos. El nombre se puede reemplazar por el ID del endpoint de proxy de base de datos.	gos787jog2wk0ye1****
DBProxyVpcId	string	La VPC del proxy de base de datos.	vpc-uf6oobt****
DBProxyVpcInstanceId	string	El ID de la instancia de proxy de base de datos.	rm-bp145737x5**131161274792**
DBProxyVswitchId	string	El vSwitch del proxy de base de datos.	vsw-uf6l0pic17****
DBProxyEngineType	string	Un parámetro interno. Puede ignorar este parámetro.	normal
DBProxyInstanceCurrentMinorVersion	string	La versión de la instancia de proxy.	1.13.11
DBProxyInstanceLatestMinorVersion	string	La última versión disponible para la instancia de proxy.	1.13.12
DBProxyInstanceName	string	El nombre de la instancia de proxy.	gos787jog2wk0ye1****
DBProxyInstanceNum	integer	El número de proxies habilitados en la instancia.	1
DBProxyInstanceSize	string	Este parámetro solo está disponible para instancias de ApsaraDB RDS for PostgreSQL. Las especificaciones de la instancia de proxy habilitada. Formato: `Número de núcleos/Capacidad de memoria`. Por ejemplo, un valor de 4/8 indica que la instancia de proxy tiene 4 núcleos y 8 GB de memoria.	4/8
DBProxyInstanceStatus	string	El estado de la instancia de proxy. DBInstanceClassChanging: Se están cambiando las especificaciones de la instancia de proxy. Creating: Se está creando la instancia de proxy. Running: La instancia de proxy se está ejecutando. Deleting: Se está eliminando la instancia de proxy.	Running
DBProxyInstanceType	string	El tipo de proxy de base de datos habilitado en la instancia. Valores válidos: 1: proxy de base de datos compartido 2: proxy de base de datos dedicado 3: proxy de base de datos de uso general Nota ApsaraDB RDS for PostgreSQL no admite proxies de base de datos compartidos.	2
DBProxyKindCode	string	Un parámetro interno. No necesita especificar este parámetro.	18
DBProxyNodes	object
DBProxyNodes	array<object>	Los nodos de proxy.
	object	Detalles de la lista de nodos.
cpuCores	string	El número de núcleos de CPU del nodo.	2
nodeId	string	El ID del nodo de proxy.	pn-xxxxxxx01
zoneId	string	El ID de la zona en la que se despliega el nodo.	cn-hangzhou-c
DBProxyPersistentConnectionStatus	string	El estado de las conexiones persistentes. Valores válidos: Enabled Disabled Unsupported	Disabled
DBProxyServiceStatus	string	El estado del proxy de base de datos. Shutdown: deshabilitado Startup: habilitado	Startup
DbProxyEndpointItems	object
DbProxyEndpointItems	array<object>	Los terminales de proxy de la instancia.
	object	La información sobre el terminal de proxy.
DbProxyEndpointAliases	string	La descripción del endpoint de proxy de base de datos.	proxy-test
DbProxyEndpointName	string	El ID del endpoint de proxy de base de datos.	gos787jog2wk0ye1****
DbProxyEndpointType	string	El tipo de endpoint de proxy de base de datos. Valores válidos: Custom: endpoint de proxy de base de datos personalizado RWSplit: endpoint de proxy de base de datos predeterminado	RWSplit
DbProxyReadWriteMode	string	Los atributos de lectura y escritura del endpoint de proxy de base de datos. ReadOnly ReadWrite	ReadWrite
RequestId	string	El ID de la solicitud.	909A69EE-71C8-4417-A0B9-FF085407E1E3
ResourceGroupId	string	El ID del grupo de recursos.	rg-acfmy****
DBProxyAVZones	object
DBProxyAVZones	array	La lista de zonas disponibles para el proxy de base de datos.
	string	La zona disponible para el proxy de base de datos.	cn-shanghai-e

Ejemplos

Respuesta exitosa

JSON Formato

{
  "DBProxyInstanceMinorVersions": {
    "DBProxyInstanceMinorVersions": [
      "2.25.9_20251028"
    ]
  },
  "DBProxyConnectStringItems": {
    "DBProxyConnectStringItems": [
      {
        "DBProxyConnectString": "gos787jog2wk0ye1****-rw4rm.rwlb.rds.aliyuncs.com",
        "DBProxyConnectStringNetType": "InnerString",
        "DBProxyConnectStringNetWorkType": "2",
        "DBProxyConnectStringPort": "3306",
        "DBProxyEndpointId": "20****",
        "DBProxyEndpointName": "gos787jog2wk0ye1****",
        "DBProxyVpcId": "vpc-uf6oobt****",
        "DBProxyVpcInstanceId": "rm-bp145737x5****131161274792****",
        "DBProxyVswitchId": "vsw-uf6l0pic17****"
      }
    ]
  },
  "DBProxyEngineType": "normal",
  "DBProxyInstanceCurrentMinorVersion": "1.13.11",
  "DBProxyInstanceLatestMinorVersion": "1.13.12",
  "DBProxyInstanceName": "gos787jog2wk0ye1****",
  "DBProxyInstanceNum": 1,
  "DBProxyInstanceSize": "4/8",
  "DBProxyInstanceStatus": "Running",
  "DBProxyInstanceType": "2",
  "DBProxyKindCode": "18",
  "DBProxyNodes": {
    "DBProxyNodes": [
      {
        "cpuCores": "2",
        "nodeId": "pn-xxxxxxx01",
        "zoneId": "cn-hangzhou-c"
      }
    ]
  },
  "DBProxyPersistentConnectionStatus": "Disabled",
  "DBProxyServiceStatus": "Startup",
  "DbProxyEndpointItems": {
    "DbProxyEndpointItems": [
      {
        "DbProxyEndpointAliases": "proxy-test",
        "DbProxyEndpointName": "gos787jog2wk0ye1****",
        "DbProxyEndpointType": "RWSplit",
        "DbProxyReadWriteMode": "ReadWrite"
      }
    ]
  },
  "RequestId": "909A69EE-71C8-4417-A0B9-FF085407E1E3",
  "ResourceGroupId": "rg-acfmy****",
  "DBProxyAVZones": {
    "DBProxyAVZones": [
      "cn-shanghai-e"
    ]
  }
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error	Descripción
400	RWSplitNetTypeNotExists	Specified rw split net type is not eixsts.
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	InvalidInstanceLevelExtraInfo	Specified class code has error extra info.
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	InvalidConnectionString.Duplicate	Specified connection string already exists in the RDS.	The link address name is duplicate. Please reset the connection string.
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.
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	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	IncorrectDBInstanceType	The database instance type does not support the operation.	The operation failed. The operation is not supported for the database engine of the RDS instance.
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	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	InvalidDBInstanceName.NotFound	The database instance does not exist.	The name of the RDS instance cannot be found. Check the name of the RDS instance.
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.