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

Esta API obtiene el endpoint de proxy de base de datos para 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

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

get

*DBInstance.

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

rds:ResourceTag
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 la operación DescribeDBInstances para consultar los ID de las instancias.	rm-bp1ja4f56s7us****
DBProxyEndpointId	string	No	El ID del endpoint del proxy. Puede llamar a la operación DescribeDBProxy para consultar este ID.	keaxncrjluwu0gue****
DBProxyConnectString	string	No	La cadena de conexión del proxy. Puede llamar a la operación DescribeDBProxy para consultar esta cadena de conexión.	testproxy****.rwlb.rds.aliyuncs.com
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 los ID de las instancias.	rm-bp1ja4f56s7us****
DBProxyEngineType	string	No	Este parámetro está reservado y no es necesario especificarlo.	normal

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Los parámetros de respuesta.
DBProxyConnectString	string	La cadena de conexión del proxy.	testproxy****.rwlb.rds.aliyuncs.com
DBProxyConnectStringNetType	string	El tipo de red de la cadena de conexión del proxy. Valores válidos: InnerString: Dirección interna. OuterString: Dirección pública.	InnerString
DBProxyConnectStringPort	string	El puerto de la cadena de conexión del proxy.	3306
DBProxyEndpointId	string	El ID del endpoint del proxy.	keaxncrjluwu0gue****
DBProxyEngineType	string	Un parámetro reservado. Puede ignorar este parámetro.	normal
DBProxyFeatures	string	La configuración de funciones del endpoint del proxy. El valor es una cadena de pares clave-valor separados por punto y coma. La cadena contiene las siguientes claves: TransactionReadSqlRouteOptimizeStatus: Especifica si se debe habilitar la división de transacciones. Valores válidos: 0 (deshabilitado) y 1 (habilitado). ConnectionPersist: Especifica el tipo de pool de conexiones. Valores válidos: 0 (deshabilitado), 1 (pool de conexiones a nivel de sesión) y 2 (pool de conexiones a nivel de transacción). ReadWriteSpliting: Especifica si se debe habilitar la división de lectura/escritura. Valores válidos: 0 (deshabilitado) y 1 (habilitado). AZProximityAccess: La función de acceso cercano. Valores válidos: 0 (deshabilitado) y 1 (habilitado). CausalConsistRead: Especifica el nivel de consistencia de lectura. Valores válidos: 0 (consistencia eventual), 1 (consistencia de sesión) y 2 (consistencia global). HtapFilter: El enrutamiento automático de solicitudes HTAP. Valores válidos: 0 (deshabilitado) y 1 (habilitado). PinPreparedStmt: un parámetro interno reservado que solo es visible para instancias de ApsaraDB RDS for PostgreSQL. Nota Para instancias de ApsaraDB RDS for PostgreSQL, solo puede modificar la configuración de ReadWriteSpliting. Las claves TransactionReadSqlRouteOptimizeStatus y PinPreparedStmt están configuradas permanentemente en 1.	TransactionReadSqlRouteOptimizeStatus:1;ConnectionPersist:0;ReadWriteSpliting:1
DBProxyNodes	object
DBProxyNodes	array<object>	Los nodos de proxy asociados con el endpoint del proxy.
	object	Las propiedades de un nodo de proxy.
cpuCores	string	El número de núcleos de CPU en el nodo de proxy.	2
nodeId	string	El ID del nodo de proxy.	pn-xxxxxxx01
zoneId	string	El ID de la zona de disponibilidad donde se encuentra el nodo de proxy.	cn-hangzhou-c
DbProxyEndpointAliases	string	El alias del endpoint del proxy.	proxyterminal-test
DbProxyEndpointReadWriteMode	string	El modo de lectura/escritura del endpoint del proxy. Valores válidos: ReadWrite: modo de lectura/escritura. ReadOnly: modo de solo lectura.	ReadWrite
DbProxyEndpointVswitchId	string	El ID del VSwitch del endpoint del proxy.	vsw-****
DbProxyEndpointVpcId	string	El ID de la VPC del endpoint del proxy.	vpc-****
DbProxyEndpointZoneId	string	El ID de la zona de disponibilidad donde se crea el endpoint del proxy.	cn-hangzhou-c
EndpointConnectItems	object
EndpointConnectItems	array<object>	Una lista de detalles sobre las cadenas de conexión del proxy.
	object	Los detalles de una cadena de conexión del proxy.
