全部產品
Search

搜尋本產品

    PolarDB：DescribeHistoryTasks - 查詢歷史任務

    文件中心

    PolarDB：DescribeHistoryTasks - 查詢歷史任務

    更新時間：Dec 15, 2025

    PolarDB MySQL 查詢歷史工作清單。

    調試

    您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

    調試

    授權資訊

    下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

    • 操作：是指具體的許可權點。

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

    • 資源類型：是指操作中支援授權的資源類型。具體說明如下：

      • 對於必選的資源類型，用前面加 * 表示。

      • 對於不支援資源級授權的操作，用全部資源表示。

    • 條件關鍵字：是指雲產品自身定義的條件關鍵字。

    • 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    polardb:DescribeHistoryTasks

    get

    *全部資源

    *

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    RegionId

    string

    否

    地區 ID。

    說明

    可通過介面 DescribeRegions 查看地區資訊詳情。

    cn-beijing
    PageSize

    integer

    否

    每頁記錄數，取值：10~100。預設值：10。

    10
    PageNumber

    integer

    否

    查詢結果的頁碼。取值範圍：正整數。 預設值：1。

    1
    InstanceType

    string

    否

    當前只支援 Instance。

    Instance
    Status

    string

    否

    任務狀態，取值範圍如下：

    • Scheduled：等待執行

    • Running：執行中

    • Succeed：執行成功

    • Cancelling：正在終止

    • Canceled：已終止

    • Waiting：等待預設時間

    如需查詢多個狀態則用英文逗號分隔，預設為空白，表示全選。

    Running
    InstanceId

    string

    否

    資源 ID。用於查詢對應資源的任務，如有多個用英文逗號分隔，最多支援 30 個，預設為空白，表示不限制。

    說明

    目前只支援叢集 ID。

    pc-2zed3m89cw***
    TaskId

    string

    否

    任務 ID。如有多個任務 ID，使用英文用逗號分隔，最多支援 30 個，預設為空白，表示不限制。

    t-0mqi38ho0cgjv***
    TaskType

    string

    否

    任務類型，用於查詢特定類型任務情況，如有多個用英文逗號分隔，最多支援 30 個，預設為空白，表示不限制。

    ChangeVariable
    FromStartTime

    string

    是

    任務開始時間的起始時間，表示查詢任務開始時間在此時間之後的任務。按照 ISO8601 標準表示，並需要使用 UTC+0 時間，格式為 yyyy-MM-ddTHH:mm:ssZ。最早支援 30 天前，距目前時間超過 30 天會自動轉換成 30 天前。

    2025-01-02T11:31:03Z
    ToStartTime

    string

    是

    任務開始時間的結束時間，表示查詢任務開始時間在此時間之前的任務。按照 ISO8601 標準表示，並需要使用UTC+0 時間，格式為 yyyy-MM-ddTHH:mm:ssZ。

    2025-01-03T11:31:03Z
    FromExecTime

    integer

    否

    任務執行耗時的最小值。用於篩選任務執行耗時大於此時間的任務，單位秒。預設 0，表示不限制。

    0
    ToExecTime

    integer

    否

    任務執行耗時的最大值。用於篩選任務執行耗時不小於此時間的任務，單位秒。預設 0，表示不限制。

    0
    ResourceGroupId

    string

    否

    資源群組 ID。

    rg-************

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    返回參數詳情。

    PageNumber

    integer

    查詢結果的頁碼。

    1
    RequestId

    string

    請求唯一 ID。

    F90D7C14-2D1C-5B88-9CD1-23AB2CF89***
    PageSize

    integer

    每頁記錄數。

    10
    TotalCount

    string

    不考慮分頁因素，滿足這些限制條件的總任務數。

    2
    Items

    array<object>

    工作清單。

    object

    任務對象。

    Status

    string

    任務狀態。

    • Scheduled：等待執行

    • Running：執行中

    • Succeed：執行成功

    • Failed：執行失敗

    • Cancelling：正在終止

    • Canceled：已終止

    • Waiting：等待預設時間

    Succeed
    TaskId

    string

    任務 ID。

    t-0mqt8qhnw04ipz0***
    CurrentStepName

    string

    當前執行的步驟名，如果為空白代表任務未開始。

    finish_task
    StartTime

    string

    任務開始時間。

    2025-03-03T07:25:16Z
    EndTime

    string

    任務結束時間。

    2025-03-03T07:30:57Z
    TaskType

    string

    任務類型。

    ChangeVariable
    RemainTime

    integer

    預估剩餘執行時間，單位為秒（s）。

    說明

    該值僅供參考，請以實際執行時間為準。

    0
    Progress

    number

    當前進度。

    100.0
    RegionId

    string

    地區 ID。

    cn-beijing
    InstanceType

    string

    資源類型。

    Instance
    InstanceId

    string

    資源 ID。

    pc-2zed3m89cw***
    InstanceName

    string

    資源名稱。

    pc-2zed3m89cw***
    DbType

    string

    資料庫類型。

    polardb_mysql
    Product

    string

    產品。

    polardb
    TaskDetail

    string

    任務詳情。

    {\"steps\":[{\"step_name\":\"init_task\"},{\"step_name\":\"exec_task\"},{\"step_name\":\"finish_task\"}]}
    ReasonCode

    string

    當前任務發起的原因。

    ""
    ActionInfo

    string

    允許的操作資訊。

    說明

    目前暫未支援。

    {}
    Uid

    string

    資源所屬使用者識別碼。

    1816563541899***
    CallerSource

    string

    請求來源，取值說明：

    • System：系統

    • User：使用者

    User
    CallerUid

    string

    請求使用者識別碼，CallerSource 為 User 時代表使用者 UID。

    1816563541899***

    樣本

    正常返回樣本

    JSON格式

    {
  "PageNumber": 1,
  "RequestId": "F90D7C14-2D1C-5B88-9CD1-23AB2CF89***",
  "PageSize": 10,
  "TotalCount": "2",
  "Items": [
    {
      "Status": "Succeed",
      "TaskId": "t-0mqt8qhnw04ipz0***",
      "CurrentStepName": "finish_task",
      "StartTime": "2025-03-03T07:25:16Z",
      "EndTime": "2025-03-03T07:30:57Z",
      "TaskType": "ChangeVariable",
      "RemainTime": 0,
      "Progress": 100,
      "RegionId": "cn-beijing",
      "InstanceType": "Instance",
      "InstanceId": "pc-2zed3m89cw***",
      "InstanceName": "pc-2zed3m89cw***",
      "DbType": "polardb_mysql",
      "Product": "polardb",
      "TaskDetail": "{\\\"steps\\\":[{\\\"step_name\\\":\\\"init_task\\\"},{\\\"step_name\\\":\\\"exec_task\\\"},{\\\"step_name\\\":\\\"finish_task\\\"}]}",
      "ReasonCode": "\"\"",
      "ActionInfo": "{}",
      "Uid": "1816563541899***",
      "CallerSource": "User",
      "CallerUid": "1816563541899***"
    }
  ]
}

    錯誤碼

    HTTP status code

    錯誤碼

    錯誤資訊

    描述
    400 Param.Invalid The parameter is invalid. 參數無效。

    訪問錯誤中心查看更多錯誤碼。

    變更歷史

    更多資訊，參考變更詳情。