全部產品
Search
文件中心

:DescribeHistoryTasks - 查詢工作中樞的任務資訊

更新時間:Dec 18, 2025

查看工作中樞的工作清單。

調試

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

調試

授權資訊

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

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

  • 存取層級:是指每個操作的存取層級,取值為寫入(Write)、讀取(Read)或列出(List)。

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

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

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

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

dds:DescribeHistoryTasks

list

*Instance

acs:dds:{#regionId}:{#accountId}:dbinstance/{#InstanceId}

請求參數

名稱

類型

必填

描述

樣本值

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:執行成功

  • Failed:執行失敗

  • Cancelling:正在終止

  • Canceled:已終止

  • Waiting:等待預設時間

預設為空白,表示全選,如需選擇多個狀態請用英文逗號(,)分隔。

Succeed,Running,Waiting

InstanceId

string

執行個體 ID,用於查詢對應執行個體的任務,預設為空白,表示不限制。如需查詢多個執行個體請用英文逗號(,)分隔,最多支援 30 個。

dds-8vb38f0e7933xxxx

TaskId

string

任務 ID,用於查詢已知 ID 的任務。預設為空白,表示不限制。如需查詢多個請用英文逗號(,)分隔,最多支援 30 個。

t-0mq1yyhm3ffl2bxxxx

TaskType

string

任務類型,用於查詢特定類型任務情況,預設為空白,表示不限制,取值如下:

  • CreateIns:建立執行個體

  • DeleteIns:刪除執行個體

  • ChangeVariable:參數調整

  • ModifyInsConfig:配置變更

  • RestartIns:重啟執行個體

  • HaSwitch:執行個體主備切換

  • CloneIns:複製執行個體

  • KernelVersionUpgrade:核心版本升級

  • ProxyVersionUpgrade:代理版本升級

  • ModifyAccount:帳號變更

  • ModifyInsSpec:規格變更或遷移

  • CreateReadIns:建立唯讀執行個體

  • StartIns:啟動執行個體

  • StopIns:暫停執行個體

  • ModifyNetwork:網路變更

  • LockIns: 鎖定執行個體

  • UnlockIns:解鎖執行個體

  • DiskOnlineExpansion:磁碟線上擴容

  • StorageOnlineExpansion:儲存線上擴容

  • AddInsNode:增加節點

  • DeleteInsNode:刪除節點

  • ManualBackupIns:手動備份執行個體

  • ModifyInsStorageType:修改儲存類型

DeleteInsNode

FromStartTime

string

營運任務開始的時間,格式為 yyyy-MM-ddTHH:mm:ssZ(UTC 時間),最早支援查詢 30 天前的資料。

2023-03-15T03:41:26Z

ToStartTime

string

營運任務結束的時間,格式為 yyyy-MM-ddTHH:mm:ssZ(UTC 時間),最早支援查詢 30 天前的資料。

2023-03-16T07:21:31Z

FromExecTime

integer

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

0

ToExecTime

integer

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

0

ResourceGroupId

string

資源群組 ID。

rg-aek2inrfrnw3xby

返回參數

名稱

類型

描述

樣本值

object

PageNumber

integer

當前顯示的頁碼。

1

RequestId

string

請求 ID。

3C4A2494-XXXX-XXXX-93CF-548DB3375193

PageSize

integer

每頁顯示的最大記錄數。

10

TotalCount

integer

不考慮分頁因素,滿足查詢條件的總任務數。

5

Items

array<object>

任務對象列表。

object

任務對象,格式是詞典。

Status

string

任務狀態。

  • Scheduled:等待執行

  • Running:執行中

  • Succeed:執行成功

  • Failed:執行失敗

  • Cancelling:正在終止

  • Canceled:已終止

  • Waiting:等待預設時間

Succeed

TaskId

string

任務 ID。

t-0mq1yyhm3ffl2bxxxx

CurrentStepName

string

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

exec_task

StartTime

string

任務開始時間,格式為 yyyy-MM-ddTHH:mm:ssZ(UTC 時間)。

2023-02-11T02:33Z

EndTime

string

任務結束時間,格式為 yyyy-MM-ddTHH:mm:ssZ(UTC 時間)。

2023-03-16T02:59Z

TaskType

string

任務類型。

  • CreateIns:建立執行個體

  • DeleteIns:刪除執行個體

  • ChangeVariable:參數調整

  • ModifyInsConfig:配置變更

  • RestartIns:重啟執行個體

  • HaSwitch:執行個體主備切換

  • CloneIns:複製執行個體

  • KernelVersionUpgrade:核心版本升級

  • ProxyVersionUpgrade:代理版本升級

  • ModifyAccount:帳號變更

  • ModifyInsSpec:規格變更或遷移

  • CreateReadIns:建立唯讀執行個體

  • StartIns:啟動執行個體

  • StopIns:暫停執行個體

  • ModifyNetwork:網路變更

  • LockIns: 鎖定執行個體

  • UnlockIns:解鎖執行個體

  • DiskOnlineExpansion:磁碟線上擴容

  • StorageOnlineExpansion:儲存線上擴容

  • AddInsNode:增加節點

  • DeleteInsNode:刪除節點

  • ManualBackupIns:手動備份執行個體

  • ModifyInsStorageType:修改儲存類型

CreateIns

RemainTime

integer

預估剩餘執行時間,單位秒,0 表示已執行完成。

1000

Progress

number

當前進度,範圍為[0,100]。

100.0

RegionId

string

地區 ID。

cn-hangzhou

InstanceType

string

執行個體類型,固定為 Instance。

Instance

InstanceId

string

執行個體 ID。

dds-t4n18194768fxxxx

InstanceName

string

執行個體名稱。

test-dds

DbType

string

DB 類型,固定為 mongodb。

mongodb

Product

string

產品,固定為 dds。

dds

TaskDetail

string

任務詳情,不同 taskType 對應不同的輸出。

{\"callerUid\":\"test\"}

ReasonCode

string

當前任務發起的原因。

小版本升級

ActionInfo

string

允許的操作資訊,具體使用時是根據 currentStepName+status 在此資訊中匹配操作 Action,如果未匹配到 Action,代表任務目前狀態不支援操作,樣本:

   "steps": [
    {
      "step_name": "exec_task", // 步驟名, 與 currentStepName 匹配
      "action_info": {    // 步驟支援的操作
        "Waiting": [      // 狀態,與 status 匹配
          "modifySwitchTime" // 操作 Action,可能多個,即代表支援多個操作
        ]
      }
    },
    {
      "step_name": "init_task", // 步驟名
      "action_info": {    // 步驟支援的操作
        "Running": [      // 狀態
          "cancel",       // 操作
          "pause"
        ]
      }
    }
  ]
}

系統可能支援的操作:

  • retry:重試

  • cancel:取消

  • modifySwitchTime:修改切換時間/恢復

`{\"steps\":[{\"action_info\":{\"Waiting\":[\"modifySwitchTime\"]},\"step_name\":\"exec_task\"}]}`

Uid

string

資源所屬的使用者識別碼。

141345906006****

CallerSource

string

請求來源 System:系統 User:使用者。

System

CallerUid

string

請求使用者識別碼,callerSource 為 User 時代表使用者 UID。

141345906006****

樣本

正常返回樣本

JSON格式

{
  "PageNumber": 1,
  "RequestId": "3C4A2494-XXXX-XXXX-93CF-548DB3375193",
  "PageSize": 10,
  "TotalCount": 5,
  "Items": [
    {
      "Status": "Succeed",
      "TaskId": "t-0mq1yyhm3ffl2bxxxx",
      "CurrentStepName": "exec_task",
      "StartTime": "2023-02-11T02:33Z",
      "EndTime": "2023-03-16T02:59Z",
      "TaskType": "CreateIns",
      "RemainTime": 1000,
      "Progress": 100,
      "RegionId": "cn-hangzhou",
      "InstanceType": "Instance",
      "InstanceId": "dds-t4n18194768fxxxx",
      "InstanceName": "test-dds",
      "DbType": "mongodb",
      "Product": "dds",
      "TaskDetail": "{\\\"callerUid\\\":\\\"test\\\"}",
      "ReasonCode": "小版本升級",
      "ActionInfo": "`{\\\"steps\\\":[{\\\"action_info\\\":{\\\"Waiting\\\":[\\\"modifySwitchTime\\\"]},\\\"step_name\\\":\\\"exec_task\\\"}]}`",
      "Uid": "141345906006****",
      "CallerSource": "System",
      "CallerUid": "141345906006****"
    }
  ]
}

錯誤碼

HTTP status code

錯誤碼

錯誤資訊

描述

400 Param.Invalid Param invalid
400 Param.Invalid.TimeEndBeforeStart Param invalid. End time before start time

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

變更歷史

更多資訊,參考變更詳情