全部产品
Search
文档中心

数据管理 DMS:PauseDataCorrectSQLJob - 暂停执行数据变更工单SQL任务

更新时间:Nov 06, 2024

暂停执行数据变更工单SQL任务。

接口说明

仅管控模式为安全协同的数据库实例可调用此 API。

调试

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

授权信息

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

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

请求参数

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

数据变更工单 ID,可通过调用接口 ListOrders 获取该参数的值。

43253
Typestring

暂停类型,取值如下:

  • ALL:全部暂停
  • SINGLE:暂停单个任务
SINGLE
JobIdlong

SQL 任务 ID,可通过调用接口 GetDataCorrectTaskDetailListDBTaskSQLJob 获取该参数的值。

说明 如果 type = SINGLE,需要传递 JobId 确认需要重试的 SQL 任务 ID。
43253
Tidlong

租户 ID,可通过调用接口 GetUserActiveTenant 获取该参数的值。

4325

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID。

335C5BC8-490C-56EF-BDDE-94A4B53FEB72
Successboolean

请求是否成功,返回值如下:

  • true:请求成功
  • false:请求失败
true
ErrorMessagestring

错误信息。

UnknownError
ErrorCodestring

错误码。

UnknownError

示例

正常返回示例

JSON格式

{
  "RequestId": "335C5BC8-490C-56EF-BDDE-94A4B53FEB72",
  "Success": true,
  "ErrorMessage": "UnknownError",
  "ErrorCode": "UnknownError"
}

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史