DescribeDBClusterHealthStatus API によるクラスター的健康ステータスのクエリ - AnalyticDB

クラスターのヘルスステータスを表示します。

操作説明

サービスエンドポイントの詳細については、「サービスエンドポイント」をご参照ください。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

adb:DescribeDBClusterHealthStatus

list

*DBClusterLakeVersion

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
DBClusterId	string	必須	クラスターの ID。Enterprise Edition、Basic Edition、または Data Lakehouse Edition のクラスターに適用されます。説明クラスター ID を表示するには、DescribeDBClusters 操作を呼び出します。	amv-uf6o6m8p6x7v****
RegionId	string	必須	リージョンの ID。説明リージョン ID を表示するには、DescribeRegions 操作を呼び出します。	cn-hangzhou

レスポンスフィールド

フィールド	型	説明	例
	object
CS	object	インスタンスのアクセスノードのステータスのリスト。
ActiveCount	integer	正常なノードの数。	0
UnavailableCount	integer	利用不可なノードの数。	1
RiskCount	integer	リスクのあるノードの数。	0
ExpectedCount	integer	アクセスノードの総数。	1
Status	string	インスタンスのアクセスノードのステータス。有効な値： RISK：リスクあり。 NORMAL：正常。 UNAVAILABLE：利用不可。	UNAVAILABLE
Executor	object	計算ノードグループのヘルスステータスのリスト。
ActiveCount	integer	正常なノードの数。	0
UnavailableCount	integer	利用不可なノードの数。	1
RiskCount	integer	リスクのあるノードの数。	0
ExpectedCount	integer	計算ノードの総数。	1
Status	string	計算ノードグループのヘルスステータス。有効な値： RISK：リスクあり。 NORMAL：正常。 UNAVAILABLE：利用不可。	UNAVAILABLE
Worker	object	ストレージノードのヘルスステータスのリスト。
ActiveCount	integer	正常なストレージノードグループの数。	0
UnavailableCount	integer	利用不可なストレージノードグループの数。	1
RiskCount	integer	リスクのあるストレージノードグループの数。	1
ExpectedCount	integer	ストレージノードグループの総数。	1
Status	string	ストレージノードグループのヘルスステータス。有効な値： RISK：リスクあり。 NORMAL：正常。 UNAVAILABLE：利用不可。	UNAVAILABLE
InstanceStatus	string	クラスターのヘルスステータス。有効な値： RISK：リスクあり。 NORMAL：正常。 UNAVAILABLE：利用不可。説明インスタンスのアクセスノードのステータス、計算ノードグループのステータス、ストレージノードグループのステータスの 3 つのコンポーネントのステータスがすべて NORMAL であり、インスタンスの生存性チェックが成功した場合にのみ、クラスターのヘルスステータスは NORMAL になります。いずれかのコンポーネントのステータスが RISK の場合、クラスターのヘルスステータスは RISK になります。いずれかのコンポーネントのステータスが UNAVAILABLE の場合、クラスターのヘルスステータスは UNAVAILABLE になります。	NORMAL
RequestId	string	リクエストの ID。	1AD222E9-E606-4A42-BF6D-8A4442913CAV
AccessDeniedDetail	string

例

成功レスポンス

JSONJSON

{
  "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": ""
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.	The DBClusterId provided does not exist in our records.

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。