DescribeDBProxyEndpoint_云数据库 RDS_API文档-阿里云OpenAPI开发者门户

接口说明

适用引擎

RDS MySQL
RDS PostgreSQL

流控信息

请求速率为10/1(s)。更多流控信息，请前往配额中心查看

授权信息

如下是此API对应的授权信息，用于RAM权限策略语句的Action元素中，为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置，使用方法可参考访问控制帮助文档。

具体说明如下：展开详情

操作	访问级别	资源类型	条件关键字	关联操作

rds:DescribeDBProxyEndpoint	Get	DBInstance acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	rds:ResourceTag rds:ResourceTag rds:ResourceTag rds:ResourceTag	无

请求参数

字段名称	字段详情
DBInstanceIdstring	实例 ID。可调用 DescribeDBInstances 获取。示例值:rm-bp1ja4f56s7us****参考取值来源: CloneDBInstance CreateDBInstance ReceiveDBInstance ModifyDBInstanceSpec RecoveryDBInstance DescribeDBInstances CalculateDBInstanceWeight MigrateDBNodes UpgradeDBInstanceMajorVersion TransformDBInstancePayType EvaluateLocalExtendDisk RestoreDdrTable RebuildReplicationLink
DBProxyEndpointIdstring	代理终端名称。可调用 DescribeDBProxy 接口查询。示例值:keaxncrjluwu0gue****参考取值来源: CreateDBProxyEndpointAddress DescribeDBProxy
DBProxyConnectStringstring	代理连接地址。可调用 DescribeDBProxy 接口查询。示例值:testproxy****.rwlb.rds.aliyuncs.com参考取值来源: CreateDBProxyEndpointAddress DescribeDBProxy
RegionIdstring	地域 ID。可调用 DescribeRegions 获取。示例值:cn-hangzhou参考取值来源: DescribeRegions
DBProxyEngineTypestring	预留参数，无需配置。示例值:normal参考取值来源: DescribeDBProxy

返回参数

字段名称	字段详情
DBProxyConnectStringstring	代理连接地址。示例值:testproxy****.rwlb.rds.aliyuncs.com
DBProxyConnectStringNetTypestring	代理连接地址的网络类型，取值：展开详情示例值:InnerString
DBProxyConnectStringPortstring	代理连接地址端口。示例值:3306
DBProxyEndpointIdstring	代理连接地址 ID。示例值:keaxncrjluwu0gue****
DBProxyEngineTypestring	内部参数，无需关注。示例值:normal
DBProxyFeaturesstring	代理终端的设置信息，格式为 JSON，包含下述参数：展开详情示例值:TransactionReadSqlRouteOptimizeStatus:1;ConnectionPersist:0;ReadWriteSpliting:1
DBProxyNodesobject
DbProxyEndpointAliasesstring	代理终端的备注信息。示例值:proxyterminal-test
DbProxyEndpointReadWriteModestring	代理终端的读写类型，取值：展开详情示例值:ReadWrite
DbProxyEndpointVswitchIdstring	代理终端的交换机 ID。示例值:vsw-****
DbProxyEndpointVpcIdstring	代理终端的 VPC ID 示例值:vpc-****
DbProxyEndpointZoneIdstring	代理终端的可用区信息。示例值:cn-hangzhou-c
EndpointConnectItemsobject
ReadOnlyInstanceDistributionTypestring	读权重分配模式，详情请参见读权重分配。取值：展开详情示例值:Standard
ReadOnlyInstanceMaxDelayTimestring	读写分离的延迟阈值，当只读实例延迟时间超过该阈值时，读取流量不发往该实例，单位：秒。示例值:30
CausalConsistReadTimeoutstring	一致性读超时时间，单位：毫秒。默认为 10 毫秒，取值：0～60000 示例值:10
ReadOnlyInstanceWeightstring	读权重分配信息，即传入主实例和只读实例的读请求权重，格式为 JSON，包含下述参数：展开详情示例值:[{\"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}]]
RequestIdstring	请求 ID。示例值:847BA085-B377-4BFA-8267-F82345ECE1D2
DBProxyEndpointMinSlaveCountstring	最小保留实例数。示例值:2

返回示例

错误码

没有我想要的错误码, 点击反馈

全局错误码

HTTP 状态码	错误码	错误信息	操作

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.	诊断
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.	诊断
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.	诊断

变更历史

	变更时间	变更内容概要	操作
	2025-02-27	变更返回参数
	2024-11-26	变更返回参数
	2024-10-31	变更错误码403
	2024-10-15	变更返回参数
	2024-01-22	变更错误码404
	2023-12-19	变更错误码400 变更错误码403
	2022-09-01	变更错误码400
	2022-06-08	新增请求参数DBProxyEngineType 变更返回参数
	2022-05-10	变更错误码400

DescribeDBProxyEndpoint_云数据库 RDS_API文档

接口说明

适用引擎

流控信息

授权信息

请求参数

返回参数

返回示例

错误码

变更历史

相关示例