CreateDataQualityEvaluationTask_大数据开发治理平台 DataWorks_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

需要购买 DataWorks 基础版及以上版本才能使用。

流控信息

当前云产品API请求速率暂未透出。

授权信息

当前云产品暂无权限信息透出。

请求参数

字段名称字段详情
Targetobject

数据质量监控对象

Descriptionstring

质量监控任务描述

示例值:OpenAPI create a data quality monitoring test字符长度 <= 65535
Namestring

质量监控任务名称

示例值:OpenAPI create a data quality monitoring test 字符长度 <= 255
RuntimeConfstring

扩展配置,JSON 格式的字符串,只对 EMR 类型的数据质量监控生效。展开详情

示例值:{ "queue": "default", "sqlEngine": "SPARK_SQL" }
Triggerobject

数据质量校验任务的触发配置

ProjectIdinteger<int64>

DataWorks 工作空间的 ID。您可以登录 DataWorks 控制台,进入工作空间管理页面获取 ID。展开详情

注意 该字段类型为 Long,在序列化/反序列化的过程中可能导致精度丢失,请注意数值不得大于 9007199254740991。
示例值:10000参考取值来源:
    CreateProject
Hooksarray<object>

回调设置

Notificationsobject

通知订阅配置

DataSourceIdinteger<int64>

数据源 ID,您可以调用 ListDataSources 获取数据源的 ID。

注意 该字段类型为 Long,在序列化/反序列化的过程中可能导致精度丢失,请注意数值不得大于 9007199254740991。
示例值:1参考取值来源:
    CreateDataSourceSharedRule
DataQualityRulesarray<object>

数据质量监控关联的数据质量规则列表。如果设置了 DataQualityRule.Id,则把 Id 对应的规则关联到新建质量监控中;如果没有设置,则用其他字段创建一个新的规则,关联到新建的质量监控中。

返回参数

字段名称字段详情
RequestIdstring

Id of the request

示例值:2d9ce-38ef-4923-baf6-391a7e656
Idinteger<int64>

新建的数据质量监控 ID。

注意 请注意,该值为 Long 类型,在某些语言中可能存在精度丢失的风险,请小心使用。
示例值:10001

返回示例

错误码

全局错误码
HTTP 状态码错误码错误信息操作
400
IdempotentParameterMismatch
The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.诊断

变更历史

变更时间变更内容概要操作
2025-03-27
变更请求参数Target
变更请求参数Trigger
变更请求参数ProjectId
变更请求参数DataSourceId
2025-01-15
变更请求参数DataQualityRules
2024-12-23
变更请求参数Target
变更请求参数Description
变更请求参数Name
变更请求参数Notifications
变更请求参数DataQualityRules
2024-12-04
新增OpenAPI,创建数据质量监控

相关示例