DescribeDBProxyEndpoint - - Alibaba Cloud Dokümantasyon Merkezi

Bu API, bir RDS örneği için veritabanı proxy uç noktası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. Örnek kimliklerini sorgulamak için DescribeDBInstances işlemini çağırabilirsiniz.	rm-bp1ja4f56s7us****
DBProxyEndpointId	string	No	Vekil uç noktasının kimliği. Bu kimliği sorgulamak için DescribeDBProxy işlemini çağırabilirsiniz.	keaxncrjluwu0gue****
DBProxyConnectString	string	No	Vekil bağlantı dizesi. Bu bağlantı dizesini sorgulamak için DescribeDBProxy işlemini çağırabilirsiniz.	testproxy****.rwlb.rds.aliyuncs.com
RegionId	string	No	Bölge kimliği. En güncel bölge listesini sorgulamak için DescribeRegions işlemini çağırabilirsiniz.	cn-hangzhou
DBInstanceId	string	Yes	Örnek kimliği. Örnek kimliklerini sorgulamak için DescribeDBInstances işlemini çağırabilirsiniz.	rm-bp1ja4f56s7us****
DBProxyEngineType	string	No	Bu parametre ayrılmıştır ve belirtilmesine gerek yoktur.	normal

Response elements

Element	Type	Description	Example
	object	Yanıt parametreleri.
DBProxyConnectString	string	Vekil bağlantı dizesi.	testproxy****.rwlb.rds.aliyuncs.com
DBProxyConnectStringNetType	string	Vekil bağlantı dizesinin ağ türü. Geçerli değerler: InnerString: Dahili adres. OuterString: Genel adres.	InnerString
DBProxyConnectStringPort	string	Vekil bağlantı dizesi için bağlantı noktası.	3306
DBProxyEndpointId	string	Vekil uç noktasının kimliği.	keaxncrjluwu0gue****
DBProxyEngineType	string	Ayrılmış bir parametre. Bu parametreyi yok sayabilirsiniz.	normal
DBProxyFeatures	string	Vekil uç noktasının özellik ayarları. Değer, noktalı virgülle ayrılmış anahtar-değer çiftlerinden oluşan bir dizedir. Dize aşağıdaki anahtarları içerir: TransactionReadSqlRouteOptimizeStatus: İşlem bölmenin etkinleştirilip etkinleştirilmeyeceğini belirtir. Geçerli değerler: 0 (devre dışı) ve 1 (etkin). ConnectionPersist: Bağlantı havuzu türünü belirtir. 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 etkinleştirilip etkinleştirilmeyeceğini belirtir. Geçerli değerler: 0 (devre dışı) ve 1 (etkin). AZProximityAccess: Yakın erişim özelliği. Geçerli değerler: 0 (devre dışı) ve 1 (etkin). CausalConsistRead: Okuma tutarlılığı düzeyini belirtir. Geçerli değerler: 0 (nihai tutarlılık), 1 (oturum tutarlılığı) ve 2 (küresel tutarlılık). HtapFilter: HTAP isteklerinin otomatik yönlendirilmesi. Geçerli değerler: 0 (devre dışı) ve 1 (etkin). PinPreparedStmt: Yalnızca ApsaraDB RDS for PostgreSQL örnekleri için görünür olan ayrılmış bir dahili parametre. Not ApsaraDB RDS for PostgreSQL örnekleri için yalnızca ReadWriteSpliting ayarını değiştirebilirsiniz. TransactionReadSqlRouteOptimizeStatus ve PinPreparedStmt anahtarları kalıcı olarak 1'e ayarlanmıştır.	TransactionReadSqlRouteOptimizeStatus:1;ConnectionPersist:0;ReadWriteSpliting:1
DBProxyNodes	object
DBProxyNodes	array<object>	Vekil uç noktasıyla ilişkili vekil düğümleri.
	object	Bir vekil düğümünün özellikleri.
cpuCores	string	Vekil düğümündeki CPU çekirdeği sayısı.	2
nodeId	string	Vekil düğümünün kimliği.	pn-xxxxxxx01
zoneId	string	Vekil düğümünün bulunduğu kullanılabilirlik bölgesinin kimliği.	cn-hangzhou-c
DbProxyEndpointAliases	string	Vekil uç noktasının diğer adı.	proxyterminal-test
DbProxyEndpointReadWriteMode	string	Vekil uç noktasının okuma/yazma modu. Geçerli değerler: ReadWrite: Okuma/yazma modu. ReadOnly: Salt okunur mod.	ReadWrite
DbProxyEndpointVswitchId	string	Vekil uç noktasının VSwitch kimliği.	vsw-****
DbProxyEndpointVpcId	string	Vekil uç noktasının VPC kimliği.	vpc-****
DbProxyEndpointZoneId	string	Vekil uç noktasının oluşturulduğu kullanılabilirlik bölgesinin kimliği.	cn-hangzhou-c
EndpointConnectItems	object
EndpointConnectItems	array<object>	Vekil bağlantı dizeleriyle ilgili ayrıntıların listesi.
	object	Bir vekil bağlantı dizesinin ayrıntıları.
