文档

CancelScheduleTasks - 取消定时任务

更新时间:

取消开始时间尚未到达的定时任务。

调试

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

授权信息

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

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

请求参数

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

集群 ID。

说明 您可以调用 DescribeDBClusters 接口查看目标地域下所有的集群信息,包括集群 ID。
pc-**************
TaskIdstring

需要被取消的定时任务的任务 ID。

说明
  • 您可以调用 DescribeScheduleTasks 接口查看当前账号下所有计划任务的信息,包括任务 ID。
  • 仅任务状态为等待执行(即Status参数的返回值为pending)的任务支持被取消。
  • ec8c4723-eac5-4f12-becb-01ac08******
    ResourceGroupIdstring

    资源组 ID。

    rg-************

    返回参数

    名称类型描述示例值
    object
    RequestIdstring

    请求 ID。

    7F2007D3-7E74-4ECB-89A8-BF130D******
    Successboolean

    请求结果。

    true

    示例

    正常返回示例

    JSON格式

    {
      "RequestId": "7F2007D3-7E74-4ECB-89A8-BF130D******",
      "Success": true
    }

    错误码

    HTTP status code错误码错误信息描述
    400InvalidDBNodeId.MalformedThe specified parameter DBNodeId is not valid.指定的参数DBNodeId无效。

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

    • 本页导读 (0)