AnalyticDB:DescribeHealthStatus - AnalyticDB

Menanyakan status kesehatan instans AnalyticDB for PostgreSQL dan node-node-nya.

Deskripsi operasi

Operasi ini digunakan untuk menanyakan status kesehatan instans AnalyticDB for PostgreSQL dalam mode elastic storage atau Serverless, serta node coordinator dan compute-nya.

Batasan

Anda dapat memanggil operasi ini hingga 1.000 kali per detik per akun. Jika jumlah panggilan per detik melebihi batas tersebut, Pembatasan kecepatan akan dipicu, yang berpotensi mengganggu bisnis Anda. Kami menyarankan agar Anda memperhatikan batasan ini saat menggunakan operasi ini.

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

gpdb:DescribeHealthStatus

get

*DBInstance

acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}

None

Parameter permintaan

Parameter	Type	Required	Description	Example
DBInstanceId	string	Yes	ID instans. Catatan Anda dapat memanggil operasi DescribeDBInstances untuk menanyakan detail semua instans AnalyticDB for PostgreSQL di wilayah tertentu, termasuk ID instans.	gp-bp12ga6v69h86****
Key	string	Yes	Metrik performa yang ingin Anda tanyakan. Pisahkan beberapa nilai dengan koma (,). Untuk informasi selengkapnya, lihat Parameter performa.	node_master_status,node_master_connection_status,node_segment_connection_status,node_segment_disk_status

Elemen respons

Element	Type	Description	Example
	object
