文档首页/ 数据治理中心 DataArts Studio/ API参考/ 数据质量API/ 质量作业接口/ 操作质量作业调度 - OperationQualityTaskSchedule
更新时间:2025-12-18 GMT+08:00
分享

操作质量作业调度 - OperationQualityTaskSchedule

功能介绍

该接口用于数据质量的质量作业操作,可通过该接口开启质量作业调度或者停止调度。

调用方法

请参见如何调用API

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,当前API调用无需身份策略权限。

URI

POST /v2/{project_id}/quality/quality-tasks/action

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,获取方法请参见项目ID和账号ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

workspace

String

DataArts Studio工作空间ID,获取方法请参见实例ID和工作空间ID

X-Auth-Token

String

IAM Token,Token获取请参见认证鉴权

表3 请求Body参数

参数

是否必选

参数类型

描述

action

String

操作动作,start:开启调度,stop:停止调度。

rule_id

String

质量作业ID,可以通过获取质量作业列表获取质量作业ID。

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

message

String

请求返回的提示信息

状态码:400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码,如DQC.0000表示请求处理成功。

error_msg

String

错误信息。

状态码:500

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码,如DQC.0000表示请求处理成功。

error_msg

String

错误信息。

请求示例

开启调度。

POST https://{endpoint}/v2/{project_id}/quality/quality-tasks/action

{
  "action" : "start",
  "rule_id" : 1200372516590559232
}

响应示例

状态码

状态码

描述

200

Success

400

BadRequest

500

INTERNAL SERVER ERROR

相关文档