Kueri pengaturan proksi - - Alibaba Cloud Documentation Center

Anda dapat memanggil operasi DescribeDBProxy untuk mengkueri pengaturan proksi database pada instans ApsaraDB RDS.

Sebelum memanggil operasi DescribeDBProxy, pastikan Anda telah memanggil operasi ModifyDBProxy untuk mengaktifkan fitur proksi database 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 proksi database 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 untuk berbagai SDK.

Parameter permintaan

Parameter	Type	Wajib	Contoh	Deskripsi
Action	String	Ya	DescribeDBProxy	Operasi yang ingin Anda lakukan. Tetapkan nilainya ke DescribeDBProxy.
DBInstanceId	String	Ya	rm-bp1ja4f56s7us****	ID instans. Anda dapat memanggil operasi DescribeDBInstances untuk mengkueri ID instans tersebut.
RegionId	String	Tidak	cn-hangzhou	ID wilayah instans. Anda dapat memanggil operasi DescribeRegions untuk mengkueri daftar wilayah terbaru.
DBProxyEngineType	String	Tidak	normal	Parameter internal. Anda tidak perlu menentukan parameter ini.
ResourceGroupId	String	Tidak	rg-acfmy*****	ID kelompok sumber daya.

Parameter respons

Parameter	Type	Contoh	Deskripsi
DBProxyInstanceLatestMinorVersion	String	1.13.12	Versi proksi terbaru yang tersedia untuk instans.
RequestId	String	909A69EE-71C8-4417-A0B9-FF085407E1E3	ID permintaan.
DBProxyInstanceCurrentMinorVersion	String	1.13.11	Versi proksi yang sedang dijalankan oleh instans.
DBProxyInstanceNum	Integer	1	Jumlah proksi yang diaktifkan pada instans.
DBProxyInstanceType	String	2	Tipe database proxy yang diaktifkan pada instans. Nilai yang valid: 1: shared proxy 2: dedicated proxy Catatan Instans ApsaraDB RDS for PostgreSQL hanya mendukung dedicated proxy.
DBProxyInstanceStatus	String	Running	Status instans proksi. Nilai yang valid: Creating: Instans proksi sedang dibuat. Running: Instans proksi sedang berjalan. DBInstanceClassChanging: Spesifikasi instans proksi sedang diubah. Deleting: Instans proksi sedang dihapus.
DBProxyServiceStatus	String	Startup	Status fitur database proxy. Nilai yang valid: Startup: diaktifkan Shutdown: dinonaktifkan
DBProxyInstanceName	String	gos787jog2wk0ye1****	Nama instans proksi.
DBProxyInstanceSize	String	4/8	Spesifikasi instans proksi. Parameter ini hanya tersedia untuk instans ApsaraDB RDS for PostgreSQL. Format: Jumlah core/Kapasitas memori. Misalnya, nilai 4/8 menunjukkan bahwa instans proksi memiliki 4 core dan memori 8 GB.
DBProxyEngineType	String	normal	Parameter internal. Anda tidak perlu menentukan parameter ini.
DBProxyConnectStringItems	Array of DBProxyConnectStringItems		Array yang berisi informasi tentang titik akhir proksi yang dibuat untuk instans.
DBProxyConnectStringItems
DBProxyConnectStringNetWorkType	String	2	Jenis jaringan database proxy. Nilai yang valid: 0: Internet 1: jaringan klasik 2: virtual private cloud (VPC)
DBProxyConnectStringNetType	String	InnerString	Jenis jaringan titik akhir proksi. Nilai yang valid: InnerString: jaringan internal OuterString: Internet
DBProxyVpcInstanceId	String	rm-bp145737x5**131161274792**	ID instans proksi.
DBProxyEndpointName	String	gos787jog2wk0ye1****	Nama terminal proksi tempat titik akhir proksi berada.
DBProxyEndpointId	String	20****	ID terminal proksi tempat titik akhir proksi berada.
DBProxyConnectStringPort	String	3306	Nomor port yang terkait dengan titik akhir proksi.
DBProxyConnectString	String	gos787jog2wk0ye1****-rw4rm.rwlb.rds.aliyuncs.com	Titik akhir terminal proksi.
DbProxyEndpointItems	Array of DbProxyEndpointItems		Array yang berisi informasi tentang terminal proksi.
DbProxyEndpointItems
DbProxyEndpointAliases	String	proxy-test	Deskripsi terminal proksi.
DbProxyEndpointName	String	gos787jog2wk0ye1****	ID terminal proksi.
DbProxyEndpointType	String	RWSplit	Tipe terminal proksi. Nilai yang valid: RWSplit: terminal proksi default Custom: terminal proksi kustom
DbProxyReadWriteMode	String	ReadWrite	Atribut baca dan tulis terminal proksi. ReadWrite: Terminal proksi mendukung permintaan baca dan tulis. ReadOnly: Terminal proksi hanya mendukung permintaan baca.
ResourceGroupId	String	rg-acfmy*****	ID kelompok sumber daya.

