ModifyTaskInfo - 修改任務操作 - Tair (Redis® OSS-Compatible)

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

kvstore:ModifyTaskInfo

update

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
RegionId	string	是	執行個體所屬的地區 ID。	cn-hangzhou
TaskId	string	是	任務 ID，如需查詢多個請用英文逗號（,）分隔，最多支援 30 個。	t-0mq3kfhn8i1nlt****
StepName	string	否	當前執行的步驟名。您可以通過 DescribeHistoryTasks 查詢指定任務 ID 當前的執行步驟。常見取值do_pause表示等待預設時間執行。	do_pause
TaskAction	string	否	操作名稱，當前支援取值 modifySwitchTime，表示修改切換時間或恢復。	modifySwitchTime
ActionParams	string	否	動作相關的參數，Json 格式。當 TaskAction 取值 modifySwitchTime 時，本參數 ActionParams 取值為 `{"recoverMode": "xxx", "recoverTime": "xxx"}`。 recoverMode 表示任務復原模式，取值為： imePoint：按照指定時間點執行。 immediate: 立即執行。 maintainTime：按照營運時間執行。 recoverTime 表示指定的時間點，UTC+0 時間，格式為 yyyy-MM-ddTHH:mm:ssZ，當 recoverMode 為 timePoint 時，該參數必填。	{"recoverMode":"immediate"}

返回參數

名稱	類型	描述	樣本值
	object	Schema of Response
RequestId	string	請求 ID。	2B98499B-E62B-56D4-8D7F-3D6D4DB260F2
ErrorTaskId	string	失敗的任務 ID，遇到一個失敗即返回。	t-0mqaj5hnyofczv****
SuccessCount	string	成功任務數。	2
ErrorCode	string	錯誤碼。	mst.errorcode.success.errormessage

樣本

正常返回樣本

JSON格式

{
  "RequestId": "2B98499B-E62B-56D4-8D7F-3D6D4DB260F2",
  "ErrorTaskId": "t-0mqaj5hnyofczv****",
  "SuccessCount": "2",
  "ErrorCode": "mst.errorcode.success.errormessage"
}

錯誤碼

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

變更歷史

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