すべてのプロダクト
Search

このプロダクト

    AnalyticDB:DescribeDBInstanceDiagnosisSummary

    ドキュメントセンター

    AnalyticDB:DescribeDBInstanceDiagnosisSummary

    最終更新日:Mar 21, 2026

    AnalyticDB for PostgreSQL インスタンス内のノードに関する情報を照会します。

    操作説明

    この操作を呼び出すと、AnalyticDB for PostgreSQL インスタンスにおけるコーディネーターおよびコンピュートノードのディストリビューションと状態を照会できます。

    今すぐお試しください

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

    get

    *DBInstance

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

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    DBInstanceId

    string

    必須

    インスタンス ID。

    説明

    すべての AnalyticDB for PostgreSQL インスタンス（インスタンス ID を含む）の詳細をリージョン単位で照会するには、「DescribeDBInstances」操作を呼び出してください。

    gp-bp12ga6v69h86****
    PageSize

    integer

    任意

    1 ページあたりの表示件数。有効な値：

    • 20

    • 50

    • 100

    デフォルト値：20。

    30
    PageNumber

    integer

    任意

    ページ番号。先頭ページは 1 から始まります。デフォルト値：1。

    1
    StartStatus

    string

    任意

    ノードの実行状態。有効な値：

    • UP：ノードが正常に実行中です。

    • DOWN：ノードに障害が発生しています。

    このパラメーターを指定しない場合、すべての実行状態のノードに関する情報が返されます。

    UP
    SyncMode

    string

    任意

    ノードのデータ同期状態。有効な値：

    • synced：ノードのデータが同期済みです。

    • notSyncing：ノードのデータが未同期です。

    このパラメーターを指定しない場合、すべての同期状態のノードに関する情報が返されます。

    synced
    RolePreferd

    string

    任意

    ノードのロール状態。プライマリ/セカンダリ スイッチオーバーの発生有無を指定します。有効な値：

    • normal：ノードのロールが正常です。プライマリ/セカンダリ スイッチオーバーは発生していません。

    • reverse：ノードのロールが反転しています。プライマリ/セカンダリ スイッチオーバーが発生しています。

    normal

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    RequestId

    string

    リクエスト ID。

    070534EC-78D5-5519-83CC-E7B1A9213483
    TotalCount

    string

    返された合計件数。

    6
    PageNumber

    string

    ページ番号。

    1
    Items

    array<object>

    ノードグループ ID。

    object

    Hostname

    string

    ノード名。

    gp-t4np568qe9710****-master-100984919
    NodeAddress

    string

    ノードの IP アドレス。

    192.168.XX.XX
    NodeType

    string

    ノードの種類。有効な値：

    • master：プライマリコーディネーターノード。

    • slave：スタンバイコーディネーターノード。

    • segment：コンピュートノード。

    master
    NodeName

    string

    ノードが配置されているホスト名。

    ap-southeast-1.i-t4n4c4ryr0yr441d****
    NodePort

    string

    ノードのポート番号。

    3000
    NodeID

    string

    ノード ID。

    1
    NodeStatus

    string

    ノードの実行状態。有効な値：

    • UP：ノードが正常に実行中です。

    • DOWN：ノードに障害が発生しています。

    UP
    NodeRole

    string

    ノードの現在のロール。有効な値：

    • primary：プライマリノード。

    • mirror：セカンダリノード。

    primary
    NodePreferredRole

    string

    ノードの初期ロール。有効な値：

    • primary：プライマリノード。

    • mirror：セカンダリノード。

    このパラメーターの値が NodeRole と一致する場合、プライマリ/セカンダリ スイッチオーバーは発生しません。一方、このパラメーターの値が NodeRole と異なる場合、プライマリ/セカンダリ スイッチオーバーが発生します。

    primary
    NodeReplicationMode

    string

    ノードのデータ同期状態。有効な値：

    • Synced：ノードのデータが同期済みです。

    • Not Syncing：ノードのデータが未同期です。

    • No sync required：データ同期は不要です。この値は、コーディネーターノードに対してのみ返される場合があります。

    Synced
    NodeCID

    string

    ノードグループ ID。

    -1
    MasterStatusInfo

    object

    コーディネーターノードの状態情報。

    NormalNodeNum

    integer

    正常なノード数。

    2
    ExceptionNodeNum

    integer

    異常なノード数。

    0
    NotSyncingNodeNum

    integer

    未同期のノード数。

    0
    SyncedNodeNum

    integer

    同期済みのノード数。

    1
    PreferredNodeNum

    integer

    ロールが正常なノード数。

    2
    NotPreferredNodeNum

    integer

    ロールが反転しているノード数。

    0
    SegmentStatusInfo

    object

    コンピュートノードの状態情報。

    NormalNodeNum

    integer

    正常なノード数。

    4
    ExceptionNodeNum

    integer

    異常なノード数。

    0
    NotSyncingNodeNum

    integer

    未同期のノード数。

    4
    SyncedNodeNum

    integer

    同期済みのノード数。

    0
    PreferredNodeNum

    integer

    ロールが正常なノード数。

    4
    NotPreferredNodeNum

    integer

    ロールが反転しているノード数。

    0

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "070534EC-78D5-5519-83CC-E7B1A9213483",
  "TotalCount": "6",
  "PageNumber": "1",
  "Items": [
    {
      "Hostname": "gp-t4np568qe9710****-master-100984919",
      "NodeAddress": "192.168.XX.XX",
      "NodeType": "master",
      "NodeName": "ap-southeast-1.i-t4n4c4ryr0yr441d****",
      "NodePort": "3000",
      "NodeID": "1",
      "NodeStatus": "UP",
      "NodeRole": "primary",
      "NodePreferredRole": "primary",
      "NodeReplicationMode": "Synced",
      "NodeCID": "-1"
    }
  ],
  "MasterStatusInfo": {
    "NormalNodeNum": 2,
    "ExceptionNodeNum": 0,
    "NotSyncingNodeNum": 0,
    "SyncedNodeNum": 1,
    "PreferredNodeNum": 2,
    "NotPreferredNodeNum": 0
  },
  "SegmentStatusInfo": {
    "NormalNodeNum": 4,
    "ExceptionNodeNum": 0,
    "NotSyncingNodeNum": 4,
    "SyncedNodeNum": 0,
    "PreferredNodeNum": 4,
    "NotPreferredNodeNum": 0
  }
}

    エラーコード

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

    変更履歴

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