调用CreateQualityRule创建质量监控规则。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
dataworks:* | Write |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
BlockType | integer | 是 | 规则的强弱:0 表示弱规则,1 表示强规则。 | 0 |
EntityId | long | 是 | 分区表达式的 ID。 | 15224 |
Comment | string | 否 | 规则的描述信息。 | 验证 |
Checker | integer | 是 | 校验器的 ID。 | 9 |
ExpectValue | string | 否 | 期望值。 | 0 |
Trend | string | 否 | 校验结果的趋势。取值如下:
| abs |
MethodName | string | 是 | 采样方。如果是自定义 SQL,该参数的值为 user_defined。 | count/table_count |
Operator | string | 否 | 比较符。包括>、>=、=、≠、<和<=等。 说明
当 Checker=9 时,Operator 为必选参数。
| > |
ProjectName | string | 是 | 引擎或者数据源的名称。 | autotest |
Property | string | 否 | 规则的字段。如果是表级别校验,行数为 table_count、大小为 table_size 字段。 | table_id |
PropertyType | string | 否 | 字段的类型,表级 table,字段级填写 bigint 等。 | bigint |
RuleType | integer | 是 | 规则的类型:0 表示系统定义、1 表示用户自定义、2 表示项目级规则。 | 0 |
WhereCondition | string | 否 | 过滤条件或自定义 SQL。 | table_id>1 |
CriticalThreshold | string | 否 | 红色告警阈值。表示与样本预期的偏离程度。您可以根据业务需求自定义该阈值。使用强规则并触发红色阈值,会阻塞调度任务。 | 20 |
WarningThreshold | string | 否 | 橙色告警阈值。表示与样本预期的偏离程度,您可以根据业务需求自定义该阈值。 | 10 |
TemplateId | integer | 否 | 模板的 ID。 | 7 |
RuleName | string | 是 | 规则的名称。 | 1234 |
PredictType | integer | 是 | 是否为动态阈值:0 表示非动态阈值、2 表示动态阈值规则。 | 0 |
ProjectId | long | 是 | DataWorks 工作空间的 ID。您可以登录 DataWorks 控制台,进入工作空间配置页面获取工作空间 ID。 | 10000 |
TaskSetting | string | 否 | 在自定义规则之前插入的变量设置,格式如:x=a,y=b。 | x=a,y=b |
返回参数
示例
正常返回示例
JSON
格式
{
"HttpStatusCode": 200,
"Data": "12345",
"ErrorMessage": "You have no permission.",
"RequestId": "ecb967ec-c137-48****",
"ErrorCode": "401",
"Success": true
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 | ||||
---|---|---|---|---|---|---|
2023-11-15 | OpenAPI 入参发生变更 | 看变更集 | ||||
| ||||||
2023-03-08 | OpenAPI 入参发生变更 | 看变更集 | ||||
|