DescribeDBClusterHealthStatus - AnalyticDB - Alibaba Cloud ドキュメントセンター

AnalyticDB for MySQL Data Warehouse Edition (V3.0) クラスターの健全性ステータスを照会します。

今すぐお試しください

この 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

get

*DBCluster

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
DBClusterId	string	必須	AnalyticDB for MySQL Data Warehouse Edition (V3.0) クラスターの ID です。説明 DescribeDBClusters 操作を呼び出して、特定のリージョン内にあるすべての AnalyticDB for MySQL Data Warehouse Edition (V3.0) クラスターの ID を照会できます。	am-bp1d8lbdj22rx****
RegionId	string	必須	リージョンの ID です。説明 DescribeRegions 操作を呼び出して、最新のリージョン一覧を照会できます。	cn-hangzhou

レスポンスフィールド

フィールド	型	説明	例
	object
CS	object	アクセスノードのヘルスステータスの詳細。
ActiveCount	integer	正常なアクセスノードの数。	2
UnavailableCount	integer	利用不可のアクセスノード数。	0
RiskCount	integer	リスクのあるアクセスノードの数。	0
ExpectedCount	integer	アクセスノードの合計数です。	2
Status	string	アクセストレーニングノードの健全性ステータスです。有効な値は以下のとおりです。 RISK: リスクあり NORMAL: 健全 UNAVAILABLE: 利用不可	NORMAL
Executor	object	コンピュートノードグループの健全性ステータス詳細です。
ActiveCount	integer	健全なコンピュートノードグループの数です。	2
UnavailableCount	integer	利用不可なコンピュートノードグループの数です。	0
RiskCount	integer	リスクのあるコンピュートノードグループの数です。	0
ExpectedCount	integer	コンピュートノードグループの合計数です。	2
Status	string	コンピュートノードグループの健全性ステータスです。有効な値は以下のとおりです。 RISK: リスクあり NORMAL: 健全 UNAVAILABLE: 利用不可	NORMAL
Worker	object	ストレージノードグループの健全性ステータス詳細です。
ActiveCount	integer	健全なストレージノードグループの数です。	2
UnavailableCount	integer	利用不可なストレージノードグループの数です。	0
RiskCount	integer	リスクのあるストレージノードグループの数です。	0
ExpectedCount	integer	ストレージノードグループの合計数です。	2
Status	string	ストレージノードグループの健全性ステータスです。有効な値は以下のとおりです。 RISK: リスクあり NORMAL: 健全 UNAVAILABLE: 利用不可	NORMAL
InstanceStatus	string	クラスター全体の健全性ステータスです。有効な値は以下のとおりです。 RISK: リスクあり NORMAL: 健全 UNAVAILABLE: 利用不可説明アクセストレーニングノード、コンピュートノードグループ、およびストレージノードグループの健全性ステータスがすべて健全であり、かつクラスターが正常に検出された場合、クラスターの健全性ステータスは健全となります。上記 3 つの健全性ステータスのいずれかにリスクありが含まれる場合、クラスターの健全性ステータスはリスクありとなります。また、いずれかに利用不可が含まれる場合、クラスターの健全性ステータスは利用不可となります。	NORMAL
RequestId	string	リクエストの ID です。	1AD222E9-E606-4A42-BF6D-8A4442913CEA

例

成功レスポンス

JSONJSON

{
  "CS": {
    "ActiveCount": 2,
    "UnavailableCount": 0,
    "RiskCount": 0,
    "ExpectedCount": 2,
    "Status": "NORMAL"
  },
  "Executor": {
    "ActiveCount": 2,
    "UnavailableCount": 0,
    "RiskCount": 0,
    "ExpectedCount": 2,
    "Status": "NORMAL"
  },
  "Worker": {
    "ActiveCount": 2,
    "UnavailableCount": 0,
    "RiskCount": 0,
    "ExpectedCount": 2,
    "Status": "NORMAL"
  },
  "InstanceStatus": "NORMAL",
  "RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEA"
}

エラーコード

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

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

変更履歴

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