DescribeDBProxyEndpoint - ApsaraDB RDS - Alibaba Cloud Documentation Center

Mengkueri informasi titik akhir proksi database untuk instans Database Apsara RDS.

Deskripsi operasi

Mesin yang didukung

RDS MySQL
RDS PostgreSQL.

Coba sekarang

Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

Test

RAM authorization

Tabel berikut menjelaskan otorisasi yang diperlukan untuk memanggil API ini. Anda dapat menentukannya dalam kebijakan Resource Access Management (RAM). Kolom pada tabel dijelaskan sebagai berikut:

Action: Aksi yang dapat digunakan dalam elemen Action pada pernyataan kebijakan izin RAM untuk memberikan izin guna melakukan operasi tersebut.
API: API yang dapat Anda panggil untuk melakukan aksi tersebut.
Access level: Tingkat akses yang telah ditentukan untuk setiap API. Nilai yang valid: create, list, get, update, dan delete.
Resource type: Jenis resource yang mendukung otorisasi untuk melakukan aksi tersebut. Ini menunjukkan apakah aksi tersebut mendukung izin tingkat resource. Resource yang ditentukan harus kompatibel dengan aksi tersebut. Jika tidak, kebijakan tersebut tidak akan berlaku.
- Untuk API dengan izin tingkat resource, jenis resource yang diperlukan ditandai dengan tanda bintang (*). Tentukan Nama Sumber Daya Alibaba Cloud (ARN) yang sesuai dalam elemen Resource pada kebijakan.
- Untuk API tanpa izin tingkat resource, ditampilkan sebagai All Resources. Gunakan tanda bintang (*) dalam elemen Resource pada kebijakan.
Condition key: Kunci kondisi yang didefinisikan oleh layanan. Kunci ini memungkinkan kontrol granular, berlaku baik hanya untuk aksi maupun untuk aksi yang terkait dengan resource tertentu. Selain kunci kondisi spesifik layanan, Alibaba Cloud menyediakan serangkaian common condition keys yang berlaku di semua layanan yang didukung RAM.
Dependent action: Aksi dependen yang diperlukan untuk menjalankan aksi tersebut. Untuk menyelesaikan aksi tersebut, pengguna RAM atau role RAM harus memiliki izin untuk melakukan semua aksi dependen.

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

Parameter permintaan

Parameter	Type	Required	Description	Example
DBInstanceId	string	Yes	ID instans. Anda dapat memanggil DescribeDBInstances untuk mendapatkannya.	rm-bp1ja4f56s7us****
DBProxyEndpointId	string	No	Nama titik akhir proksi. Anda dapat memanggil DescribeDBProxy untuk mendapatkan nama titik akhir proksi.	keaxncrjluwu0gue****
DBProxyConnectString	string	No	Titik akhir proksi. Anda dapat memanggil DescribeDBProxy untuk mendapatkan titik akhir proksi.	testproxy****.rwlb.rds.aliyuncs.com
RegionId	string	No	ID wilayah. Anda dapat memanggil DescribeRegions untuk mendapatkan ID wilayah.	cn-hangzhou
DBInstanceId	string	Yes	实例 ID。可调用 DescribeDBInstances 获取。	rm-bp1ja4f56s7us****
DBProxyEngineType	string	No	Parameter yang dicadangkan. Anda tidak perlu mengonfigurasi parameter ini.	normal

Elemen respons

Element	Type	Description	Example
	object	Parameter tanggapan.