Contoh

Permintaan Contoh

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

Respons Sukses Contoh

XML format

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

<DescribeDBProxyResponse>
    <DBProxyInstanceName>gos787jog2wk0ye1****</DBProxyInstanceName>
    <DBProxyInstanceCurrentMinorVersion>1.13.11</DBProxyInstanceCurrentMinorVersion>
    <DBProxyServiceStatus>Startup</DBProxyServiceStatus>
    <DBProxyInstanceNum>1</DBProxyInstanceNum>
    <DBProxyInstanceLatestMinorVersion>1.13.12</DBProxyInstanceLatestMinorVersion>
    <RequestId>909A69EE-71C8-4417-A0B9-FF085407E1E3</RequestId>
    <DbProxyEndpointItems>
        <DbProxyEndpointItems>
            <DbProxyEndpointName>gos787jog2wk0ye1****</DbProxyEndpointName>
            <DbProxyEndpointAliases>proxy-test</DbProxyEndpointAliases>
            <DbProxyEndpointType>RWSplit</DbProxyEndpointType>
            <DbProxyReadWriteMode>ReadWrite</DbProxyReadWriteMode>
        </DbProxyEndpointItems>
    </DbProxyEndpointItems>
    <DBProxyConnectStringItems>
        <DBProxyConnectStringItems>
            <DBProxyConnectString>gos787jog2wk0ye1****-rw4rm.rwlb.rds.aliyuncs.com</DBProxyConnectString>
            <DBProxyEndpointId>209090</DBProxyEndpointId>
            <DBProxyEndpointName>gos787jog2wk0ye1****</DBProxyEndpointName>
            <DBProxyConnectStringNetWorkType>2</DBProxyConnectStringNetWorkType>
            <DBProxyConnectStringNetType>InnerString</DBProxyConnectStringNetType>
            <DBProxyConnectStringPort>3306</DBProxyConnectStringPort>
            <DBProxyVpcInstanceId>rm-bp145737x5****131161274792****</DBProxyVpcInstanceId>
        </DBProxyConnectStringItems>
    </DBProxyConnectStringItems>
    <DBProxyInstanceStatus>Running</DBProxyInstanceStatus>
    <DBProxyInstanceType>2</DBProxyInstanceType>
</DescribeDBProxyResponse>

JSON format

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

{
  "DBProxyInstanceName" : "gos787jog2wk0ye1****",
  "DBProxyInstanceCurrentMinorVersion" : "1.13.11",
  "DBProxyServiceStatus" : "Startup",
  "DBProxyInstanceNum" : 1,
  "DBProxyInstanceLatestMinorVersion" : "1.13.12",
  "RequestId" : "909A69EE-71C8-4417-A0B9-FF085407E1E3",
  "DbProxyEndpointItems" : {
    "DbProxyEndpointItems" : [ {
      "DbProxyEndpointName" : "gos787jog2wk0ye1****",
      "DbProxyEndpointAliases" : "proxy-test",
      "DbProxyEndpointType" : "RWSplit",
      "DbProxyReadWriteMode" : "ReadWrite"
    } ]
  },
  "DBProxyConnectStringItems" : {
    "DBProxyConnectStringItems" : [ {
      "DBProxyConnectString" : "gos787jog2wk0ye1****-rw4rm.rwlb.rds.aliyuncs.com",
      "DBProxyEndpointId" : 209090,
      "DBProxyEndpointName" : "gos787jog2wk0ye1****",
      "DBProxyConnectStringNetWorkType" : 2,
      "DBProxyConnectStringNetType" : "InnerString",
      "DBProxyConnectStringPort" : "3306",
      "DBProxyVpcInstanceId" : "rm-bp145737x5****131161274792****"
    } ]
  },
  "DBProxyInstanceStatus" : "Running",
  "DBProxyInstanceType" : "2"
}

Kode kesalahan

Kode status HTTP	Kode kesalahan	Pesan kesalahan	Deskripsi
400	InvalidDBInstanceName	Specified parameter DBInstanceName is not valid.	Pesan kesalahan yang dikembalikan karena nilai parameter DBInstanceName tidak valid. Periksa apakah nilainya null atau string kosong.
403	IncorrectKindCode	Current custins kindCode does not support this operation.	Pesan kesalahan yang dikembalikan karena konfigurasi instans tidak mendukung operasi ini. Periksa konfigurasi instans tersebut.
403	IncorrectDBInstanceType	The database instance type does not support the operation.	Pesan kesalahan yang dikembalikan karena mesin database yang dijalankan pada instans tidak mendukung operasi ini.

Untuk daftar kode kesalahan, kunjungi API Error Center.