AnalyticDB:DescribeHealthStatus - AnalyticDB

AnalyticDB for PostgreSQL インスタンスおよびそのノードの健全性ステータスを照会します。

操作説明

この操作は、弾力的ストレージモードまたはサーバーレスモードで実行中の AnalyticDB for PostgreSQL インスタンス、およびそのコーディネーターおよびコンピュートノードの健全性ステータスを照会するために呼び出されます。

使用制限

アカウントあたり、1 秒間に最大 1,000 回までこの操作を呼び出すことができます。1 秒あたりの呼び出し回数がこの上限を超えると、速度制限が適用され、ご利用の業務に影響を及ぼす可能性があります。本操作を呼び出す際には、この制限を十分にご確認ください。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

gpdb:DescribeHealthStatus

get

*DBInstance

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
DBInstanceId	string	必須	インスタンスの ID です。説明すべての AnalyticDB for PostgreSQL インスタンス（インスタンス ID を含む）の詳細を特定のリージョンで照会するには、「DescribeDBInstances」操作を呼び出してください。	gp-bp12ga6v69h86****
Key	string	必須	照会対象のパフォーマンスメトリックです。複数指定する場合は、カンマ (,) で区切ります。「パフォーマンスパラメーター」をご参照ください。	node_master_status,node_master_connection_status,node_segment_connection_status,node_segment_disk_status

レスポンスフィールド

フィールド	型	説明	例
	object
