All Products
Search
Document Center

PolarDB:DescribeDBClusterProxy

Last Updated:Jun 10, 2026

Mengkueri proxy cluster database.

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

polardb:DescribeDBClusterProxy

get

*DBCluster

acs:polardb:{#regionId}:{#accountId}:dbcluster/{#DbClusterId}

None None

Parameter permintaan

Parameter

Type

Required

Description

Example

DBClusterId

string

Yes

ID cluster.

pc-2zek76tdi709m6mf4

RegionId

string

No

ID region.

Catatan

Untuk informasi lebih lanjut, lihat DescribeRegions.

cn-hangzhou

ResourceGroupId

string

No

ID grup sumber daya.

rg-acfm4ifnqnun3zq

Elemen respons

Element

Type

Description

Example

object

ChildInstances

array<object>

Daftar instance jaringan yang dimuat oleh instance Cloud Enterprise Network (CEN).

object

Detail dari instance jaringan.

DBNodeClass

string

Spesifikasi node. Untuk informasi lebih lanjut, lihat dokumen berikut:

polar.mysql.g4.medium

DBNodeIP

string

Alamat IP privat dari node cluster database.

10.*.*10

DBNodeId

string

ID dari node cluster database.

pi-wz97h479y364g9du7

DBNodePort

string

Port dari node cluster database.

2450

DBNodeStatus

string

Status node. Nilai yang valid:

  • Creating: Node sedang dibuat.

  • Running: Node sedang berjalan.

  • Deleting: Node sedang dihapus.

  • Rebooting: Node sedang dimulai ulang.

  • DBNodeCreating: Sebuah node sedang ditambahkan.

  • DBNodeDeleting: Sebuah node sedang dihapus.

  • ClassChanging: Spesifikasi node sedang diubah.

  • NetAddressCreating: Koneksi jaringan sedang dibuat.

  • NetAddressDeleting: Koneksi jaringan sedang dihapus.

  • NetAddressModifying: Koneksi jaringan sedang dimodifikasi.

  • MinorVersionUpgrading: Versi minor sedang ditingkatkan.

  • Maintaining: Instance sedang dalam pemeliharaan.

  • Switching: Switchover sedang berlangsung.

Running

HostName

string

Nama host.

sh-lsf01-144-37

DBProxyClusterId

string

ID cluster proxy.

pe-xxxxxxxxx

DBProxyClusterNum

integer

Jumlah node proxy.

2

DBProxyClusterStatus

string

Status cluster proxy.

ClassChanging

RequestId

string

ID permintaan.

30E11ED2-C922-5B96-BCC6-11EE8C484AC6

Contoh

Respons sukses

JSONformat

{
  "ChildInstances": [
    {
      "DBNodeClass": "polar.mysql.g4.medium",
      "DBNodeIP": "10.*.*10",
      "DBNodeId": "pi-wz97h479y364g9du7",
      "DBNodePort": "2450",
      "DBNodeStatus": "Running",
      "HostName": "sh-lsf01-144-37"
    }
  ],
  "DBProxyClusterId": "pe-xxxxxxxxx",
  "DBProxyClusterNum": 2,
  "DBProxyClusterStatus": "ClassChanging",
  "RequestId": "30E11ED2-C922-5B96-BCC6-11EE8C484AC6"
}

Kode kesalahan

HTTP status code

Error code

Error message

Description

404 InvalidDBCluster.NotFound The DBClusterId provided does not exist in our records.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.