查看任務中心的任務列表。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
dds:DescribeHistoryTasks | list |
|
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | 待處理事件所屬的地域 ID,您可以通過調用 DescribeRegions 接口進行查詢。 | cn-beijing |
PageSize | integer | 否 | 每頁記錄數,取值:10~100。默認值:10。 | 10 |
PageNumber | integer | 否 | 查詢結果的頁碼。取值范圍:正整數。 默認值:1。 | 1 |
InstanceType | string | 否 | 當前固定為 Instance。 | Instance |
Status | string | 否 | 任務狀態,用于選擇對應狀態的任務:
默認為空,表示全選,如需選擇多個狀態請用英文逗號(,)分隔。 | Succeed,Running,Waiting |
InstanceId | string | 否 | 實例 ID,用于查詢對應實例的任務,默認為空,表示不限制。如需查詢多個實例請用英文逗號(,)分隔,最多支持 30 個。 | dds-8vb38f0e7933xxxx |
TaskId | string | 否 | 任務 ID,用于查詢已知 ID 的任務。默認為空,表示不限制。如需查詢多個請用英文逗號(,)分隔,最多支持 30 個。 | t-0mq1yyhm3ffl2bxxxx |
TaskType | string | 否 | 任務類型,用于查詢特定類型任務情況,默認為空,表示不限制,取值如下:
| 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 |
返回參數
示例
正常返回示例
JSON
格式
{
"PageNumber": 1,
"RequestId": "3C4A2494-XXXX-XXXX-93CF-548DB3375193",
"PageSize": 10,
"TotalCount": 5,
"Items": [
{
"Status": 0,
"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 |
訪問錯誤中心查看更多錯誤碼。