全部产品
Search
文档中心

云数据库 MongoDB:ModifyTaskInfo - 任务中心修改任务信息

更新时间:Sep 03, 2024

任务操作,修改任务中心的任务信息。

接口说明

根据任务当前状态进行相关操作,支持的操作需根据 接口获得的任务 actionInfo 识别。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
dds:ModifyTaskInfoupdate
  • 全部资源
    *

请求参数

名称类型必填描述示例值
RegionIdstring

地域 ID,您可以调用 DescribeRegions 查询。

cn-hangzhou
TaskIdstring

任务 id,多个英文逗号分隔,最多支持 10 个。

t-83br18hlpdrw3uxxxx
StepNamestring

当前用户可见的步骤名。

exec_task
TaskActionstring

操作名,值为 DescribeHistoryTasks 得到的 actionInfo 内相应状态对应的操作 action 名称。

modifySwitchTime
ActionParamsstring

动作相关的参数,根据业务需要扩展,不同的 taskAction 名需传不同的值。

{\"recoverMode\":\"immediate\"}

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID。

6163731A-XXXX-XXXX-B934-3388DE70C217
ErrorTaskIdstring

失败的任务 ID,遇到一个失败即返回。

""
SuccessCountstring

成功记录数。

1
ErrorCodestring

失败错误码,同接口错误码。

""

示例

正常返回示例

JSON格式

{
  "RequestId": "6163731A-XXXX-XXXX-B934-3388DE70C217",
  "ErrorTaskId": "\"\"",
  "SuccessCount": "1",
  "ErrorCode": "\"\""
}

错误码

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

变更历史

变更时间变更内容概要操作
2024-04-08API 内部配置变更,不影响调用查看变更详情