All Products
Search
Document Center

:Kueri titik akhir proksi

Last Updated:May 29, 2026

Anda dapat memanggil operasi DescribeDBProxyEndpoint untuk mengkueri detail titik akhir proksi yang digunakan untuk menghubungkan ke database proxy suatu instans.

Sebelum memanggil operasi DescribeDBProxyEndpoint, pastikan Anda telah memanggil operasi ModifyDBProxy untuk mengaktifkan fitur database proxy pada instans tersebut.

  • Fitur dedicated proxy dari ApsaraDB RDS for MySQL menyediakan kemampuan seperti pemisahan baca/tulis dan optimasi koneksi singkat. Untuk informasi selengkapnya, lihat Apa itu database proxy?
  • Fitur database proxy dari ApsaraDB RDS for PostgreSQL mendukung pemisahan baca/tulis. Untuk informasi selengkapnya, lihat Apa itu database proxy?

Debugging

OpenAPI Explorer secara otomatis menghitung nilai signature. Untuk kenyamanan Anda, kami menyarankan agar Anda memanggil operasi ini di OpenAPI Explorer. OpenAPI Explorer secara dinamis menghasilkan contoh kode operasi ini untuk berbagai SDK.

Parameter permintaan

ParameterTipeWajibContohDeskripsi
ActionStringYaDescribeDBProxyEndpoint

Operasi yang ingin Anda lakukan. Tetapkan nilainya ke DescribeDBProxyEndpoint.

DBInstanceIdStringYarm-bp1ja4f56s7us****

ID instans. Anda dapat memanggil operasi DescribeDBInstances untuk mengkueri ID instans tersebut.

DBProxyEndpointIdStringTidakkeaxncrjluwu0gue****

Nama terminal proksi tempat titik akhir proksi tersebut berada. Anda dapat memanggil operasi DescribeDBProxy untuk mengkueri nama terminal proksi tersebut.

DBProxyConnectStringStringTidaktestproxy****.rwlb.rds.aliyuncs.com

Titik akhir proksi yang ingin Anda kueri. Anda dapat memanggil operasi DescribeDBProxy untuk mengkueri titik akhir proksi tersebut.

RegionIdStringYacn-hangzhou

ID wilayah instans. Anda dapat memanggil operasi DescribeRegions untuk mengkueri daftar wilayah terbaru.

DBProxyEngineTypeStringTidaknormal

Parameter internal. Anda tidak perlu menentukan parameter ini.

Parameter respons

ParameterTipeContohDeskripsi
DBProxyConnectStringNetTypeStringInnerString

Jenis jaringan titik akhir proksi. Nilai yang valid:

  • InnerString: jaringan internal
  • OuterString: Internet
DBProxyFeaturesStringTransactionReadSqlRouteOptimizeStatus:1;ConnectionPersist:0;ReadWriteSpliting:1

Konfigurasi terminal proksi. Nilai parameter ini adalah string JSON yang terdiri atas bidang-bidang berikut:

  • TransactionReadSqlRouteOptimizeStatus: status fitur pemisahan transaksi. Nilai yang valid: 0 dan 1. Nilai 0 menunjukkan bahwa fitur dinonaktifkan. Nilai 1 menunjukkan bahwa fitur diaktifkan.
  • ConnectionPersist: status fitur pooling koneksi. Nilai yang valid: 0, 1, dan 2. Nilai 0 menunjukkan bahwa fitur pooling koneksi dinonaktifkan. Nilai 1 menunjukkan bahwa fitur session connection pooling diaktifkan. Nilai 2 menunjukkan bahwa fitur transaction connection pooling diaktifkan.
  • ReadWriteSpliting: status fitur pemisahan baca/tulis. Nilai yang valid: 0 dan 1. Nilai 0 menunjukkan bahwa fitur dinonaktifkan. Nilai 1 menunjukkan bahwa fitur diaktifkan.
  • PinPreparedStmt: bidang internal yang hanya tersedia untuk instans ApsaraDB RDS for PostgreSQL.
    Catatan Jika instans menjalankan PostgreSQL, Anda hanya dapat mengubah nilai bidang ReadWriteSpliting. Bidang TransactionReadSqlRouteOptimizeStatus dan PinPreparedStmt akan diatur ke nilai defaultnya yaitu 1.
RequestIdString847BA085-B377-4BFA-8267-F82345ECE1D2

ID permintaan.

