查詢云數據庫 Tair(兼容 Redis)實例某個時間段內運行的所有任務信息。
接口說明
在執行某些耗時較長的操作時,您可以調用本接口查詢任務的處理進度信息。您也可以通過控制臺,進入目標實例的基本信息頁面,單擊頁面右上角的任務進度圖標來查看當前任務的處理進度信息。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
kvstore:DescribeTasks | get | *全部資源 * |
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
InstanceId | string | 是 | 實例 ID,可調用 DescribeInstances 接口獲取。 | r-bp1zxszhcgatnx**** |
PageSize | integer | 否 | 每頁可展示的記錄數,取值: 30、50、100,默認值為 30。 | 30 |
PageNumber | integer | 否 | 頁碼,大于 0 且不超過 Integer 數據類型的最大值,默認值為 1。 | 1 |
StartTime | string | 是 | 查詢開始時間,格式為yyyy-MM-ddTHH:mmZ(UTC 時間)。 | 2020-11-20T01:00Z |
EndTime | string | 是 | 查詢結束時間,必須晚于查詢開始時間,格式為yyyy-MM-ddTHH:mmZ(UTC 時間)。 | 2020-11-26T01:00Z |
Status | string | 是 | 任務狀態,傳入多個值時使用英文逗號(,)分隔,取值:
| 2 |
返回參數
示例
正常返回示例
JSON
格式
{
"RequestId": "608FAEC9-485E-4C65-82DE-2E5B955E****",
"PageNumber": 1,
"PageSize": 30,
"TotalRecordCount": 2,
"Items": [
{
"Status": "2",
"FinishTime": "2020-11-13T06:17:18Z",
"StepsInfo": "[{\\\"remain\\\":0,\\\"name\\\":\\\"init_instance\\\",\\\"progress\\\":100},{\\\"remain\\\":107,\\\"name\\\":\\\"init_redis\\\",\\\"progress\\\":12.3},{\\\"remain\\\":1881,\\\"name\\\":\\\"init_config\\\",\\\"progress\\\":0}]",
"Progress": 100,
"BeginTime": "2020-11-13T06:16:54Z",
"Remain": 60,
"CurrentStepName": "init_redis",
"StepProgressInfo": "3/3",
"TaskId": "32302****",
"TaskAction": "ModifyDBInstanceParameter"
}
]
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。