DBProxyConnectString	string	Titik akhir proksi.	testproxy****.rwlb.rds.aliyuncs.com
DBProxyConnectStringNetType	string	Jenis jaringan titik akhir proksi. Nilai valid: InnerString: Titik akhir internal. OuterString: Titik akhir publik.	InnerString
DBProxyConnectStringPort	string	Port titik akhir proksi.	3306
DBProxyEndpointId	string	ID titik akhir proksi.	keaxncrjluwu0gue****
DBProxyEngineType	string	Parameter internal. Anda dapat mengabaikan parameter ini.	normal
DBProxyFeatures	string	Pengaturan titik akhir proksi dalam format JSON. Parameter berikut disertakan: TransactionReadSqlRouteOptimizeStatus: pengaturan Pemisahan transaksi. Nilainya adalah 0 (dinonaktifkan) atau 1 (diaktifkan). ConnectionPersist: pengaturan Kolam koneksi. Nilainya adalah 0 (dinonaktifkan), 1 (Kolam koneksi tingkat sesi), atau 2 (Pooling koneksi tingkat transaksi). ReadWriteSpliting: pengaturan pemisahan baca/tulis. Nilainya adalah 0 (dinonaktifkan) atau 1 (diaktifkan). AZProximityAccess: fitur akses terdekat. Nilainya adalah 0 (dinonaktifkan) atau 1 (diaktifkan). CausalConsistRead: pengaturan konsistensi baca. Nilainya adalah 0 (konsistensi akhir), 1 (konsistensi sesi), atau 2 (konsistensi global). HtapFilter: distribusi permintaan otomatis HTAP di antara node penyimpanan baris dan penyimpanan kolom. Nilainya adalah 0 (dinonaktifkan) atau 1 (diaktifkan). PinPreparedStmt: hanya terlihat untuk RDS PostgreSQL. Ini adalah parameter internal. Catatan RDS PostgreSQL hanya mendukung modifikasi ReadWriteSpliting. TransactionReadSqlRouteOptimizeStatus dan PinPreparedStmt diatur ke 1 secara default.	TransactionReadSqlRouteOptimizeStatus:1;ConnectionPersist:0;ReadWriteSpliting:1
DBProxyNodes	object
DBProxyNodes	array<object>	Daftar node proksi yang terkait dengan titik akhir proksi.
	object	Detail node proksi.
cpuCores	string	The number of CPU cores of the node.	2
nodeId	string	The ID of the node in the zone.	pn-xxxxxxx01
zoneId	string	The zone ID of the node.	cn-hangzhou-c
DbProxyEndpointAliases	string	Deskripsi titik akhir proksi.	proxyterminal-test
DbProxyEndpointReadWriteMode	string	Tipe baca/tulis titik akhir proksi. Nilai valid: ReadWrite: mode pemisahan baca/tulis. ReadOnly: mode hanya baca.	ReadWrite
DbProxyEndpointVswitchId	string	ID vSwitch titik akhir proksi.	vsw-****
DbProxyEndpointVpcId	string	ID VPC titik akhir proksi.	vpc-****
DbProxyEndpointZoneId	string	Informasi zona titik akhir proksi.	cn-hangzhou-c
EndpointConnectItems	object
EndpointConnectItems	array<object>	Daftar informasi mendetail tentang titik akhir proksi.
	object	Informasi mendetail tentang titik akhir proksi.
DbProxyEndpointConnectString	string	The proxy endpoint queried.	testproxy****.rwlb.rds.aliyuncs.com
DbProxyEndpointNetType	string	The network type of the instance. Valid values: 0: Internet 1: classic network 2: virtual private cloud (VPC)	2
DbProxyEndpointPort	string	The port number that is associated with the proxy endpoint. Default value: 3306.	3306
ReadOnlyInstanceDistributionType	string	Mode distribusi bobot baca. Untuk informasi lebih lanjut, lihat Distribusi bobot baca. Nilai valid: Standard: mendistribusikan bobot secara otomatis berdasarkan spesifikasi instans. Custom: menggunakan distribusi bobot kustom.	Standard
ReadOnlyInstanceMaxDelayTime	string	Ambang batas latensi untuk pemisahan baca/tulis. Ketika latensi instans hanya baca melebihi ambang batas ini, trafik baca tidak dialihkan ke instans. Unit: detik.	30
CausalConsistReadTimeout	string	Periode waktu tunggu untuk pembacaan konsistensi. Unit: milidetik. Nilai default: 10. Nilai valid: 0 hingga 60000.	10
ReadOnlyInstanceWeight	string	Informasi distribusi bobot baca, yang menentukan bobot permintaan baca dari Instans utama dan instans hanya baca. Nilainya dalam format JSON dan mencakup parameter berikut: DBInstanceId: ID instans. DBInstanceType: Tipe instans. Nilainya adalah Master (Instans utama) atau ReadOnly (instans hanya baca). NodeID: ID node dari node utama atau node sekunder Instans utama di Edisi Kluster. NodeType: tipe node di Edisi Kluster. Nilainya adalah Primary (node utama Instans utama) atau Secondary (node sekunder Instans utama). Weight: bobot permintaan baca. Nilai meningkat dalam kelipatan 100. Nilai maksimum: 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	ID permintaan.	847BA085-B377-4BFA-8267-F82345ECE1D2
DBProxyEndpointCostThresholdForDuckdb	string
DBProxyEndpointMinSlaveCount	string	Jumlah minimum instans yang dicadangkan.	2

Contoh

Respons sukses

JSONformat

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

Kode kesalahan

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.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.