调用GetQualityRule获取校验规则的信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
dataworks:* | Read |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RuleId | long | 是 | 校验规则的 ID。您可以调用 ListQualityRules 接口查看 RuleId 的相关信息。 | 1234 |
ProjectName | string | 是 | 引擎或者数据源的名称。 | autotest |
ProjectId | long | 是 | DataWorks 项目空间 ID。 | 12345 |
返回参数
示例
正常返回示例
JSON
格式
{
"HttpStatusCode": 200,
"RequestId": "576b9457-2cf5-4****",
"ErrorMessage": "You have no permission.",
"ErrorCode": "401",
"Success": true,
"Data": {
"BlockType": 1,
"OnDutyAccountName": "test",
"WarningThreshold": "10",
"Property": "id",
"RuleType": 0,
"Comment": "校验主键唯一",
"OnDuty": "1822931****",
"Checker": 9,
"FixCheck": true,
"MethodId": 8,
"CriticalThreshold": "20",
"PredictType": 0,
"TemplateName": "SQL task table rows, 1,7, 30 days fluctuation test",
"CheckerName": "compared with a fixed value",
"RuleName": "查看表波动",
"MethodName": "table_count",
"EntityId": 165523,
"WhereCondition": "id>10",
"Operator": ">=",
"ExpectValue": "30",
"Trend": "abs",
"TemplateId": 7,
"Id": 123232,
"OpenSwitch": true,
"TaskSetting": ""
}
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 | ||||
---|---|---|---|---|---|---|
2024-06-18 | OpenAPI 返回结构发生变更 | 看变更集 | ||||
| ||||||
2023-08-29 | API 内部配置变更,不影响调用 | 看变更集 | ||||
| ||||||
2023-03-08 | OpenAPI 入参发生变更 | 看变更集 | ||||
|