ModifyTaskInfo - 修改任务操作

更新时间:
复制 MD 格式

进行任务操作,当前支持修改任务执行时间点。

调试

您可以在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"
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情。