Status	object	Metrik performa yang ditanyakan. Setiap metrik performa terdiri atas nama parameter, status, dan nilai metrik. Informasi metrik hanya dikembalikan untuk parameter performa yang ditentukan oleh Key. Misalnya, jika Anda mengatur Key ke adbpg_status, hanya informasi metrik adbpg_status yang dikembalikan. Untuk informasi selengkapnya tentang parameter performa, lihat Parameter performa.	{"node_master_connection_status":{"Status":"healthy","Value":1.6}}
adbpg_status	object	Informasi status kesehatan instans.
Status	string	Status kesehatan instans. Nilai yang valid: critical: Node coordinator atau salah satu node compute tidak tersedia. Dalam kasus ini, metrik ini ditandai merah di Konsol. healthy: Semua node tersedia. Dalam kasus ini, metrik ini ditandai hijau di Konsol.	healthy
Value	number	Nilai metrik status kesehatan instans. Nilai yang valid: 1: healthy 0: critical	1
adbpg_connection_status	object	Informasi status kesehatan koneksi instans.
Status	string	Status kesehatan koneksi instans. Nilai yang valid: critical: Penggunaan koneksi instans lebih dari 95%. Dalam kasus ini, metrik ini ditandai merah di Konsol. warning: Penggunaan koneksi instans lebih dari 90% dan kurang dari atau sama dengan 95%. Dalam kasus ini, metrik ini ditandai kuning di Konsol. healthy: Penggunaan koneksi instans kurang dari atau sama dengan 90%. Dalam kasus ini, metrik ini ditandai hijau di Konsol. Catatan Penggunaan koneksi instans adalah penggunaan koneksi maksimum di antara semua node coordinator dan compute.	healthy
Value	number	Nilai metrik penggunaan koneksi instans. Unit: %.	1.71
adbpg_disk_status	object	Informasi status penyimpanan instans. Catatan Nilai parameter ini hanya dikembalikan untuk instans dalam mode elastic storage.
Status	string	Status penyimpanan instans. Nilai yang valid: critical: Penggunaan penyimpanan instans lebih dari atau sama dengan 90%. Dalam kasus ini, metrik ini ditandai merah di Konsol dan instans dikunci. warning: Penggunaan penyimpanan instans lebih dari atau sama dengan 70% dan kurang dari 90%. Dalam kasus ini, metrik ini ditandai kuning di Konsol. healthy: Penggunaan penyimpanan instans kurang dari 70%. Dalam kasus ini, metrik ini ditandai hijau di Konsol. Catatan Penggunaan penyimpanan instans adalah rata-rata penggunaan penyimpanan semua node compute.	healthy
Value	number	Nilai metrik penggunaan penyimpanan instans. Unit: %.	1.52
adbpg_disk_usage_percent	object	Informasi penggunaan penyimpanan instans. Catatan Nilai parameter ini hanya dikembalikan untuk instans dalam mode elastic storage.
Status	string	Status yang sesuai dengan penggunaan penyimpanan instans. Nilai yang valid: critical: Penggunaan penyimpanan instans lebih dari atau sama dengan 90%. Dalam kasus ini, instans dikunci. warning: Penggunaan penyimpanan instans lebih dari atau sama dengan 70% dan kurang dari 90%. healthy: Penggunaan penyimpanan instans kurang dari 70%. Catatan Penggunaan penyimpanan instans adalah rata-rata penggunaan penyimpanan semua node compute.	healthy
Value	number	Nilai metrik penggunaan penyimpanan instans. Unit: %.	1.52
adbpg_master_disk_usage_percent_max	object	Informasi penggunaan penyimpanan maksimum node coordinator. Catatan Nilai parameter ini hanya dikembalikan untuk instans dalam mode elastic storage.
Status	string	Status yang sesuai dengan penggunaan penyimpanan maksimum node coordinator. Nilai yang valid: critical: Penggunaan penyimpanan node coordinator lebih dari atau sama dengan 90%. Dalam kasus ini, instans dikunci. warning: Penggunaan penyimpanan node coordinator lebih dari atau sama dengan 70% dan kurang dari 90%. healthy: Penggunaan penyimpanan node coordinator kurang dari 70%.	healthy
Value	number	Nilai metrik penggunaan penyimpanan maksimum node coordinator. Unit: %.	1.34
adbgp_segment_disk_usage_percent_max	object	Informasi penggunaan penyimpanan maksimum node compute. Catatan Nilai parameter ini hanya dikembalikan untuk instans dalam mode elastic storage.
Status	string	Status yang sesuai dengan penggunaan penyimpanan maksimum di antara semua node compute. Nilai yang valid: critical: Penggunaan penyimpanan node compute lebih dari atau sama dengan 90%. Dalam kasus ini, instans dikunci. warning: Penggunaan penyimpanan node compute lebih dari atau sama dengan 80% dan kurang dari 90%. healthy: Penggunaan penyimpanan node compute kurang dari 80%.	healthy
Value	number	Nilai metrik penggunaan penyimpanan maksimum node compute. Unit: %.	1.52
node_master_status	object	Informasi status kesehatan node coordinator.
Status	string	Status kesehatan node coordinator. Nilai yang valid: critical: Node coordinator primary atau standby tidak tersedia. Dalam kasus ini, metrik ini ditandai merah di Konsol. healthy: Node coordinator primary dan standby keduanya tersedia. Dalam kasus ini, metrik ini ditandai hijau di Konsol.	healthy
Value	number	Nilai metrik status kesehatan node coordinator. Nilai yang valid: 1: healthy 0: critical	1
node_segment_disk_status	object	Informasi status penyimpanan node compute. Catatan Nilai parameter ini hanya dikembalikan untuk instans dalam mode elastic storage.
Status	string	Status penyimpanan node compute. Nilai yang valid: critical: Penggunaan penyimpanan node compute lebih dari atau sama dengan 90%. Dalam kasus ini, metrik ini ditandai merah di Konsol dan instans dikunci. warning: Penggunaan penyimpanan node compute lebih dari atau sama dengan 80% dan kurang dari 90%. Dalam kasus ini, metrik ini ditandai kuning di Konsol. healthy: Penggunaan penyimpanan node compute kurang dari 80%. Dalam kasus ini, metrik ini ditandai hijau di Konsol. Catatan Penggunaan penyimpanan node compute adalah penggunaan penyimpanan maksimum di antara semua node compute.	healthy
Value	number	Nilai metrik penggunaan penyimpanan maksimum node compute. Unit: %.	1.52
node_master_connection_status	object	Informasi status kesehatan koneksi node coordinator.
Status	string	Status kesehatan koneksi node coordinator. Nilai yang valid: critical: Penggunaan koneksi node coordinator lebih dari 95%. Dalam kasus ini, metrik ini ditandai merah di Konsol. warning: Penggunaan koneksi node coordinator lebih dari atau sama dengan 90% dan kurang dari 95%. Dalam kasus ini, metrik ini ditandai kuning di Konsol. healthy: Penggunaan koneksi node coordinator kurang dari 90%. Dalam kasus ini, metrik ini ditandai hijau di Konsol. Catatan Penggunaan koneksi node coordinator adalah penggunaan koneksi maksimum node coordinator.	healthy
Value	number	Nilai metrik penggunaan koneksi node coordinator. Unit: %.	1.71
node_segment_connection_status	object	Informasi status kesehatan koneksi node compute.
Status	string	Status kesehatan koneksi node compute. Nilai yang valid: critical: Penggunaan koneksi node compute lebih dari atau sama dengan 95%. Dalam kasus ini, metrik ini ditandai merah di Konsol. warning: Penggunaan koneksi node compute lebih dari atau sama dengan 90% dan kurang dari 95%. Dalam kasus ini, metrik ini ditandai kuning di Konsol. healthy: Penggunaan koneksi node compute kurang dari 90%. Dalam kasus ini, metrik ini ditandai hijau di Konsol. Catatan Penggunaan koneksi node compute adalah penggunaan koneksi maksimum di antara semua node compute.	healthy
Value	number	Nilai metrik penggunaan koneksi maksimum node compute. Unit: %.	0.48
adbpg_master_status	object	Informasi status ketersediaan node coordinator.
Status	string	Status ketersediaan node coordinator. Nilai yang valid: critical: Node coordinator primary dan standby keduanya tidak tersedia. Dalam kasus ini, metrik ini ditandai merah di Konsol. warning: Node coordinator primary atau standby tidak tersedia. Dalam kasus ini, metrik ini ditandai kuning di Konsol. healthy: Node coordinator primary dan standby keduanya tersedia. Dalam kasus ini, metrik ini ditandai hijau di Konsol.	healthy
Value	number	Nilai metrik status ketersediaan node coordinator. Nilai yang valid:	1
adbpg_segment_status	object	Informasi status ketersediaan node compute.
Status	string	Status ketersediaan node compute. Nilai yang valid: critical: Semua node compute primary dan secondary tidak tersedia. Dalam kasus ini, metrik ini ditandai merah di Konsol. warning: Lima puluh persen atau lebih node compute tidak tersedia. Dalam kasus ini, metrik ini ditandai kuning di Konsol. healthy: Semua node compute tersedia. Dalam kasus ini, metrik ini ditandai hijau di Konsol.	healthy
Value	number	Nilai metrik status ketersediaan node compute.	1
adbpg_instance_total_data_gb	object	Jumlah total penyimpanan data instans.
Value	number	Jumlah total penyimpanan data instans. Unit: GB.	4.1
adbpg_instance_hot_data_gb	object	Jumlah total penyimpanan data hot.
Value	number	Jumlah total penyimpanan data hot. Unit: GB.	4.1
adbpg_instance_cold_data_gb	object	Jumlah total penyimpanan data cold.
Value	number	Jumlah total penyimpanan data cold. Unit: GB.	0
RequestId	string	ID permintaan.	D97B4191-104D-10CE-8BC5-53**********
DBClusterId	string	ID instans.	gp-bp12ga6v69h86****