ReadOnlyInstanceWeightString[{\"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}]]

Bobot baca instans dan instans hanya bacanya. Nilai parameter ini adalah string JSON yang terdiri atas bidang-bidang berikut:

  • DBInstanceId: ID instans.
  • DBInstanceType: role instans. Nilai yang valid: Master dan ReadOnly.
  • NodeID: ID node primary dan secondary pada instans utama jika instans menjalankan RDS Cluster Edition.
  • NodeType: tipe node jika instans menjalankan RDS Cluster Edition. Nilai yang valid: Primary dan Secondary. Nilai Primary menunjukkan node utama pada instans utama. Nilai Secondary menunjukkan node sekunder pada instans utama.
  • Weight: bobot baca instans. Bobot baca meningkat dengan kenaikan sebesar 100 dan tidak boleh melebihi 10000.
ReadOnlyInstanceDistributionTypeStringStandard

Metode yang digunakan untuk menetapkan bobot baca. Untuk informasi selengkapnya, lihat Ubah ambang batas latensi dan bobot baca instans ApsaraDB RDS for MySQL. Nilai yang valid:

  • Standard: ApsaraDB RDS secara otomatis mengalokasikan bobot baca ke instans dan instans hanya bacanya berdasarkan spesifikasi instans tersebut.
  • Custom: Anda harus menetapkan bobot baca secara manual ke instans dan instans hanya bacanya.
ReadOnlyInstanceMaxDelayTimeString30

Ambang batas latensi yang diizinkan untuk pemisahan baca/tulis. Jika latensi pada instans hanya baca melebihi ambang batas yang ditentukan, ApsaraDB RDS tidak lagi meneruskan permintaan baca ke instans hanya baca tersebut.

DbProxyEndpointReadWriteModeStringReadWrite

Atribut baca dan tulis terminal proksi. Nilai yang valid:

  • ReadWrite: Terminal proksi mendukung permintaan baca dan tulis.
  • ReadOnly: Terminal proksi hanya mendukung permintaan baca.
DbProxyEndpointAliasesStringproxyterminal-test

Deskripsi terminal proksi.

DBProxyEndpointIdStringkeaxncrjluwu0gue****

ID titik akhir proksi.

DBProxyConnectStringPortString3306

Nomor port yang terkait dengan titik akhir proksi.

DBProxyConnectStringStringtestproxy****.rwlb.rds.aliyuncs.com

Titik akhir proksi yang dikueri.

DBProxyEngineTypeStringnormal

Parameter internal. Anda dapat mengabaikan parameter ini.

EndpointConnectItemsArray of EndpointConnectItems

Array yang berisi informasi mengenai titik akhir proksi.

EndpointConnectItems
DbProxyEndpointPortString3306

Nomor port yang terkait dengan titik akhir proksi. Nilai default: 3306.

DbProxyEndpointConnectStringStringtestproxy****.rwlb.rds.aliyuncs.com

Titik akhir proksi yang dikueri.

DbProxyEndpointNetTypeString2

Jenis jaringan titik akhir proksi. Nilai yang valid:

  • 0: Internet
  • 1: jaringan klasik
  • 2: virtual private cloud (VPC)

Contoh

Permintaan Contoh

http(s)://rds.aliyuncs.com/?Action=DescribeDBProxyEndpoint
&DBInstanceId=rm-bp1ja4f56s7us****
&RegionId=cn-hangzhou
&<Common request parameters>

Respons Sukses Contoh

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeDBProxyEndpointResponse>
    <DBProxyConnectStringNetType>InnerString</DBProxyConnectStringNetType>
    <DBProxyFeatures>TransactionReadSqlRouteOptimizeStatus:1;ConnectionPersist:0;ReadWriteSpliting:1</DBProxyFeatures>
    <RequestId>847BA085-B377-4BFA-8267-F82345ECE1D2</RequestId>
    <ReadOnlyInstanceWeight>[{\"Availability\":\"Available\",\"DBInstanceId\":\"rr-bp****\",\"DBInstanceType\":\"ReadOnly\",\"NodeId\":\"rr-bp****\",\"NodeType\":\"ReadOnly\",\"Weight\":400}, {\"Availability\":\"Available\",\"DBInstanceId\":\"rm-2z****\",\"DBInstanceType\":\"Master\",\"NodeId\":\"rm-2z****-instance-2\",\"NodeType\":\"Secondary\",\"Weight\":400}, {\"Availability\":\"Available\",\"DBInstanceId\":\"rm-2z****\",\"DBInstanceType\":\"Master\",\"NodeId\":\"rm-2z****-instance-3\",\"NodeType\":\"Secondary\",\"Weight\":400}, {\"Availability\":\"Available\",,\"DBInstanceId\":\"rm-2z****\",\"DBInstanceType\":\"Master\",\"NodeId\":\"rm-2z****-instance-1\",\"NodeType\":\"Primary\",\"Weight\":0}]]</ReadOnlyInstanceWeight>
    <ReadOnlyInstanceDistributionType>Standard</ReadOnlyInstanceDistributionType>
    <ReadOnlyInstanceMaxDelayTime>30</ReadOnlyInstanceMaxDelayTime>
    <DbProxyEndpointReadWriteMode>ReadWrite</DbProxyEndpointReadWriteMode>
    <DbProxyEndpointAliases>proxyterminal-test</DbProxyEndpointAliases>
    <DBProxyEndpointId>keaxncrjluwu0gue****</DBProxyEndpointId>
    <DBProxyConnectStringPort>3306</DBProxyConnectStringPort>
    <DBProxyConnectString>testproxy****.rwlb.rds.aliyuncs.com</DBProxyConnectString>
    <DBProxyEngineType>normal</DBProxyEngineType>
    <EndpointConnectItems>
        <DbProxyEndpointPort>3306</DbProxyEndpointPort>
        <DbProxyEndpointConnectString>testproxy****.rwlb.rds.aliyuncs.com</DbProxyEndpointConnectString>
        <DbProxyEndpointNetType>2</DbProxyEndpointNetType>
    </EndpointConnectItems>
</DescribeDBProxyEndpointResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "DBProxyConnectStringNetType" : "InnerString",
  "DBProxyFeatures" : "TransactionReadSqlRouteOptimizeStatus:1;ConnectionPersist:0;ReadWriteSpliting:1",
  "RequestId" : "847BA085-B377-4BFA-8267-F82345ECE1D2",
  "ReadOnlyInstanceWeight" : "[{\\\"Availability\\\":\\\"Available\\\",\\\"DBInstanceId\\\":\\\"rr-bp****\\\",\\\"DBInstanceType\\\":\\\"ReadOnly\\\",\\\"NodeId\\\":\\\"rr-bp****\\\",\\\"NodeType\\\":\\\"ReadOnly\\\",\\\"Weight\\\":400}, {\\\"Availability\\\":\\\"Available\\\",\\\"DBInstanceId\\\":\\\"rm-2z****\\\",\\\"DBInstanceType\\\":\\\"Master\\\",\\\"NodeId\\\":\\\"rm-2z****-instance-2\\\",\\\"NodeType\\\":\\\"Secondary\\\",\\\"Weight\\\":400}, {\\\"Availability\\\":\\\"Available\\\",\\\"DBInstanceId\\\":\\\"rm-2z****\\\",\\\"DBInstanceType\\\":\\\"Master\\\",\\\"NodeId\\\":\\\"rm-2z****-instance-3\\\",\\\"NodeType\\\":\\\"Secondary\\\",\\\"Weight\\\":400}, {\\\"Availability\\\":\\\"Available\\\",,\\\"DBInstanceId\\\":\\\"rm-2z****\\\",\\\"DBInstanceType\\\":\\\"Master\\\",\\\"NodeId\\\":\\\"rm-2z****-instance-1\\\",\\\"NodeType\\\":\\\"Primary\\\",\\\"Weight\\\":0}]]",
  "ReadOnlyInstanceDistributionType" : "Standard",
  "ReadOnlyInstanceMaxDelayTime" : "30",
  "DbProxyEndpointReadWriteMode" : "ReadWrite",
  "DbProxyEndpointAliases" : "proxyterminal-test",
  "DBProxyEndpointId" : "keaxncrjluwu0gue****",
  "DBProxyConnectStringPort" : "3306",
  "DBProxyConnectString" : "testproxy****.rwlb.rds.aliyuncs.com",
  "DBProxyEngineType" : "normal",
  "EndpointConnectItems" : [ {
    "DbProxyEndpointPort" : "3306",
    "DbProxyEndpointConnectString" : "testproxy****.rwlb.rds.aliyuncs.com",
    "DbProxyEndpointNetType" : "2"
  } ]
}

Kode kesalahan

Kode status HTTPKode kesalahanPesan kesalahanDeskripsi
400InvalidEndPoint.FormatThe specified EndPoint is not valid.Pesan kesalahan yang dikembalikan karena parameter DBProxyEndpointId tidak ditentukan atau ID yang ditentukan oleh parameter DBProxyEndpointId tidak ditemukan.
400InvalidDBInstanceNameSpecified parameter DBInstanceName is not valid.Pesan kesalahan yang dikembalikan karena nilai parameter DBInstanceName tidak valid. Periksa apakah nilainya null atau string kosong.
400Endpoint.NotFoundThe specified EndPoint is not valid.Pesan kesalahan yang dikembalikan karena terminal proksi yang ditentukan tidak ada.
403IncorrectKindCodeThe current KindCode of the custins does not support the operation.Pesan kesalahan yang dikembalikan karena konfigurasi instans tidak mendukung operasi ini. Periksa konfigurasi instans utama.
403IncorrectDBInstanceTypeThe current database instance type does not support the operation.Pesan kesalahan yang dikembalikan karena konfigurasi instans tidak mendukung operasi ini.
404Endpoint.NotFoundSpecified endpoint is not found.Pesan kesalahan yang dikembalikan karena nomor port yang Anda tentukan tidak ditemukan.

Untuk daftar kode kesalahan, kunjungi API Error Center.