すべてのプロダクト
Search

このプロダクト

    PolarDB:DescribeDBLogFiles

    ドキュメントセンター

    PolarDB:DescribeDBLogFiles

    最終更新日:Apr 10, 2026

    PolarDB クラスターのログ (プライマリ/セカンダリのフェールオーバーログなど) をクエリします。

    今すぐお試しください

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

    list

    *DBCluster

    acs:polardb:{#regionId}:{#accountId}:dbcluster/{#DbClusterId}

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    DBClusterId

    string

    必須

    クラスター ID。

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

    string

    任意

    PolarDB クラスター内のノードの ID。

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

    integer

    任意

    ページ番号。0 より大きい整数である必要があります。デフォルト値は 1 です。

    1
    PageSize

    integer

    任意

    ページサイズ。有効な値：5～50。デフォルト値は 10 です。

    10
    StartTime

    string

    任意

    クエリする時間範囲の開始時刻。時刻は協定世界時 (UTC) で、yyyy-MM-ddTHH:mm:ssZ 形式である必要があります。

    2023-08-20T16:00:00Z
    EndTime

    string

    任意

    クエリする時間範囲の終了時刻。時刻は協定世界時 (UTC) で、yyyy-MM-ddTHH:mm:ssZ 形式である必要があります。

    2023-09-20T16:00:00Z
    LogType

    string

    必須

    ログタイプ。有効な値：

    • HaSwitchLogList：フェールオーバーログのリスト。

    • HaSwitchLogInfo：フェールオーバーログの詳細。

    • SimulateSwitchLogs：フェールオーバーシミュレーションログ。

    列挙値:

    • HaSwitchLogList :

      HaSwitchLogList

    HaSwitchLogList
    DescribeSimulateSwitchMode

    string

    任意

    シミュレーションレコードをクエリするモード。有効な値：

    • 0：論理インスタンスのシミュレーションレコードをクエリします。シミュレーション ID を指定できます。

    • 1：指定された SimulateListId に基づいて物理インスタンスのシミュレーションレコードをクエリします。

    • 2：進行中の最新のシミュレーションのレコードをクエリします。

    0
    SimulateListId

    string

    任意

    論理インスタンスのシミュレーションレコードの ID。

    "95"
    SimulateStatusList

    string

    任意

    1 つ以上のシミュレーションステータスで結果をフィルタリングします。複数のステータスはカンマ区切りの文字列として指定します。有効な値：

    • 0：スケジューリング待ち

    • 1：成功

    • 2：実行中

    • 3：失敗

    • 4：中断

    • 5：スイッチバック待ち

    • 6：キャンセル

    "0,1,2,3,4,5"
    SimulateModeList

    string

    任意

    1 つ以上のシミュレーションモードで結果をフィルタリングします。複数のモードはカンマ区切りの文字列として指定します。有効な値：

    • 0：プライマリアベイラビリティゾーンに障害が注入されます。

    • 1：DB インスタンスに障害が注入されます。

    • 2：ディザスタリカバリデータセンターに障害が注入されます。

    0,1,2

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    TotalRecords

    integer

    レコードの総数。

    1
    ItemsNumbers

    integer

    現在のページのログ項目数。

    1
    PageNumber

    integer

    ページ番号。Integer データ型の最大値を超えない正の整数である必要があります。デフォルト値：1。

    1
    DBInstanceName

    string

    クラスター ID。

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

    string

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

    • polardb_mysql_rw：読み書きインスタンス。

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

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

    polardb_mysql_rw
    HaStatus

    integer

    フェールオーバーレコードが存在するかどうかを示します。有効な値：

    • 1：いいえ

    • 0：はい

    列挙値:

    • 0 :

      0

    • 1 :

      1

    1
    HaLogItems

    array<object>

    フェールオーバーログのリスト。

    object

    フェールオーバーログ。

    SwitchId

    string

    フェールオーバーログ ID。

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

    string

    フェールオーバー前のインスタンスタイプ。有効な値：

    • polardb_mysql_rw：読み書きインスタンス。

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

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

    polardb_mysql_rw
    SwitchCauseCode

    string

    フェールオーバーの原因のエラーコード。

    Platform.Ha.AuroraService.ManualOperations
    SwitchCauseDetail

    string

    フェールオーバーの原因に関する詳細。

    Platform.Ha.ManuallyTriggered
    SwitchStartTime

    string

    フェールオーバーが開始された時刻。時刻は yyyy-MM-ddTHH:mm:ssZ 形式で、協定世界時 (UTC) で表示されます。

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

    string

    フェールオーバーが完了した時刻。時刻は yyyy-MM-ddTHH:mm:ssZ 形式で、協定世界時 (UTC) で表示されます。

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

    integer

    フェールオーバー中のセッションの総数。

    10000
    AffectedSessions

    integer

    フェールオーバー中に影響を受けたセッションの数。

    100
    SwitchType

    integer

    フェールオーバータイプ。

    0
    RequestId

    string

    リクエスト ID。

    24A1990B-4F6E-482B-B8CB-75C612******
    PageSize

    integer

    各ページで返されるエントリ数。有効な値：5～50。デフォルト値：10。

    10
    SwitchListItems

    array<object>

    障害シミュレーションレコードのリスト。

    array<object>

    障害シミュレーションレコード。

    SimulateListId

    string

    障害シミュレーションレコード ID。

    23
    SimulateMode

    string

    障害シミュレーションモード。

    0
    SimulateStatus

    string

    障害シミュレーションステータス。有効な値：

    • 0：保留中

    • 1：成功

    • 2：実行中

    • 3：失敗

    • 4：中止

    • 5：ロールバック待ち

    2
    StartTime

    string

    障害シミュレーションが開始された時刻。時刻は yyyy-MM-ddTHH:mm:ssZ 形式で、協定世界時 (UTC) で表示されます。

    2025-02-25T01:05:00Z
    EndTime

    string

    障害シミュレーションが完了した時刻。時刻は yyyy-MM-ddTHH:mm:ssZ 形式で、協定世界時 (UTC) で表示されます。

    2025-02-10T02:25:00Z
    EventStartTime

    string

    システムイベントが開始された時刻。時刻は yyyy-MM-ddTHH:mm:ssZ 形式で、協定世界時 (UTC) で表示されます。

    2025-04-19T01:12:00Z
    EventFinishTime

    string

    システムイベントが完了した時刻。時刻は yyyy-MM-ddTHH:mm:ssZ 形式で、協定世界時 (UTC) で表示されます。

    2025-04-19T02:12:00Z
    SimulateTaskId

    string

    障害シミュレーションタスク ID。

    23
    DBNodeCrashList

    array

    障害をシミュレーションするノードの ID。

    説明

    ノードレベルの障害シミュレーションの場合は、単一ノードの ID を指定します。アベイラビリティゾーンレベルの障害シミュレーションの場合は、このパラメーターを省略するか、ゾーン内のすべてのノードの ID を指定できます。

    string

    ノード ID。

    pi-bp19v6xsl0u2c1cqq,pi-bp1ap84xmpf4c1c1t
    SwitchLogItems

    array<object>

    障害シミュレーションログのリスト。

    array<object>

    障害シミュレーションログ。

    SimulateListId

    string

    シミュレーションリスト ID。

    96
    SimulateLogId

    string

    シミュレーションログ ID。

    23
    DBInstanceId

    string

    クラスター ID。

    説明

    DescribeDBClusters 操作を呼び出して、クラスター ID を含むクラスターの詳細をクエリできます。

    pc-*************
    SrcDbType

    string

    ソースデータベースタイプ。有効な値：

    • PolarDBMySQL：PolarDB for MySQL のメジャーバージョンアップ。

    • RDS：RDS から PolarDB for MySQL への移行。

    PolarDBMySQL
    DstDbType

    string

    ターゲットデータベースタイプ。有効な値：

    • PolarDBMySQL：PolarDB for MySQL のメジャーバージョンアップ。

    • RDS：RDS から PolarDB for MySQL への移行。

    PolarDBMySQL
    SimulateStatus

    string

    障害シミュレーションステータス。有効な値：

    • 0：保留中

    • 1：成功

    • 2：実行中

    • 3：失敗

    • 4：中止

    • 5：ロールバック待ち

    1
    EventStartTime

    string

    システムイベントが開始された時刻。時刻は yyyy-MM-ddTHH:mm:ssZ 形式で、協定世界時 (UTC) で表示されます。

    2025-04-19T01:12:00Z
    EventFinishTime

    string

    システムイベントが完了した時刻。時刻は yyyy-MM-ddTHH:mm:ssZ 形式で、協定世界時 (UTC) で表示されます。

    2025-04-19T02:12:00Z

    SwitchStepItems

    array<object>

    障害シミュレーションステップのリスト。

    object

    障害シミュレーションステップ。

    StepName

    string

    現在のステップの名前。DescribeHistoryTasks 操作を呼び出して、指定されたタスクの現在のステップをクエリできます。一般的な値は do_pause で、システムが指定された期間待機することを示します。

    init_task_info
    StartTime

    string

    ステップが開始された時刻。時刻は yyyy-MM-ddTHH:mm:ssZ 形式で、協定世界時 (UTC) で表示されます。

    2025-04-19T02:12:00Z
    SimulatePhase

    string

    障害シミュレーションフェーズ。有効な値：

    • PolarDB.MySQL.FaultSimulate.Phase.FAULT_INJECTION：障害注入フェーズ。

    • PolarDB.MySQL.FaultSimulate.Phase.RECOVERY：回復フェーズ。

    • PolarDB.MySQL.FaultSimulate.Phase.POST_PROCESS：後処理フェーズ。

    PolarDB.MySQL.FaultSimulate.Phase.FAULT_INJECTION
    EndTime

    string

    ステップが完了した時刻。時刻は yyyy-MM-ddTHH:mm:ssZ 形式で、協定世界時 (UTC) で表示されます。

    2025-08-14T02:07:00Z
    TimeCost

    string

    ステップの持続時間 (ミリ秒)。

    1000
    IsSuccess

    string

    ステップが成功したかどうかを示します。有効な値：

    • true：ステップは成功しました。

    • false：ステップは失敗しました。

    true
    SwitchStepItems

    array<object>

    フェールオーバーステップのリスト。

    object

    SimulatePhase

    string

    障害シミュレーションフェーズ。有効な値：

    • PolarDB.MySQL.FaultSimulate.Phase.FAULT_INJECTION：障害注入フェーズ。

    • PolarDB.MySQL.FaultSimulate.Phase.RECOVERY：回復フェーズ。

    • PolarDB.MySQL.FaultSimulate.Phase.POST_PROCESS：後処理フェーズ。

    PolarDB.MySQL.FaultSimulate.Phase.FAULT_INJECTION
    StepName

    string

    現在のステップの名前。DescribeHistoryTasks 操作を呼び出して、指定されたタスクの現在のステップをクエリできます。一般的な値は do_pause で、システムが指定された期間待機することを示します。

    init_task_info
    StartTime

    string

    ステップが開始された時刻。時刻は yyyy-MM-ddTHH:mm:ssZ 形式で、協定世界時 (UTC) で表示されます。

    2025-07-16T02:12:00Z
    EndTime

    string

    ステップが完了した時刻。時刻は yyyy-MM-ddTHH:mm:ssZ 形式で、協定世界時 (UTC) で表示されます。

    2025-07-23T02:30:00Z
    TimeCost

    string

    ステップの持続時間 (ミリ秒)。

    1000
    IsSuccess

    string

    ステップが成功したかどうかを示します。有効な値：

    • true：ステップは成功しました。

    • false：ステップは失敗しました。

    true
    DBNodeId

    string

    クラスターノード ID。

    説明

    このパラメーターは、リクエストの Key パラメーターが PolarDBDiskUsage に設定されていない場合にのみ返されます。

    pi-*************
    FaultInjectionType

    string

    障害注入メソッド。有効な値：

    • CrashSQLInjection：Crash SQL を使用してインスタンスに障害を注入します。

    CrashSQLInjection
    SwitchLogItems

    array<object>

    障害シミュレーションログのリスト。

    array<object>

    障害シミュレーションログ。

    SimulateListId

    string

    シミュレーションリスト ID。

    231
    Simulatecode

    string

    障害シミュレーションのステータスコード。

    0
    DBInstanceId

    string

    クラスター ID。

    説明

    DescribeDBClusters 操作を呼び出して、クラスター ID を含むクラスターの詳細をクエリできます。

    pc-*************
    SrcDbType

    string

    ソースデータベースタイプ。有効な値：

    • PolarDBMySQL：PolarDB for MySQL のメジャーバージョンアップ。

    • RDS：RDS から PolarDB for MySQL への移行。

    PolarDBMySQL
    DstDbType

    string

    ターゲットデータベースタイプ。有効な値：

    • PolarDBMySQL：PolarDB for MySQL のメジャーバージョンアップ。

    • RDS：RDS から PolarDB for MySQL への移行。

    PolarDBMySQL
    SimulateStatus

    string

    障害シミュレーションステータス。有効な値：

    • 0：保留中

    • 1：成功

    • 2：実行中

    • 3：失敗

    • 4：中止

    • 5：ロールバック待ち

    1
    EventStartTime

    string

    システムイベントが開始された時刻。時刻は yyyy-MM-ddTHH:mm:ssZ 形式で、協定世界時 (UTC) で表示されます。

    2025-04-19T01:12:00Z
    EventFinishTime

    string

    システムイベントが完了した時刻。時刻は yyyy-MM-ddTHH:mm:ssZ 形式で、協定世界時 (UTC) で表示されます。

    2025-04-19T02:12:00Z
    SwitchStepItems

    array<object>

    フェールオーバーステップのリスト。

    object

    StepName

    string

    ステップの名前。

    init_task_info
    StepMsg

    string

    ステップの実行ステータスに関するメッセージ。

    This step exec success

    StartTime

    string

    ステップが開始された時刻。時刻は yyyy-MM-ddTHH:mm:ssZ 形式で、協定世界時 (UTC) で表示されます。

    2024-10-21T02:12:00Z
    EndTime

    string

    ステップが完了した時刻。時刻は yyyy-MM-ddTHH:mm:ssZ 形式で、協定世界時 (UTC) で表示されます。

    2025-03-27T02:27:00Z
    TimeCost

    string

    ステップの持続時間 (ミリ秒)。

    1000
    IsSuccess

    string

    ステップが成功したかどうかを示します。有効な値：

    • true：ステップは成功しました。

    • false：ステップは失敗しました。

    true
    SimulatePhase

    string

    障害シミュレーションフェーズ。有効な値：

    • PolarDB.MySQL.FaultSimulate.Phase.FAULT_INJECTION：障害注入フェーズ。

    • PolarDB.MySQL.FaultSimulate.Phase.RECOVERY：回復フェーズ。

    • PolarDB.MySQL.FaultSimulate.Phase.POST_PROCESS：後処理フェーズ。

    PolarDB.MySQL.FaultSimulate.Phase.FAULT_INJECTION
    DBNodeId

    string

    ノード ID。

    説明

    DBNodeId または DBClusterId パラメーターのいずれかを指定する必要があります。DescribeDBClusters 操作を呼び出して、ノード ID を含むクラスターの詳細をクエリできます。

    pi-*************

    例

    成功レスポンス

    JSONJSON

    {
  "TotalRecords": 1,
  "ItemsNumbers": 1,
  "PageNumber": 1,
  "DBInstanceName": "pc-****************",
  "DBInstanceType": "polardb_mysql_rw",
  "HaStatus": 1,
  "HaLogItems": [
    {
      "SwitchId": "e571f897-9b3c-4012-9470-88333832dec4",
      "FromDBType": "polardb_mysql_rw",
      "SwitchCauseCode": "Platform.Ha.AuroraService.ManualOperations",
      "SwitchCauseDetail": "Platform.Ha.ManuallyTriggered",
      "SwitchStartTime": "2025-05-20T03:09:45Z",
      "SwitchFinishTime": "2025-05-20T03:09:56Z",
      "TotalSessions": 10000,
      "AffectedSessions": 100,
      "SwitchType": 0
    }
  ],
  "RequestId": "24A1990B-4F6E-482B-B8CB-75C612******",
  "PageSize": 10,
  "SwitchListItems": [
    {
      "SimulateListId": "23",
      "SimulateMode": "0",
      "SimulateStatus": "2",
      "StartTime": "2025-02-25T01:05:00Z",
      "EndTime": "2025-02-10T02:25:00Z",
      "EventStartTime": "2025-04-19T01:12:00Z",
      "EventFinishTime": "2025-04-19T02:12:00Z",
      "SimulateTaskId": "23",
      "DBNodeCrashList": [
        "pi-bp19v6xsl0u2c1cqq,pi-bp1ap84xmpf4c1c1t"
      ],
      "SwitchLogItems": [
        {
          "SimulateListId": "96",
          "SimulateLogId": "23",
          "DBInstanceId": "pc-*************",
          "SrcDbType": "PolarDBMySQL",
          "DstDbType": "PolarDBMySQL",
          "SimulateStatus": "1",
          "EventStartTime": "2025-04-19T01:12:00Z",
          "EventFinishTime": "2025-04-19T02:12:00Z\n",
          "SwitchStepItems": [
            {
              "StepName": "init_task_info",
              "StartTime": "2025-04-19T02:12:00Z",
              "SimulatePhase": "PolarDB.MySQL.FaultSimulate.Phase.FAULT_INJECTION",
              "EndTime": "2025-08-14T02:07:00Z",
              "TimeCost": "1000",
              "IsSuccess": "true"
            }
          ]
        }
      ],
      "SwitchStepItems": [
        {
          "SimulatePhase": "PolarDB.MySQL.FaultSimulate.Phase.FAULT_INJECTION",
          "StepName": "init_task_info",
          "StartTime": "2025-07-16T02:12:00Z",
          "EndTime": "2025-07-23T02:30:00Z",
          "TimeCost": "1000",
          "IsSuccess": "true",
          "DBNodeId": "pi-*************"
        }
      ],
      "FaultInjectionType": "CrashSQLInjection"
    }
  ],
  "SwitchLogItems": [
    {
      "SimulateListId": "231",
      "Simulatecode": "0",
      "DBInstanceId": "pc-*************",
      "SrcDbType": "PolarDBMySQL",
      "DstDbType": "PolarDBMySQL",
      "SimulateStatus": "1",
      "EventStartTime": "2025-04-19T01:12:00Z",
      "EventFinishTime": "2025-04-19T02:12:00Z",
      "SwitchStepItems": [
        {
          "StepName": "init_task_info",
          "StepMsg": "This step exec success ",
          "StartTime": "2024-10-21T02:12:00Z",
          "EndTime": "2025-03-27T02:27:00Z",
          "TimeCost": "1000",
          "IsSuccess": "true",
          "SimulatePhase": "PolarDB.MySQL.FaultSimulate.Phase.FAULT_INJECTION",
          "DBNodeId": "pi-*************"
        }
      ]
    }
  ]
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 InvalidDBClusterId.Malformed The specified parameter DBClusterId is not valid.
    400 InvalidPageSize.Malformed The specified parameter PageSize is not valid.
    400 InvalidPageNumber.Malformed The specified parameter PageNumber is not valid.
    404 InvalidDBCluster.NotFound The DBClusterId provided does not exist in our records.

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

    変更履歴

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