DbProxyEndpointConnectString	string	La cadena de conexión del proxy.	testproxy****.rwlb.rds.aliyuncs.com
DbProxyEndpointNetType	string	El tipo de red. Valores válidos: 0: Red pública 1: Red clásica 2: VPC	2
DbProxyEndpointPort	string	El puerto de servicio. El valor predeterminado es 3306.	3306
ReadOnlyInstanceDistributionType	string	El modo de distribución de pesos de lectura. Para obtener más información, consulte Asignación de pesos de lectura. Valores válidos: Standard: El sistema asigna automáticamente pesos de lectura a las instancias según sus especificaciones. Custom: Usted especifica pesos de lectura personalizados para las instancias.	Standard
ReadOnlyInstanceMaxDelayTime	string	El umbral de latencia para la división de lectura/escritura. Si la latencia de replicación en una instancia de solo lectura supera este umbral, las solicitudes de lectura no se enrutan a dicha instancia. Unidad: segundos.	30
CausalConsistReadTimeout	string	El tiempo de espera para una lectura consistente, en milisegundos. Valores válidos: de 0 a 60000. Valor predeterminado: 10.	10
ReadOnlyInstanceWeight	string	La distribución de pesos de lectura. El valor es una cadena JSON que especifica los pesos de lectura de las instancias principales y de solo lectura. Contiene los siguientes campos: DBInstanceId: El ID de la instancia. DBInstanceType: El tipo de instancia. Valores válidos: Master (instancia principal) y ReadOnly (instancia de solo lectura). NodeID: El ID del nodo principal o secundario de la instancia principal si la instancia ejecuta RDS Cluster Edition. NodeType: El tipo de nodo de una instancia que ejecuta RDS Cluster Edition. Valores válidos: Primary (nodo principal) y Secondary (nodo secundario). Weight: El peso de lectura de la instancia. El valor aumenta en incrementos de 100, con un valor máximo de 10000.	[{\"Availability\":\"Available\",\"DBInstanceId\":\"rm-2z**\"，\"DBInstanceType\":\"Master\",\"NodeId\":\"rn-t2\",\"NodeType\":\"Primary\",\"Weight\":0}, {\"Availability\":\"Available\",\"DBInstanceId\":\"rm-2z\"，\"DBInstanceType\":\"Master\",\"NodeId\":\"rn-z9\",\"NodeType\":\"Secondary\",\"Weight\":400}, {\"Availability\":\"Available\",,\"DBInstanceId\":\"rm-2z\"，\"DBInstanceType\":\"Master\",\"NodeId\":\"rn-1c**\",\"NodeType\":\"Secondary\",\"Weight\":400}]]
RequestId	string	El ID de la solicitud.	847BA085-B377-4BFA-8267-F82345ECE1D2
DBProxyEndpointCostThresholdForDuckdb	string
DBProxyEndpointMinSlaveCount	string	El número mínimo de instancias de solo lectura que se deben conservar.	2

Ejemplos

Respuesta exitosa

JSON Formato

{
  "DBProxyConnectString": "testproxy****.rwlb.rds.aliyuncs.com",
  "DBProxyConnectStringNetType": "InnerString",
  "DBProxyConnectStringPort": "3306",
  "DBProxyEndpointId": "keaxncrjluwu0gue****",
  "DBProxyEngineType": "normal",
  "DBProxyFeatures": "TransactionReadSqlRouteOptimizeStatus:1;ConnectionPersist:0;ReadWriteSpliting:1",
  "DBProxyNodes": {
    "DBProxyNodes": [
      {
        "cpuCores": "2",
        "nodeId": "pn-xxxxxxx01",
        "zoneId": "cn-hangzhou-c"
      }
    ]
  },
  "DbProxyEndpointAliases": "proxyterminal-test",
  "DbProxyEndpointReadWriteMode": "ReadWrite",
  "DbProxyEndpointVswitchId": "vsw-****",
  "DbProxyEndpointVpcId": "vpc-****",
  "DbProxyEndpointZoneId": "cn-hangzhou-c",
  "EndpointConnectItems": {
    "EndpointConnectItems": [
      {
        "DbProxyEndpointConnectString": "testproxy****.rwlb.rds.aliyuncs.com",
        "DbProxyEndpointNetType": "2",
        "DbProxyEndpointPort": "3306"
      }
    ]
  },
  "ReadOnlyInstanceDistributionType": "Standard",
  "ReadOnlyInstanceMaxDelayTime": "30",
  "CausalConsistReadTimeout": "10",
  "ReadOnlyInstanceWeight": "[{\\\"Availability\\\":\\\"Available\\\",\\\"DBInstanceId\\\":\\\"rm-2z****\\\"，\\\"DBInstanceType\\\":\\\"Master\\\",\\\"NodeId\\\":\\\"rn-t2****\\\",\\\"NodeType\\\":\\\"Primary\\\",\\\"Weight\\\":0}, {\\\"Availability\\\":\\\"Available\\\",\\\"DBInstanceId\\\":\\\"rm-2z****\\\"，\\\"DBInstanceType\\\":\\\"Master\\\",\\\"NodeId\\\":\\\"rn-z9****\\\",\\\"NodeType\\\":\\\"Secondary\\\",\\\"Weight\\\":400}, {\\\"Availability\\\":\\\"Available\\\",,\\\"DBInstanceId\\\":\\\"rm-2z****\\\"，\\\"DBInstanceType\\\":\\\"Master\\\",\\\"NodeId\\\":\\\"rn-1c****\\\",\\\"NodeType\\\":\\\"Secondary\\\",\\\"Weight\\\":400}]]",
  "RequestId": "847BA085-B377-4BFA-8267-F82345ECE1D2",
  "DBProxyEndpointCostThresholdForDuckdb": "",
  "DBProxyEndpointMinSlaveCount": "2"
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error
400	MaxscaleNotSupport	Current custins can not support Maxscale.
400	InvalidEndPoint.Format	The specified EndPoint is not valid.
400	InvalidDBInstanceName	Specified parameter DBInstanceName is not valid.
400	Endpoint.NotFound	The specified EndPoint is not valid.
400	InvalidParameter	The specified parameter is invalid.
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.
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	IncorrectKindCode	The current KindCode of the custins does not support the operation.
403	IncorrectDBInstanceType	The current database instance type does not support the operation.
403	IncorrectDBInstanceEngine	Current DB Instance engine does not support this operation.
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	InvalidVpcInfo.NotFound	Specified VPC info does not exist.
404	Endpoint.NotFound	Specified endpoint is not found.
404	Maxscale.NotFound	The relative maxscale instance is not found.
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.