All Products
Search
Document Center

AnalyticDB:DescribeDBClusterHealthStatus

Last Updated:Jun 11, 2026

Melihat status kesehatan kluster.

Deskripsi operasi

For the service access address, see service endpoint.

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

adb:DescribeDBClusterHealthStatus

list

*DBClusterLakeVersion

acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}

None None

Parameter permintaan

Parameter

Type

Required

Description

Example

DBClusterId

string

Yes

ID kluster Edisi Danau Data Terpadu.

Catatan

Anda dapat memanggil operasi DescribeDBClusters untuk mengkueri ID kluster.

amv-uf6o6m8p6x7v****

RegionId

string

Yes

ID wilayah kluster.

Catatan

Anda dapat memanggil operasi DescribeRegions untuk mengkueri daftar wilayah terbaru.

cn-hangzhou

Elemen respons

Element

Type

Description

Example

object

CS

object

The health status of the instance access nodes.

ActiveCount

integer

The number of healthy instance access nodes.

0

UnavailableCount

integer

The number of unavailable instance access nodes.

1

RiskCount

integer

The number of instance access nodes at risk.

0

ExpectedCount

integer

The total number of instance access nodes.

1

Status

string

The health status of the instance access nodes. Valid values:

  • RISK: The instance access nodes are at risk.

  • NORMAL: The instance access nodes are healthy.

  • UNAVAILABLE: The instance access nodes are unavailable.

UNAVAILABLE

Executor

object

The health status of the executor groups.

ActiveCount

integer

The number of healthy executor nodes.

0

UnavailableCount

integer

The number of unavailable executor nodes.

1

RiskCount

integer

The number of executor nodes at risk.

0

ExpectedCount

integer

The total number of executor nodes.

1

Status

string

The health status of the executor groups. Valid values:

  • RISK: The executor groups are at risk.

  • NORMAL: The executor groups are healthy.

  • UNAVAILABLE: The executor groups are unavailable.

UNAVAILABLE

Worker

object

The health status of the worker node groups.

ActiveCount

integer

The number of healthy worker node groups.

0

UnavailableCount

integer

The number of unavailable worker node groups.

1

RiskCount

integer

The number of worker node groups at risk.

1

ExpectedCount

integer

The total number of worker node groups.

1

Status

string

The health status of the worker node groups. Valid values:

  • RISK: The worker node groups are at risk.

  • NORMAL: The worker node groups are healthy.

  • UNAVAILABLE: The worker node groups are unavailable.

UNAVAILABLE

InstanceStatus

string

The health status of the cluster. Valid values:

  • RISK: The cluster is at risk.

  • NORMAL: The cluster is healthy.

  • UNAVAILABLE: The cluster is unavailable.

Catatan

The cluster health status is considered NORMAL only if the instance access nodes, executor groups, and worker node groups are all NORMAL, and the instance is responsive. If any of these components has a RISK status, the cluster status is RISK. If any component has an UNAVAILABLE status, the cluster status is UNAVAILABLE.

NORMAL

RequestId

string

The request ID.

1AD222E9-E606-4A42-BF6D-8A4442913CAV

AccessDeniedDetail

string

Details of the authentication failure.

Authentication failed.

Contoh

Respons sukses

JSONformat

{
  "CS": {
    "ActiveCount": 0,
    "UnavailableCount": 1,
    "RiskCount": 0,
    "ExpectedCount": 1,
    "Status": "UNAVAILABLE"
  },
  "Executor": {
    "ActiveCount": 0,
    "UnavailableCount": 1,
    "RiskCount": 0,
    "ExpectedCount": 1,
    "Status": "UNAVAILABLE"
  },
  "Worker": {
    "ActiveCount": 0,
    "UnavailableCount": 1,
    "RiskCount": 1,
    "ExpectedCount": 1,
    "Status": "UNAVAILABLE"
  },
  "InstanceStatus": "NORMAL",
  "RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CAV",
  "AccessDeniedDetail": "Authentication failed."
}

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.