DbProxyEndpointConnectString	string	Vekil bağlantı dizesi.	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	Hizmet bağlantı noktası. Varsayılan değer: 3306.	3306
ReadOnlyInstanceDistributionType	string	Okuma ağırlığı dağıtım modu. Daha fazla bilgi için Okuma ağırlığı tahsisi konusuna bakın. Geçerli değerler: Standard: Sistem, teknik özelliklerine göre örneklere otomatik olarak okuma ağırlıkları tahsis eder. Custom: Örnekler için özel okuma ağırlıkları belirlersiniz.	Standard
ReadOnlyInstanceMaxDelayTime	string	Okuma/yazma bölme için gecikme eşiği. Salt okunur bir örnekteki çoğaltma gecikmesi bu eşiği aşarsa, okuma istekleri örneğe yönlendirilmez. Birim: saniye.	30
CausalConsistReadTimeout	string	Milisaniye cinsinden tutarlı okuma için zaman aşımı. Geçerli değerler: 0 ile 60000 arası. Varsayılan değer: 10.	10
ReadOnlyInstanceWeight	string	Okuma ağırlığı dağıtımı. Değer, birincil ve salt okunur örneklerin okuma ağırlıklarını belirten bir JSON dizesidir. Aşağıdaki alanları içerir: DBInstanceId: Örnek kimliği. DBInstanceType: Örnek türü. Geçerli değerler: Master (birincil örnek) ve ReadOnly (salt okunur örnek). NodeID: Örnek RDS Cluster Edition çalıştırıyorsa, birincil örneğin birincil veya ikincil düğümünün kimliği. NodeType: RDS Cluster Edition çalıştıran bir örneğin düğüm türü. Geçerli değerler: Primary (birincil düğüm) ve Secondary (ikincil düğüm). Weight: Örneğin okuma ağırlığı. Değer 100'lük artışlarla artar ve 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	Korunacak 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	Description
400	MaxscaleNotSupport	Current custins can not support Maxscale.	İşlem başarısız oldu. Örnek özel proxy'yi desteklemiyor. Özel proxy'yi etkinleştirme yapılandırmasını kontrol edin.
400	InvalidEndPoint.Format	The specified EndPoint is not valid.	Özel proxy uç noktası kimliği (DBProxyEndpointId) belirtilmemiş veya bulunmuyor. Endpoint parametresini kontrol edin.
400	InvalidDBInstanceName	Specified parameter DBInstanceName is not valid.	Belirtilen örnek adı (DBInstanceName) geçersiz. Parametre değerinin null veya boş bir dize olup olmadığını kontrol edin.
400	Endpoint.NotFound	The specified EndPoint is not valid.	İşlem başarısız oldu. Belirtilen uç nokta bilgisi bulunamadı.
400	InvalidParameter	The specified parameter is invalid.	Parametre geçersiz.
400	Order.ComboInstanceNotAllowOperate	A package instance is not allowed to operate independently.	Paketteki örnekler üzerinde ayrı ayrı işlem yapılamaz.
400	Price.PricingPlanResultNotFound	Pricing plan price result not found.	Fiyatlandırma planı sonucu bulunamadı.
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.	Gerçek ad doğrulamasını tamamlamadınız ve satın alma işlemi yapma uygunluğuna sahip değilsiniz. Gerçek ad doğrulamasını tamamlamak için Giderler ve Maliyetler'de oturum açın.
400	InsufficientAvailableQuota	Your account quota limit is less than 0, please recharge before trying to purchase.	Hesap bakiyeniz 0'dan azdır. Satın alma işlemi yapmadan önce hesabınıza bakiye yükleyin.
400	CommodityServiceCalling.Exception	Failed to call commodity service.	Ticari hizmet çağrısı başarısız oldu.
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.	Alibaba Cloud, mevcut bölgeyi optimize etmeyi ve ayarlamayı planlamaktadır. Bu bölgedeki bulut hizmetleri operasyonlarını sonlandıracaktır. İş sürekliliğinizi ve sorunsuz bir veri geçişini sağlamak için şu anda yeni satın alma siparişleri veremezsiniz. Anlayışınız ve desteğiniz için teşekkür ederiz.
400	Commodity.InvalidComponent	The module you purchased is not legal, please buy it again.	Satın aldığınız modül geçersiz. Modülü yeniden satın alın.
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.	Belirtilen bölge kullanımdan kaldırılmıştır.
400	Price.CommoditySys	Commodity system call exception.	Ticari sistem çağrılırken bir istisna oluştu.
400	Pay.InsufficientBalance	Insufficient available balance.	Mevcut hesap bakiyesi 100'den az. Satın alma işlemi yapmadan önce hesabınıza bakiye yükleyin.
400	Order.PeriodInvalid	There is a problem with the period you selected, please choose again.	Seçilen abonelik süresi geçersiz. Farklı bir abonelik süresi seçin.
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.	Seçtiğiniz hizmet için ödenmemiş bir sipariş mevcut. Yeni bir sipariş vermeden önce mevcut siparişi ödeyin veya iptal edin.
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.	Bilgileriniz eksik. Devam etmeden önce bilgilerinizi tamamlayın.
400	Risk.RiskControlRejection	Your account is abnormal, please contact customer service for details.	Hesabınızda bir istisna durumu bulunmaktadır. Ayrıntılar için müşteri hizmetleriyle iletişime geçin.
400	Api.NotSupport	Specified api is not supported.	Mevcut işlem desteklenmez.
400	ContainForbiddenLabelError	There is a label that prohibits placing orders. Please contact your distributor for assistance.	Siparişi engelleyen bir etiket mevcut. Bu sorunu çözmek için distribütörünüzle iletişime geçin.
400	InvalidDBInstanceId.NotFound	The DBInstanceId provided does not exist in records.	Belirtilen örnek mevcut değil. Örneğin var olup olmadığını ve silinmemiş olduğunu kontrol edin.
400	InvalidInstanceLevel.DiskType	Specified instance level not support request disk type	Mevcut örnek türü bu depolama türünü desteklememektedir.
400	InvalidParam	Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.	İşlem başarısız oldu. Parametre geçersiz.
400	KmsApiError	User secret key invalid.	Kullanıcı anahtarı geçersiz.
400	System.SaleValidateFailed	Sales expression validation system error.	İstek geçerli bir abonelik süresi içermiyor. Period veya UsedTime parametresini kontrol edin.
400	Abs.InvalidAccount.NotFound	account is not found.	Hesap mevcut değil.
400	SqlExecuteFailedOrTimeout	sql command execution failed or timed out:%s.	SQL komutu yürütülemedi veya zaman aşımına uğradı.
400	ColdData.EngineVersionNotSupport	The current instance engine version not support coldDataEnabled.	Mevcut örnek DPI motoru sürümü soğuk veri arşivlemeyi desteklemez.
400	ColdData.MinorVersionNotSupport	The current instance minor version not support coldDataEnabled.	Mevcut çekirdek sürümü soğuk veri arşivlemeyi desteklemez.
400	IncorrectTargetClasscode	The current instance type does not support this operation.	Mevcut örnek türü bu işlemi desteklemez.
400	InvalidConnectionString.Duplicate	Specified connection string already exists in the RDS.	Bağlantı adresi adı yineleniyor. Farklı bir bağlantı dizesi belirtin.
400	RequiredParam.NotFound	Required input param is not found.	Gerekli bir parametre eksik.
400	Parameters.Invalid	Parameter error, please check the parameters.	Parametre geçersiz. Parametreleri kontrol edin.
400	BackupPolicyNotSupport	Cold Data won't open with CrossBackup or Flash Backup, please check Backup Policy.	Soğuk veri arşivleme, bölgeler arası yedeklemeyi veya yüksek frekanslı anlık görüntü yedeklemesini desteklemez. Yedekleme politikasını kontrol edin.
400	InvalideStatus.Format	The instance status does not support this operation.	Örnek durumu bu işlemi desteklemiyor.
400	InvalidReleasedKeepPolicy.Format	Specified Released Keep Policy is not valid.	Örnek serbest bırakıldıktan sonraki arşivlenmiş yedek veri saklama politikası geçersiz.
400	InvalidDBInstanceEngineType.Format	the DB instance engine type does not support this operation.	Örneğin veritabanı motoru türü bu işlemi desteklemez.
400	Pay.NoCreditCard	No credit cards.	Hesap bir kredi kartına bağlı değil.
400	VpcNetworkTypeNotSupport	The vpc network type instance does not support this operation.	Bu işlem, VPC ağ türündeki örnekler için desteklenmez.
400	MirrorInsExists	Specified DB instance mirror ins already existed.	Veritabanı örneği görüntüsü zaten mevcut.
400	UnsupportedClassCode	The specified DB instance class stops selling.	Örnek türü artık satın alıma sunulmamaktadır.
400	InvalidBackupSet	The specified database does not exist in the backup set.	Belirtilen veritabanı yedekleme kümesinde mevcut değil.
400	OrdTCommodityQueryError	Failed to query for product.	Ürün sorgulanamadı.
400	ProductInstanceReleased	The instance has been released. Please check before placing the order.	Örnek serbest bırakılmıştır. Sipariş vermeden önce örneği doğrulayın.
400	RegionEndTimeDissolvedIndia	The region is no longer supported.	Belirtilen bölge kullanımdan kaldırılmıştır.
500	ExternalFailure	The request processing has failed due to external service failure.	İstek başarısız oldu. Daha sonra tekrar deneyin.
500	RequestMetaDataFailed	The service request failed. Please try again later or contact service personnel.	İstek başarısız oldu. Daha sonra tekrar deneyin veya teknik destek ile iletişime geçin.
500	InvokeProxyFailure	The request processing has failed due to service failure of rds api.	İstek, RDS API hizmetindeki bir hata nedeniyle başarısız oldu.
403	IncorrectKindCode	The current KindCode of the custins does not support the operation.	İşlem başarısız oldu. Geçerli örneğin ortam türü desteklenmiyor. İşlem tarafından desteklenen örnek türlerini kontrol edin.
403	IncorrectDBInstanceType	The current database instance type does not support the operation.	İşlem başarısız oldu. Mevcut veritabanı örneği motoru ve türü desteklenmiyor.
403	IncorrectDBInstanceEngine	Current DB Instance engine does not support this operation.	İşlem başarısız oldu. Mevcut veritabanı motoru desteklenmiyor.
403	OrderStatus.UnPaid	The specified db instance has unpaid order.	Örneğin ödenmemiş bir siparişi var. Siparişi ödeyin ve tekrar deneyin.
403	InvalidReduceDiskSize	The storage capacity after the scale-down must be larger than the used amount.	Ölçek küçültme için hedef kapasite, mevcut depolama kullanımından az olamaz.
403	CloudSSDNotSupport	Cloud ssd does not support this operation, please upgrade to essd.	SSD bulut diskleri bu işlemi desteklemez. ESSD'ye yükseltin.
403	InvalidUserOperatorPermission	The user permission does not support this operation.	Kullanıcı izinleri bu işlemi desteklemez.
403	InvalidVswitchId	Specified conn vswitch id is not valid.	Belirtilen VSwitchId geçersiz bir formatta veya boş.
403	IncorrectMinorVersion	Current engine minor version does not support operations.	Mevcut alt motor sürümü bu işlemi desteklemiyor.
403	OperationDenied.ZoneResource	There is no available zone for inventory.	Kullanılabilir stok bölgesi bulunmuyor.
403	NotInFlowController	Sorry,no permission.	Bu işlem, kurumsal olmayan bulut kullanıcıları için kullanılamaz. Gerekli izinlere sahip değilsiniz.
403	InvalidKmsKey	Kms key is disabled.	KMS anahtarı devre dışı.
403	InvalidInstanceLevel.Malformed	Current DB instance level does not support this operation.	İşlem başarısız oldu. Belirtilen teknik özellik kodu, belirtilen uç nokta sayısını desteklememektedir. Parça sayısını ve mevcut uç nokta sayısını kontrol edin.
403	InvalidVpcInfo.NotFound	Specified VPC info does not exist.	Belirtilen VPC bilgisi mevcut değil.
404	Endpoint.NotFound	Specified endpoint is not found.	İşlem başarısız oldu. Belirtilen uç nokta bilgisi bulunamadı.
404	Maxscale.NotFound	The relative maxscale instance is not found.	İşlem başarısız oldu. İlişkili MaxScale örneği bulunamadı.
404	InvalidClusterKms	The current instance does not authorized to access the Key Management Service.	Mevcut örneğin Key Management Service'e erişim yetkisi bulunmuyor.
404	Request.NotFound	The requested resource is not available.	İstenen kaynak kullanılamıyor.
404	HostInfo.NotFound	The specified host info is not found.	Belirtilen ana makine bilgileri mevcut değil.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.