alibaba.dt.onecompare.indicatorjob.create (创建指标检测任务)

创建数据指标检测任务

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
indicator_job_vo IndicatorJobVO 可选 指标检测任务
  • └ run_project
  • String
  • 必须
  • wl_rec_test_dev
  • 运行项目空间
  • job_alarm_method
  • AlarmType []
  • 可选
  • [{"detail":"","type":"ding"},{"detail":"","type":"mail"},{"detail":"","type":"phone"},{"detail":"","type":"msg"} {"detail":"https://oapi.dingtalk.com/robot/send?access_token=XXX","type":"dinggroup"}]
  • 通知方式 "电话", "钉钉", "短信","邮件"
  • └ detail
  • String
  • 可选
  • 钉钉
  • 通知方式名称
  • └ type
  • String
  • 可选
  • ding
  • 通知方式
  • └ table_name
  • String
  • 可选
  • wl_rec_test.dwd_dt_moe_one_log_url_access_wide_di
  • 检测表名
  • └ public_access_id
  • String
  • 可选
  • XXXX
  • 公共accessId,不填采用个人的ak
  • └ where_filter
  • String
  • 可选
  • app_name='datapro'
  • 表过滤条件
  • └ partition
  • String
  • 可选
  • ds=${yyyymmdd-2}
  • 表分区
  • └ performance_param
  • String
  • 可选
  • set odps.sql.mapper.split.size=1111;
  • 性能参数
  • job_cycle
  • TimerSchema
  • 可选
  • 调度周期和依赖调度。不调度:{"offset":"-1","rate":"pause"} offsetLower可不设置
  • └ offset
  • String
  • 可选
  • 10
  • 时间偏移
  • └ rate
  • String
  • 可选
  • pause
  • 调度周期
  • └ odps_mr_job_id
  • String
  • 可选
  • 未用
  • 未用
  • └ result_type
  • String []
  • 可选
  • 1,2
  • 结果类型,1:FAILED,2:UNPASS ,3: SUCCESS,根据结果状态进行报警
  • └ job_name
  • String
  • 可选
  • 指标检测api测试
  • 任务名称
  • receiver_emp_info
  • SimpleUser []
  • 可选
  • [{"empId":"041619","empName":"夏冰"}]
  • 告警人接收信息
  • └ emp_id
  • String
  • 可选
  • 041619
  • 告警接收人工号
  • └ emp_name
  • String
  • 可选
  • 夏冰
  • 告警接收人花名
  • └ schema_detail
  • String
  • 可选
  • 未用
  • 未用
  • └ schedule_type
  • Number
  • 可选
  • 1
  • 1:周期调度,2:依赖调度
  • └ dependent_info
  • String
  • 可选
  • 225699785
  • 1依赖的节点id,逗号分割
  • └ is_alarm
  • Number
  • 可选
  • 1
  • 是否告警,1告警,0不告警
  • └ public_access_key
  • String
  • 可选
  • XXX
  • 公共AK,可不配置,不配置采用当前用户的AK
  • rule_infos
  • IndicatorRuleInfoVO []
  • 可选
  • 见文档
  • 可见文档:https://aliyuque.antfin.com/q.data/aqs8gl/kuunbsx6a14lpam1?singleDoc# 《rule_infos的输入说明》
  • └ group_condition
  • String []
  • 可选
  • ["ds"]
  • 当多表多字段对比指标时可能会填写表示对比表1的group条件
  • └ data_fileds
  • String []
  • 可选
  • ["ds"]
  • 见文档
  • └ config_example
  • String
  • 可选
  • 不用填
  • 不用填
  • └ type
  • Number
  • 可选
  • 0
  • 指标类型:0:整表级别 1:字段类型 2:字段比较类型 3:自定义SQL
  • └ support_rule_check_type
  • String
  • 可选
  • 文档里说明
  • 给到前端用于展示用户支持选择的类型;多个逗号分隔;例如字段比较;支持>,<,=,!=等
  • └ result_example
  • String
  • 可选
  • 不用填
  • 不用填
  • └ table_name
  • String
  • 可选
  • 文档里说明
  • 文档里说明
  • └ rule_value
  • String
  • 可选
  • 文档里说明
  • 文档里说明
  • └ compare_table_where_condition
  • String
  • 可选
  • 文档里说明
  • 文档里说明
  • └ compare_table_group_condition
  • String []
  • 可选
  • 文档里说明
  • 文档里说明
  • └ config_example_explain
  • String
  • 可选
  • 文档里说明
  • 文档里说明
  • └ rule_type
  • String
  • 可选
  • 文档里说明
  • 文档里说明
  • └ rule_name
  • String
  • 可选
  • 文档里说明
  • 文档里说明
  • └ result_expect_value
  • String
  • 可选
  • 文档里说明
  • 文档里说明
  • └ show_type
  • Number
  • 可选
  • 0
  • 文档里说明
  • └ id
  • Number
  • 可选
  • 123
  • 文档里说明
  • └ gen_type
  • Number
  • 可选
  • 2
  • 文档里说明
  • └ is_multi_choose
  • Boolean
  • 可选
  • true
  • 文档里说明
  • └ default_result_check_type
  • String
  • 可选
  • 文档里说明
  • 文档里说明
  • └ compare_table_partition
  • String
  • 可选
  • 文档里说明
  • 文档里说明
  • └ where_condition
  • String
  • 可选
  • 文档里说明
  • 文档里说明
  • └ support_result_check_type
  • String
  • 可选
  • 文档里说明
  • 文档里说明
  • └ default_result_check_value
  • String
  • 可选
  • 文档里说明
  • 文档里说明
  • └ compare_table_data_fileds
  • String []
  • 可选
  • 文档里说明
  • 文档里说明
  • └ descrption
  • String
  • 可选
  • 文档里说明
  • 文档里说明
  • └ result_operator
  • String
  • 可选
  • 文档里说明
  • 文档里说明
  • └ name
  • String
  • 可选
  • 文档里说明
  • 文档里说明
  • └ compare_table
  • String
  • 可选
  • 文档里说明
  • 文档里说明
  • └ compare_table_key_fileds
  • String []
  • 可选
  • 文档里说明
  • 文档里说明
  • └ compare_fileds
  • String []
  • 可选
  • 文档里说明
  • 文档里说明
  • └ key_fileds
  • String []
  • 可选
  • 文档里说明
  • 文档里说明
  • └ result_show_type
  • Number
  • 可选
  • 0
  • 文档里说明
  • └ self_define_sql
  • String
  • 可选
  • 文档里说明
  • 文档里说明
  • └ is_result_percent
  • Number
  • 可选
  • 0
  • 文档里说明
  • └ data_source_type
  • String
  • 可选
  • 文档里说明
  • 文档里说明
  • └ result_example_explain
  • String
  • 可选
  • 文档里说明
  • 文档里说明
  • └ default_rule_check_type
  • String
  • 可选
  • 文档里说明
  • 文档里说明
  • └ project_name
  • String
  • 可选
  • 夏冰冒烟对比项目空间
  • 指标检测项目名称
  • └ project_id
  • Number
  • 可选
  • 2997
  • 项目id
  • └ data_source_type
  • String
  • 可选
  • ODPS
  • 数据源类型
