DescribeDBProxyEndpoint - - Alibaba Cloud Dokümantasyon Merkezi

Bir RDS örneğinin veritabanı proxy'sine ait uç nokta ayrıntılarını getirir.

Operation description

Desteklenen motorlar

RDS MySQL
RDS PostgreSQL

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

rds:DescribeDBProxyEndpoint

get

*DBInstance.

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

rds:ResourceTag
rds:ResourceTag
rds:ResourceTag
rds:ResourceTag

None

Request parameters

Parameter	Type	Required	Description	Example
DBInstanceId	string	Yes	Örnek kimliği. Bu kimliği almak için DescribeDBInstances işlemini çağırabilirsiniz.	rm-bp1ja4f56s7us****
DBProxyEndpointId	string	No	Proxy uç noktası kimliği. Bu kimliği almak için DescribeDBProxy işlemini çağırabilirsiniz.	keaxncrjluwu0gue****
DBProxyConnectString	string	No	Proxy bağlantı dizesi. Bu dizeyi almak için DescribeDBProxy işlemini çağırabilirsiniz.	testproxy****.rwlb.rds.aliyuncs.com
RegionId	string	No	Bölge kimliği. Bu kimliği almak için DescribeRegions işlemini çağırabilirsiniz.	cn-hangzhou
DBInstanceId	string	Yes	Örnek kimliği. Bu kimliği almak için DescribeDBInstances işlemini çağırabilirsiniz.	rm-bp1ja4f56s7us****
DBProxyEngineType	string	No	Ayrılmış bir parametre.	normal

Response elements

Element	Type	Description	Example
	object	Yanıt parametreleri.
DBProxyConnectString	string	Proxy bağlantı adresi.	testproxy****.rwlb.rds.aliyuncs.com
DBProxyConnectStringNetType	string	Proxy bağlantı adresinin ağ türü. Geçerli değerler: InnerString: Özel adres. OuterString: Genel adres.	InnerString
DBProxyConnectStringPort	string	Proxy bağlantı adresinin portu.	3306
DBProxyEndpointId	string	Proxy uç noktası kimliği.	keaxncrjluwu0gue****
DBProxyEngineType	string	Dahili bir parametre. Bu parametreyi yok sayabilirsiniz.	normal
DBProxyFeatures	string	Proxy uç noktasının ayarları. Değer, noktalı virgül (;) ile ayrılmış aşağıdaki anahtar-değer çiftlerinden oluşan bir dizedir: TransactionReadSqlRouteOptimizeStatus: İşlem bölmenin etkin olup olmadığını gösterir. Geçerli değerler: 0 (devre dışı) ve 1 (etkin). ConnectionPersist: Bağlantı havuzu türü. Geçerli değerler: 0 (devre dışı), 1 (oturum düzeyinde bağlantı havuzu) ve 2 (işlem düzeyinde bağlantı havuzu). ReadWriteSpliting: Okuma/yazma bölmenin etkin olup olmadığını gösterir. Geçerli değerler: 0 (devre dışı) ve 1 (etkin). AZProximityAccess: Yakınlık tabanlı erişimin etkin olup olmadığını gösterir. Geçerli değerler: 0 (devre dışı) ve 1 (etkin). CausalConsistRead: Okuma tutarlılığı ayarı. Geçerli değerler: 0 (nihai tutarlılık), 1 (oturum tutarlılığı) ve 2 (küresel tutarlılık). HtapFilter: HTAP için otomatik satır-sütun bölmenin etkin olup olmadığını gösterir. Geçerli değerler: 0 (devre dışı) ve 1 (etkin). PinPreparedStmt: Yalnızca ApsaraDB RDS for PostgreSQL örnekleri için döndürülen ayrılmış bir parametre. Not ApsaraDB RDS for PostgreSQL örnekleri için yalnızca ReadWriteSpliting ayarını değiştirebilirsiniz. TransactionReadSqlRouteOptimizeStatus ve PinPreparedStmt parametreleri varsayılan olarak 1'e ayarlanmıştır.	TransactionReadSqlRouteOptimizeStatus:1;ConnectionPersist:0;ReadWriteSpliting:1
DBProxyNodes	object
DBProxyNodes	array<object>	Proxy uç noktasıyla ilişkili proxy düğümlerinin bir listesi.
	object	Bir proxy düğümünün ayrıntıları.