Status	object	照会されたパフォーマンスメトリクスです。各メトリックは、パラメーター名、ステータス、およびメトリック値で構成されます。Key で指定したパフォーマンスパラメーターのみのメトリック情報が返されます。たとえば、Key を adbpg_status に設定した場合、adbpg_status のみのメトリック情報が返されます。パフォーマンスパラメーターの詳細については、「パフォーマンスパラメーター」をご参照ください。	{"node_master_connection_status":{"Status":"healthy","Value":1.6}}
adbpg_status	object	インスタンスの健全性ステータスに関する情報です。
Status	string	インスタンスの健全性ステータスです。有効な値は以下のとおりです。 critical：コーディネーターまたはコンピュートノードが利用不可です。この場合、コンソール上で該当メトリックが赤色で表示されます。 healthy：すべてのノードが利用可能です。この場合、コンソール上で該当メトリックが緑色で表示されます。	healthy
Value	number	インスタンスの健全性ステータスのメトリック値です。有効な値は以下のとおりです。 1：healthy 0：critical	1
adbpg_connection_status	object	インスタンスの接続健全性ステータスに関する情報です。
Status	string	インスタンスの接続健全性ステータスです。有効な値は以下のとおりです。 critical：インスタンスの接続使用率が 95 % を超えています。この場合、コンソール上で該当メトリックが赤色で表示されます。 warning：インスタンスの接続使用率が 90 % 以上 95 % 以下です。この場合、コンソール上で該当メトリックが黄色で表示されます。 healthy：インスタンスの接続使用率が 90 % 以下です。この場合、コンソール上で該当メトリックが緑色で表示されます。説明インスタンスの接続使用率は、すべてのコーディネーターおよびコンピュートノードにおける最大接続使用率です。	healthy
Value	number	インスタンスの接続使用率のメトリック値です。単位：％。	1.71
adbpg_disk_status	object	インスタンスのストレージステータスに関する情報です。説明このパラメーター値は、弾力的ストレージモードのインスタンスに対してのみ返されます。
Status	string	インスタンスのストレージステータスです。有効な値は以下のとおりです。 critical：インスタンスのストレージ使用率が 90 % 以上です。この場合、コンソール上で該当メトリックが赤色で表示され、インスタンスはロックされます。 warning：インスタンスのストレージ使用率が 70 % 以上 90 % 未満です。この場合、コンソール上で該当メトリックが黄色で表示されます。 healthy：インスタンスのストレージ使用率が 70 % 未満です。この場合、コンソール上で該当メトリックが緑色で表示されます。説明インスタンスのストレージ使用率は、すべてのコンピュートノードにおける平均ストレージ使用率です。	healthy
Value	number	インスタンスのストレージ使用率のメトリック値です。単位：％。	1.52
adbpg_disk_usage_percent	object	インスタンスのストレージ使用量に関する情報です。説明このパラメーター値は、弾力的ストレージモードのインスタンスに対してのみ返されます。
Status	string	インスタンスのストレージ使用量に対応するステータスです。有効な値は以下のとおりです。 critical：インスタンスのストレージ使用率が 90 % 以上です。この場合、インスタンスはロックされます。 warning：インスタンスのストレージ使用率が 70 % 以上 90 % 未満です。 healthy：インスタンスのストレージ使用率が 70 % 未満です。説明インスタンスのストレージ使用率は、すべてのコンピュートノードにおける平均ストレージ使用率です。	healthy
Value	number	インスタンスのストレージ使用量のメトリック値です。単位：％。	1.52
adbpg_master_disk_usage_percent_max	object	コーディネーターの最大ストレージ使用率に関する情報です。説明このパラメーター値は、弾力的ストレージモードのインスタンスに対してのみ返されます。
Status	string	コーディネーターの最大ストレージ使用率に対応するステータスです。有効な値は以下のとおりです。 critical：コーディネーターのストレージ使用率が 90 % 以上です。この場合、インスタンスはロックされます。 warning：コーディネーターのストレージ使用率が 70 % 以上 90 % 未満です。 healthy：コーディネーターのストレージ使用率が 70 % 未満です。	healthy
Value	number	コーディネーターの最大ストレージ使用率のメトリック値です。単位：％。	1.34
adbgp_segment_disk_usage_percent_max	object	コンピュートノードの最大ストレージ使用率に関する情報です。説明このパラメーター値は、弾力的ストレージモードのインスタンスに対してのみ返されます。
Status	string	すべてのコンピュートノードにおける最大ストレージ使用率に対応するステータスです。有効な値は以下のとおりです。 critical：コンピュートノードのストレージ使用率が 90 % 以上です。この場合、インスタンスはロックされます。 warning：コンピュートノードのストレージ使用率が 80 % 以上 90 % 未満です。 healthy：コンピュートノードのストレージ使用率が 80 % 未満です。	healthy
Value	number	コンピュートノードの最大ストレージ使用率のメトリック値です。単位：％。	1.52
node_master_status	object	コーディネーターの健全性ステータスに関する情報です。
Status	string	コーディネーターの健全性ステータスです。有効な値は以下のとおりです。 critical：プライマリーまたはスタンバイのコーディネーターが利用不可です。この場合、コンソール上で該当メトリックが赤色で表示されます。 healthy：プライマリーおよびスタンバイの両方のコーディネーターが利用可能です。この場合、コンソール上で該当メトリックが緑色で表示されます。	healthy
Value	number	コーディネーターの健全性ステータスのメトリック値です。有効な値は以下のとおりです。 1：healthy 0：critical	1
node_segment_disk_status	object	コンピュートノードのストレージステータスに関する情報です。説明このパラメーター値は、弾力的ストレージモードのインスタンスに対してのみ返されます。
Status	string	コンピュートノードのストレージステータスです。有効な値は以下のとおりです。 critical：コンピュートノードのストレージ使用率が 90 % 以上です。この場合、コンソール上で該当メトリックが赤色で表示され、インスタンスはロックされます。 warning：コンピュートノードのストレージ使用率が 80 % 以上 90 % 未満です。この場合、コンソール上で該当メトリックが黄色で表示されます。 healthy：コンピュートノードのストレージ使用率が 80 % 未満です。この場合、コンソール上で該当メトリックが緑色で表示されます。説明コンピュートノードのストレージ使用率は、すべてのコンピュートノードにおける最大ストレージ使用率です。	healthy
Value	number	コンピュートノードの最大ストレージ使用率のメトリック値です。単位：％。	1.52
node_master_connection_status	object	コーディネーターの接続健全性ステータスに関する情報です。
Status	string	コーディネーターの接続健全性ステータスです。有効な値は以下のとおりです。 critical：コーディネーターの接続使用率が 95 % を超えています。この場合、コンソール上で該当メトリックが赤色で表示されます。 warning：コーディネーターの接続使用率が 90 % 以上 95 % 未満です。この場合、コンソール上で該当メトリックが黄色で表示されます。 healthy：コーディネーターの接続使用率が 90 % 未満です。この場合、コンソール上で該当メトリックが緑色で表示されます。説明コーディネーターの接続使用率は、コーディネーターにおける最大接続使用率です。	healthy
Value	number	コーディネーターの接続使用率のメトリック値です。単位：％。	1.71
node_segment_connection_status	object	コンピュートノードの接続健全性ステータスに関する情報です。
Status	string	コンピュートノードの接続健全性ステータスです。有効な値は以下のとおりです。 critical：コンピュートノードの接続使用率が 95 % 以上です。この場合、コンソール上で該当メトリックが赤色で表示されます。 warning：コンピュートノードの接続使用率が 90 % 以上 95 % 未満です。この場合、コンソール上で該当メトリックが黄色で表示されます。 healthy：コンピュートノードの接続使用率が 90 % 未満です。この場合、コンソール上で該当メトリックが緑色で表示されます。説明コンピュートノードの接続使用率は、すべてのコンピュートノードにおける最大接続使用率です。	healthy
Value	number	コンピュートノードの最大接続使用率のメトリック値です。単位：％。	0.48
adbpg_master_status	object	コーディネーターの可用性ステータスに関する情報です。
Status	string	コーディネーターの可用性ステータスです。有効な値は以下のとおりです。 critical：プライマリーおよびスタンバイの両方のコーディネーターが利用不可です。この場合、コンソール上で該当メトリックが赤色で表示されます。 warning：プライマリーまたはスタンバイのいずれかのコーディネーターが利用不可です。この場合、コンソール上で該当メトリックが黄色で表示されます。 healthy：プライマリーおよびスタンバイの両方のコーディネーターが利用可能です。この場合、コンソール上で該当メトリックが緑色で表示されます。	healthy
Value	number	コーディネーターの可用性ステータスのメトリック値です。有効な値は以下のとおりです。	1
adbpg_segment_status	object	コンピュートノードの可用性ステータスに関する情報です。
Status	string	コンピュートノードの可用性ステータスです。有効な値は以下のとおりです。 critical：すべてのプライマリーおよびセカンダリコンピュートノードが利用不可です。この場合、コンソール上で該当メトリックが赤色で表示されます。 warning：コンピュートノードの 50 % 以上が利用不可です。この場合、コンソール上で該当メトリックが黄色で表示されます。 healthy：すべてのコンピュートノードが利用可能です。この場合、コンソール上で該当メトリックが緑色で表示されます。	healthy
Value	number	コンピュートノードの可用性ステータスのメトリック値です。	1
adbpg_instance_total_data_gb	object	インスタンスのデータストレージの合計量です。
Value	number	インスタンスのデータストレージの合計量です。単位：GB。	4.1
adbpg_instance_hot_data_gb	object	ホットデータストレージの合計量です。
Value	number	ホットデータストレージの合計量です。単位：GB。	4.1
adbpg_instance_cold_data_gb	object	コールドデータストレージの合計量です。
Value	number	コールドデータストレージの合計量です。単位：GB。	0
RequestId	string	リクエストの ID です。	D97B4191-104D-10CE-8BC5-53**********
DBClusterId	string	インスタンスの ID です。	gp-bp12ga6v69h86****

例

成功レスポンス

JSONJSON

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

エラーコード

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

変更履歴

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