DescribeHistoryTasksStat查詢工作中樞任務狀態的概覽資訊-ApsaraDB for MongoDB-阿里雲

查看工作中樞任務的概覽資訊。

調試

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

調試

授權資訊

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

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

dds:DescribeHistoryTasksStat

list

*Instance

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

無

請求參數

名稱	類型	必填	描述	樣本值
RegionId	string	是	待處理事件所屬的地區 ID，您可以通過調用 DescribeRegions 介面進行查詢。	cn-beijing
Status	string	否	任務狀態，用於選擇對應狀態的任務： Scheduled：等待執行 Running：執行中 Succeed：執行成功 Failed：執行失敗 Cancelling：正在終止 Canceled：已終止 Waiting：等待預設時間預設為空白，表示全選，如需選擇多個狀態請用英文逗號（,）分隔。	Succeed
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：修改儲存類型	DeleteIns
FromStartTime	string	是	營運任務開始的時間，格式為 yyyy-MM-ddTHH:mm:ssZ（UTC 時間），最早支援查詢 30 天前的資料。	2023-04-16T02:46:21Z
ToStartTime	string	是	營運任務結束的時間，格式為 yyyy-MM-ddTHH:mm:ssZ（UTC 時間），最早支援查詢 30 天前的資料。	2023-05-16T02:15:52Z
FromExecTime	integer	否	任務執行耗時的最小值。用於篩選任務執行耗時大於此時間的任務，單位秒。預設 0，表示不限制。	0
ToExecTime	integer	否	任務執行耗時的最大值。用於篩選任務執行耗時不小於此時間的任務，單位秒。預設 0，表示不限制。	0
ResourceGroupId	string	否	資源群組 ID。	rg-acfmyiu4ekp****

返回參數

名稱	類型	描述	樣本值
	object	Schema of Response
RequestId	string	請求 ID。	FC724D23-XXXX-XXXX-ABB1-606C935AE7FD
Items	array<object>	任務對象列表。
	object	任務對象。
Status	string	任務狀態。 Scheduled：等待執行 Running：執行中 Succeed：執行成功 Failed：執行失敗 Cancelling：正在終止 Canceled：已終止 Waiting：等待預設時間	Succeed
TotalCount	integer	任務狀態對應的任務數量。	2

樣本

正常返回樣本

JSON格式

{
  "RequestId": "FC724D23-XXXX-XXXX-ABB1-606C935AE7FD",
  "Items": [
    {
      "Status": "Succeed",
      "TotalCount": 2
    }
  ]
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	Param.Invalid	Param invalid
400	Param.Invalid.TimeEndBeforeStart	Param invalid. End time before start time

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

變更歷史

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