Contoh

Respons sukses

JSONformat

{
  "Status": {
    "adbpg_status": {
      "Status": "healthy",
      "Value": 1
    },
    "adbpg_connection_status": {
      "Status": "healthy",
      "Value": 1.71
    },
    "adbpg_disk_status": {
      "Status": "healthy",
      "Value": 1.52
    },
    "adbpg_disk_usage_percent": {
      "Status": "healthy",
      "Value": 1.52
    },
    "adbpg_master_disk_usage_percent_max": {
      "Status": "healthy",
      "Value": 1.34
    },
    "adbgp_segment_disk_usage_percent_max": {
      "Status": "healthy",
      "Value": 1.52
    },
    "node_master_status": {
      "Status": "healthy",
      "Value": 1
    },
    "node_segment_disk_status": {
      "Status": "healthy",
      "Value": 1.52
    },
    "node_master_connection_status": {
      "Status": "healthy",
      "Value": 1.71
    },
    "node_segment_connection_status": {
      "Status": "healthy",
      "Value": 0.48
    },
    "adbpg_master_status": {
      "Status": "healthy",
      "Value": 1
    },
    "adbpg_segment_status": {
      "Status": "healthy",
      "Value": 1
    },
    "adbpg_instance_total_data_gb": {
      "Value": 4.1
    },
    "adbpg_instance_hot_data_gb": {
      "Value": 4.1
    },
    "adbpg_instance_cold_data_gb": {
      "Value": 0
    }
  },
  "RequestId": "D97B4191-104D-10CE-8BC5-53**********",
  "DBClusterId": "gp-bp12ga6v69h86****"
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.