すべてのプロダクト
Search

このプロダクト

    PolarDB:DescribeHALogs

    ドキュメントセンター

    PolarDB:DescribeHALogs

    最終更新日:Sep 24, 2026

    インスタンスの高可用性ログを照会します。

    操作説明

    説明

    • この操作は PolarDB for MySQL でのみサポートされています。

    今すぐお試しください

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

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    polardb:DescribeHALogs

    get

    *すべてのリソース。

    *

    		 なし なし

    リクエスト構文

    POST  HTTP/1.1

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    DBClusterId

    string

    必須

    クラスター ID。

    pc-****************
    DBNodeId

    string

    任意

    ノード ID。

    説明

    指定された DBNodeId の HA フェールオーバーレコードをクエリします。 DescribeDBClusters 操作を呼び出して、ノード ID を含むアカウント配下のすべてのクラスターの詳細をクエリできます。

    pi-****************
    PageNumber

    integer

    任意

    ページ番号。

    1
    PageSize

    integer

    任意

    1 ページあたりのエントリ数。有効な値: 5～50。デフォルト値: 10。

    30
    StartTime

    string

    任意

    クエリの開始時刻。時間を YYYY-MM-DDThh:mm:ssZ フォーマット (協定世界時 (UTC)) で指定します。

    2025-05-01T00:00:00Z
    EndTime

    string

    任意

    クエリの終了時刻。終了時刻は開始時刻より後である必要があります。時間を YYYY-MM-DDThh:mm:ssZ フォーマット (協定世界時 (UTC)) で指定します。

    2025-05-23T01:01:00Z
    LogType

    string

    必須

    ログタイプ。

    列挙値:

    • HaSwitchLogList :

      高可用性フェールオーバーログリスト。

    HaSwitchLogList

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    レスポンスのスキーマ。

    TotalRecords

    integer

    レコードの総数。

    160
    ItemsNumbers

    integer

    現在のページのログリスト内のアイテム数。

    10
    PageNumber

    integer

    ページ番号。値は、Integer データ型の最大値を超えない正の整数です。デフォルト値: 1。

    1
    DBInstanceName

    string

    インスタンス ID。

    pc-a*************
    DBInstanceType

    string

    インスタンスタイプ。有効な値:

    • polardb_mysql_rw: 読み取り/書き込みインスタンス。

    • polardb_mysql_ro: 読み取り専用インスタンス。

    • polardb_mysql_standby: スタンバイインスタンス。

    polardb_mysql_rw
    HaStatus

    integer

    プライマリ/セカンダリのスイッチオーバーレコードが存在するかどうかを示します。有効な値:

    • 1: レコードが存在しません。

    • 0: レコードが存在します。

    1
    HaLogItems

    array<object>

    プライマリ/セカンダリのスイッチオーバーログのリスト。

    object

    プライマリ/セカンダリのスイッチオーバーログのリスト。

    SwitchId

    string

    プライマリ/セカンダリのスイッチオーバーログの ID。

    e571f897-9b3c-4012-9470-88333832dec4
    SwitchCauseCode

    string

    スイッチオーバーの原因コード。

    Platform.Ha.AuroraService.ManualOperations
    SwitchCauseDetail

    string

    スイッチオーバーの原因。

    Platform.Ha.ManuallyTriggered
    SwitchStartTime

    string

    スイッチオーバーの開始時刻。

    時間は ISO 8601 フォーマットの協定世界時 (UTC) (フォーマット: YYYY-MM-DDTHH:mm:ssZ) です。

    2025-05-20T03:09:45Z
    SwitchFinishTime

    string

    スイッチオーバーの終了時刻。

    時間は ISO 8601 フォーマットの協定世界時 (UTC) (フォーマット: YYYY-MM-DDTHH:mm:ssZ) です。

    2025-05-20T03:09:56Z
    RequestId

    string

    リクエスト ID。

    6BD9CDE4-5E7B-4BF3-9BB8-83C73E******
    PageSize

    integer

    1 ページあたりのエントリ数。有効な値: 30～100。デフォルト値: 30。

    30

    例

    成功レスポンス

    JSONJSON

    {
  "TotalRecords": 160,
  "ItemsNumbers": 10,
  "PageNumber": 1,
  "DBInstanceName": "pc-a*************",
  "DBInstanceType": "polardb_mysql_rw",
  "HaStatus": 1,
  "HaLogItems": [
    {
      "SwitchId": "e571f897-9b3c-4012-9470-88333832dec4",
      "SwitchCauseCode": "Platform.Ha.AuroraService.ManualOperations",
      "SwitchCauseDetail": "Platform.Ha.ManuallyTriggered",
      "SwitchStartTime": "2025-05-20T03:09:45Z",
      "SwitchFinishTime": "2025-05-20T03:09:56Z"
    }
  ],
  "RequestId": "6BD9CDE4-5E7B-4BF3-9BB8-83C73E******",
  "PageSize": 30
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 InvalidDBClusterId.Malformed The specified parameter DBClusterId is not valid.
    400 InvalidPageSize.Malformed The specified parameter PageSize is not valid. 指定されたパラメーター PageSize は無効です。
    400 InvalidPageNumber.Malformed The specified parameter PageNumber is not valid. 指定されたパラメーター PageNumber は無効です。
    404 InvalidDBCluster.NotFound The DBClusterId provided does not exist in our records. 操作に失敗しました。指定されたクラスターインスタンス ID が存在しません。

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

    変更履歴

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