DescribeDBClusterHealthStatus API によるクラスター的健康ステータスのクエリ - AnalyticDB - Alibaba Cloud - 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	必須	Enterprise Edition、Basic Edition、または Data Lakehouse Edition クラスターの ID。説明 DescribeDBClusters 操作を呼び出して、クラスターの ID を照会できます。	amv-uf6o6m8p6x7v****
RegionId	string	必須	クラスターのリージョン 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：クラスターは利用不可です。説明インスタンスアクセスノード、エグゼキュータグループ、ワーカーノードグループがすべて NORMAL であり、かつインスタンスが応答している場合にのみ、クラスターの健全性ステータスは NORMAL と見なされます。いずれかのコンポーネントのステータスが RISK の場合、クラスターのステータスは RISK になります。いずれかのコンポーネントのステータスが UNAVAILABLE の場合、クラスターのステータスは UNAVAILABLE になります。	NORMAL
RequestId	string	リクエスト ID。	1AD222E9-E606-4A42-BF6D-8A4442913CAV
AccessDeniedDetail	string	認証失敗の詳細。	Authentication failed.

例

成功レスポンス

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": "Authentication failed."
}

エラーコード

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

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

変更履歴

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