sso_ticket String 可选 0a44ee7b1c994bea953ce186cedbb006a3415700 从登录态创建的ssoTicket
app_code String 可选 1b7d1e7c9cd94274a04e833713a3b575 调用方的buc.app-code, 注意区分日常和线上环境

响应参数

名称 类型 示例值 描述
data Number 36574 创建的任务id
success2 Boolean true 是否成功
error_code2 Number 0 错误码
cause2 String null 出错原因
message2 String null 出错信息

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaDtOnecompareIndicatorjobCreateRequest req = new AlibabaDtOnecompareIndicatorjobCreateRequest();
AlibabaDtOnecompareIndicatorjobCreateRequest.IndicatorJobVO obj1 = new AlibabaDtOnecompareIndicatorjobCreateRequest.IndicatorJobVO();
obj1.setRunProject("wl_rec_test_dev");
List<AlibabaDtOnecompareIndicatorjobCreateRequest.AlarmType> list3 = new ArrayList<AlibabaDtOnecompareIndicatorjobCreateRequest.AlarmType>();
AlibabaDtOnecompareIndicatorjobCreateRequest.AlarmType obj4 = new AlibabaDtOnecompareIndicatorjobCreateRequest.AlarmType();
list3.add(obj4);
obj4.setDetail("钉钉");
obj4.setType("ding");
obj1.setJobAlarmMethod(list3);
obj1.setTableName("wl_rec_test.dwd_dt_moe_one_log_url_access_wide_di");
obj1.setPublicAccessId("XXXX");
obj1.setWhereFilter("app_name='datapro'");
obj1.setPartition("ds=${yyyymmdd-2}");
obj1.setPerformanceParam("set odps.sql.mapper.split.size=1111;");
AlibabaDtOnecompareIndicatorjobCreateRequest.TimerSchema obj5 = new AlibabaDtOnecompareIndicatorjobCreateRequest.TimerSchema();
obj5.setOffset("10");
obj5.setRate("pause");
obj1.setJobCycle(obj5);
obj1.setOdpsMrJobId("未用");
obj1.setResultType("1,2");
obj1.setJobName("指标检测api测试");
List<AlibabaDtOnecompareIndicatorjobCreateRequest.SimpleUser> list7 = new ArrayList<AlibabaDtOnecompareIndicatorjobCreateRequest.SimpleUser>();
AlibabaDtOnecompareIndicatorjobCreateRequest.SimpleUser obj8 = new AlibabaDtOnecompareIndicatorjobCreateRequest.SimpleUser();
list7.add(obj8);
obj8.setEmpId("041619");
obj8.setEmpName("夏冰");
obj1.setReceiverEmpInfo(list7);
obj1.setSchemaDetail("未用");
obj1.setScheduleType(1L);
obj1.setDependentInfo("225699785");
obj1.setIsAlarm(1L);
obj1.setPublicAccessKey("XXX");
List<AlibabaDtOnecompareIndicatorjobCreateRequest.IndicatorRuleInfoVO> list10 = new ArrayList<AlibabaDtOnecompareIndicatorjobCreateRequest.IndicatorRuleInfoVO>();
AlibabaDtOnecompareIndicatorjobCreateRequest.IndicatorRuleInfoVO obj11 = new AlibabaDtOnecompareIndicatorjobCreateRequest.IndicatorRuleInfoVO();
list10.add(obj11);
obj11.setGroupCondition(""ds"");
obj11.setDataFileds(""ds"");
obj11.setConfigExample("不用填");
obj11.setType(0L);
obj11.setSupportRuleCheckType("文档里说明");
obj11.setResultExample("不用填");
obj11.setTableName("文档里说明");
obj11.setRuleValue("文档里说明");
obj11.setCompareTableWhereCondition("文档里说明");
obj11.setCompareTableGroupCondition("文档里说明");
obj11.setConfigExampleExplain("文档里说明");
obj11.setRuleType("文档里说明");
obj11.setRuleName("文档里说明");
obj11.setResultExpectValue("文档里说明");
obj11.setShowType(0L);
obj11.setId(123L);
obj11.setGenType(2L);
obj11.setIsMultiChoose(true);
obj11.setDefaultResultCheckType("文档里说明");
obj11.setCompareTablePartition("文档里说明");
obj11.setWhereCondition("文档里说明");
obj11.setSupportResultCheckType("文档里说明");
obj11.setDefaultResultCheckValue("文档里说明");
obj11.setCompareTableDataFileds("文档里说明");
obj11.setDescrption("文档里说明");
obj11.setResultOperator("文档里说明");
obj11.setName("文档里说明");
obj11.setCompareTable("文档里说明");
obj11.setCompareTableKeyFileds("文档里说明");
obj11.setCompareFileds("文档里说明");
obj11.setKeyFileds("文档里说明");
obj11.setResultShowType(0L);
obj11.setSelfDefineSql("文档里说明");
obj11.setIsResultPercent(0L);
obj11.setDataSourceType("文档里说明");
obj11.setResultExampleExplain("文档里说明");
obj11.setDefaultRuleCheckType("文档里说明");
obj1.setRuleInfos(list10);
obj1.setProjectName("夏冰冒烟对比项目空间");
obj1.setProjectId(2997L);
obj1.setDataSourceType("ODPS");
req.setIndicatorJobVo(obj1);
req.setSsoTicket("0a44ee7b1c994bea953ce186cedbb006a3415700");
req.setAppCode("1b7d1e7c9cd94274a04e833713a3b575");
AlibabaDtOnecompareIndicatorjobCreateResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<alibaba_dt_onecompare_indicatorjob_create_response>
    <data>36574</data>
    <success2>true</success2>
    <error_code2>0</error_code2>
    <cause2>null</cause2>
    <message2>null</message2>
</alibaba_dt_onecompare_indicatorjob_create_response>

异常示例

  • XML示例
  • JSON示例
<error_response>
    <code>50</code>
    <msg>Remote service error</msg>
    <sub_code>isv.invalid-parameter</sub_code>
    <sub_msg>非法参数</sub_msg>
</error_response>

错误码解释

错误码 错误描述 解决方案

API工具

如何获得此API

FAQ

返回
顶部