cpuCores	string	Düğüm için CPU çekirdeği sayısı.	2
nodeId	string	Proxy düğümünün kimliği.	pn-xxxxxxx01
zoneId	string	Düğümün bulunduğu kullanılabilirlik bölgesinin kimliği.	cn-hangzhou-c
DbProxyEndpointAliases	string	Proxy uç noktasının açıklaması.	proxyterminal-test
DbProxyEndpointReadWriteMode	string	Proxy uç noktasının okuma/yazma modu. Geçerli değerler: ReadWrite: okuma/yazma modu. ReadOnly: salt okunur mod.	ReadWrite
DbProxyEndpointVswitchId	string	VSwitch kimliği.	vsw-****
DbProxyEndpointVpcId	string	VPC kimliği.	vpc-****
DbProxyEndpointZoneId	string	Proxy uç noktasının kullanılabilirlik bölgesi kimliği.	cn-hangzhou-c
EndpointConnectItems	object
EndpointConnectItems	array<object>	Proxy bağlantı adresleri.
	object	Bir proxy bağlantı adresi.
DbProxyEndpointConnectString	string	Proxy bağlantı adresi.	testproxy****.rwlb.rds.aliyuncs.com
DbProxyEndpointNetType	string	Ağ türü. Geçerli değerler: 0: genel ağ 1: klasik ağ 2: VPC	2
DbProxyEndpointPort	string	Port numarası. Varsayılan değer: 3306.	3306
ReadOnlyInstanceDistributionType	string	Okuma ağırlığı dağıtım modu. Daha fazla bilgi için Okuma ağırlığı dağıtımı konusuna bakın. Geçerli değerler: Standard: Sistem, örneğe ve salt okunur örneklerine teknik özelliklerine göre otomatik olarak okuma ağırlıkları atar. Custom: Örneğe ve salt okunur örneklerine okuma ağırlıklarını manuel olarak atarsınız.	Standard
ReadOnlyInstanceMaxDelayTime	string	Okuma/yazma bölme için gecikme eşiği. Salt okunur bir örneğin gecikmesi bu eşiği aşarsa sistem okuma trafiğini bu örneğe yönlendirmez. Birim: saniye.	30
CausalConsistReadTimeout	string	Tutarlı okumalar için milisaniye cinsinden zaman aşımı süresi. Varsayılan değer: 10. Geçerli değerler: 0 ile 60000 arası.	10
ReadOnlyInstanceWeight	string	Okuma ağırlığı dağıtım ayrıntıları. Bu parametre, birincil örneğin ve salt okunur örneklerinin okuma ağırlıklarını belirtir. Değer, aşağıdaki parametreleri içeren bir JSON dizesidir: DBInstanceId: Örnek kimliği. DBInstanceType: Örnek türü. Geçerli değerler: Master (birincil örnek) ve ReadOnly (salt okunur örnek). NodeID: Düğüm kimliği. Bu parametre yalnızca RDS Cluster Edition örnekleri için döndürülür. NodeType: Düğüm türü. Bu parametre yalnızca RDS Cluster Edition örnekleri için döndürülür. Geçerli değerler: Primary (birincil düğüm) ve Secondary (ikincil düğüm). Weight: Okuma ağırlığı. Değer 100'ün katı olmalıdır. Maksimum değer 10000'dir.	[{\"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	İstek kimliği.	847BA085-B377-4BFA-8267-F82345ECE1D2
DBProxyEndpointCostThresholdForDuckdb	string
DBProxyEndpointMinSlaveCount	string	Tutulan minimum salt okunur örnek sayısı.	2

Examples

Success response

JSON format

{
  "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"
}

Error codes

HTTP status code	Error code	Error message
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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.