淘宝开放平台 - 文档中心

请求地址：

环境	HTTP请求地址	HTTPS请求地址
正式环境	http://gw.api.taobao.com/router/rest	https://eco.taobao.com/router/rest

公共请求参数：

名称	类型	是否必须	描述
method	String	是	API接口名称。
app_key	String	是	TOP分配给应用的AppKey。
target_app_key	String	否	被调用的目标AppKey，仅当被调用的API为第三方ISV提供时有效。
sign_method	String	是	签名的摘要算法，可选值为：hmac，md5。
sign	String	是	API输入参数签名结果，签名算法介绍请点击这里。
session	String	否	用户登录授权成功后，TOP颁发给应用的授权信息，详细介绍请点击这里。当此API的标签上注明：“需要授权”，则此参数必传；“不需要授权”，则此参数不需要传；“可选授权”，则此参数为可选。
timestamp	String	是	时间戳，格式为yyyy-MM-dd HH:mm:ss，时区为GMT+8，例如：2015-01-01 12:00:00。淘宝API服务端允许客户端请求最大时间误差为10分钟。
format	String	否	响应格式。默认为xml格式，可选值：xml，json。
v	String	是	API协议版本，可选值：2.0。
partner_id	String	否	合作伙伴身份标识。
simplify	Boolean	否	是否采用精简JSON返回格式，仅当format=json时有效，默认值为：false。

名称	类型	是否必须	示例值	描述
explorate_job_vo	ExplorateJobVO	可选		总参数
└ data_read_mode String 必须 table 读取模式table/sql └ run_project String 必须 tbods_dev 运行project job_alarm_method AlarmType [] 可选 [{"type":"ding","detail":""}] 告警方式 └ detail String 可选 “” 当type为dinggroup填写机器人的webhook └ type String 可选 ding 告警类型ding/mail/msg/phone/dinggroup └ data_fields String 必须 table_name,ds 探查字段,多个用逗号分隔 └ table_name String 可选 udap_meta.hangyetest 表名:当dataSourceType = ‘ODPS/HOLO’，dataReadMode =‘table’ 时必填 └ data_source_id Number 可选 1 数据源id:类型为HOLO时必填 └ partition String 可选 ds=${yyyymmdd-1} 分区:当dataSourceType为‘ODPS’,dataReadMode =‘table’选填 └ key_fields String 可选 id 主键字段 └ job_name String 必须 udap_meta.hangye_create_test3表探查任务名称 receiver_emp_info SimpleUser [] 可选 [{"empId":"041619","empName":"夏冰"}] 接收人 └ emp_id String 可选 041619 工号 └ emp_name String 可选夏冰花名 └ schema_detail String 必须 owner\|string;table_name\|string;life_cycle\|string;ds\|string 表字段详情schemaDetail └ is_alarm Number 必须 0 播报配置：0:关闭，1:开启 └ project_name String 必须图治产品数据质量项目空间 └ project_id Number 必须 4603 项目id job_owner_emp_info SimpleUser [] 必须 [{"empId":"041619","empName":"夏冰"}] owner信息 └ emp_id String 必须 041619 工号 └ emp_name String 必须夏冰花名 └ where_filter String 可选 leaf_cate_name where筛选：当dataSourceType为‘ODPS/HOLO’，dataReadMode =‘table’时选填 └ data_source_type String 必须 ODPS ODPS,HOLO └ sql_detail String 可选 select table_name udap_meta.hangye_create_test3 sql：当读取模式为sql时必填
sso_ticket	String	必须	0a44ee7b1c994bea953ce186cedbb006a3415700	从登录态创建的ssoTicket
app_code	String	必须	1b7d1e7c9cd94274a04e833713a3b575	调用方的buc.app-code，注意区分日常和线上环境

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

JAVA
.NET
PHP
CURL
Python
C/C++
NodeJS

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaDtOnecompareExplorateCreateRequest req = new AlibabaDtOnecompareExplorateCreateRequest();
AlibabaDtOnecompareExplorateCreateRequest.ExplorateJobVO obj1 = new AlibabaDtOnecompareExplorateCreateRequest.ExplorateJobVO();
obj1.setDataReadMode("table");
obj1.setRunProject("tbods_dev");
List<AlibabaDtOnecompareExplorateCreateRequest.AlarmType> list3 = new ArrayList<AlibabaDtOnecompareExplorateCreateRequest.AlarmType>();
AlibabaDtOnecompareExplorateCreateRequest.AlarmType obj4 = new AlibabaDtOnecompareExplorateCreateRequest.AlarmType();
list3.add(obj4);
obj4.setDetail("“”");
obj4.setType("ding");
obj1.setJobAlarmMethod(list3);
obj1.setDataFields("table_name,ds");
obj1.setTableName("udap_meta.hangyetest");
obj1.setDataSourceId(1L);
obj1.setPartition("ds=${yyyymmdd-1}");
obj1.setKeyFields("id");
obj1.setJobName("udap_meta.hangye_create_test3表探查");
List<AlibabaDtOnecompareExplorateCreateRequest.SimpleUser> list6 = new ArrayList<AlibabaDtOnecompareExplorateCreateRequest.SimpleUser>();
AlibabaDtOnecompareExplorateCreateRequest.SimpleUser obj7 = new AlibabaDtOnecompareExplorateCreateRequest.SimpleUser();
list6.add(obj7);
obj7.setEmpId("041619");
obj7.setEmpName("夏冰");
obj1.setReceiverEmpInfo(list6);
obj1.setSchemaDetail("owner|string;table_name|string;life_cycle|string;ds|string");
obj1.setIsAlarm(0L);
obj1.setProjectName("图治产品数据质量");
obj1.setProjectId(4603L);
List<AlibabaDtOnecompareExplorateCreateRequest.SimpleUser> list9 = new ArrayList<AlibabaDtOnecompareExplorateCreateRequest.SimpleUser>();
AlibabaDtOnecompareExplorateCreateRequest.SimpleUser obj10 = new AlibabaDtOnecompareExplorateCreateRequest.SimpleUser();
list9.add(obj10);
obj10.setEmpId("041619");
obj10.setEmpName("夏冰");
obj1.setJobOwnerEmpInfo(list9);
obj1.setWhereFilter("leaf_cate_name");
obj1.setDataSourceType("ODPS");
obj1.setSqlDetail("select table_name udap_meta.hangye_create_test3");
req.setExplorateJobVo(obj1);
req.setSsoTicket("0a44ee7b1c994bea953ce186cedbb006a3415700");
req.setAppCode("1b7d1e7c9cd94274a04e833713a3b575");
AlibabaDtOnecompareExplorateCreateResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaDtOnecompareExplorateCreateRequest req = new AlibabaDtOnecompareExplorateCreateRequest();
AlibabaDtOnecompareExplorateCreateRequest.ExplorateJobVODomain obj1 = new AlibabaDtOnecompareExplorateCreateRequest.ExplorateJobVODomain();
obj1.DataReadMode = "table";
obj1.RunProject = "tbods_dev";
List<AlibabaDtOnecompareExplorateCreateRequest.AlarmTypeDomain> list3 = new List<AlibabaDtOnecompareExplorateCreateRequest.AlarmTypeDomain>();
AlibabaDtOnecompareExplorateCreateRequest.AlarmTypeDomain obj4 = new AlibabaDtOnecompareExplorateCreateRequest.AlarmTypeDomain();
list3.Add(obj4);
obj4.Detail = "“”";
obj4.Type = "ding";
obj1.JobAlarmMethod= list3;
obj1.DataFields = "table_name,ds";
obj1.TableName = "udap_meta.hangyetest";
obj1.DataSourceId = 1L;
obj1.Partition = "ds=${yyyymmdd-1}";
obj1.KeyFields = "id";
obj1.JobName = "udap_meta.hangye_create_test3表探查";
List<AlibabaDtOnecompareExplorateCreateRequest.SimpleUserDomain> list6 = new List<AlibabaDtOnecompareExplorateCreateRequest.SimpleUserDomain>();
AlibabaDtOnecompareExplorateCreateRequest.SimpleUserDomain obj7 = new AlibabaDtOnecompareExplorateCreateRequest.SimpleUserDomain();
list6.Add(obj7);
obj7.EmpId = "041619";
obj7.EmpName = "夏冰";
obj1.ReceiverEmpInfo= list6;
obj1.SchemaDetail = "owner|string;table_name|string;life_cycle|string;ds|string";
obj1.IsAlarm = 0L;
obj1.ProjectName = "图治产品数据质量";
obj1.ProjectId = 4603L;
List<AlibabaDtOnecompareExplorateCreateRequest.SimpleUserDomain> list9 = new List<AlibabaDtOnecompareExplorateCreateRequest.SimpleUserDomain>();
AlibabaDtOnecompareExplorateCreateRequest.SimpleUserDomain obj10 = new AlibabaDtOnecompareExplorateCreateRequest.SimpleUserDomain();
list9.Add(obj10);
obj10.EmpId = "041619";
obj10.EmpName = "夏冰";
obj1.JobOwnerEmpInfo= list9;
obj1.WhereFilter = "leaf_cate_name";
obj1.DataSourceType = "ODPS";
obj1.SqlDetail = "select table_name udap_meta.hangye_create_test3";
req.ExplorateJobVo_ = obj1;
req.SsoTicket = "0a44ee7b1c994bea953ce186cedbb006a3415700";
req.AppCode = "1b7d1e7c9cd94274a04e833713a3b575";
AlibabaDtOnecompareExplorateCreateResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaDtOnecompareExplorateCreateRequest;
$explorate_job_vo = new ExplorateJobVO;
$explorate_job_vo->data_read_mode="table";
$explorate_job_vo->run_project="tbods_dev";
$job_alarm_method = new AlarmType;
$job_alarm_method->detail="“”";
$job_alarm_method->type="ding";
$explorate_job_vo->job_alarm_method = $job_alarm_method;
$explorate_job_vo->data_fields="table_name,ds";
$explorate_job_vo->table_name="udap_meta.hangyetest";
$explorate_job_vo->data_source_id="1";
$explorate_job_vo->partition="ds=${yyyymmdd-1}";
$explorate_job_vo->key_fields="id";
$explorate_job_vo->job_name="udap_meta.hangye_create_test3表探查";
$receiver_emp_info = new SimpleUser;
$receiver_emp_info->emp_id="041619";
$receiver_emp_info->emp_name="夏冰";
$explorate_job_vo->receiver_emp_info = $receiver_emp_info;
$explorate_job_vo->schema_detail="owner|string;table_name|string;life_cycle|string;ds|string";
$explorate_job_vo->is_alarm="0";
$explorate_job_vo->project_name="图治产品数据质量";
$explorate_job_vo->project_id="4603";
$job_owner_emp_info = new SimpleUser;
$job_owner_emp_info->emp_id="041619";
$job_owner_emp_info->emp_name="夏冰";
$explorate_job_vo->job_owner_emp_info = $job_owner_emp_info;
$explorate_job_vo->where_filter="leaf_cate_name";
$explorate_job_vo->data_source_type="ODPS";
$explorate_job_vo->sql_detail="select table_name udap_meta.hangye_create_test3";
$req->setExplorateJobVo(json_encode($explorate_job_vo));
$req->setSsoTicket("0a44ee7b1c994bea953ce186cedbb006a3415700");
$req->setAppCode("1b7d1e7c9cd94274a04e833713a3b575");
$resp = $c->execute($req);

curl -X POST 'http://gw.api.taobao.com/router/rest' \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'app_key=12129701' \
-d 'format=json' \
-d 'method=alibaba.dt.onecompare.explorate.create' \
-d 'partner_id=apidoc' \
-d 'sign=04F8E34F8AA600CC410C2C2A0CB55EF9' \
-d 'sign_method=hmac' \
-d 'timestamp=2026-04-02+14%3A56%3A28' \
-d 'v=2.0' \
-d 'app_code=1b7d1e7c9cd94274a04e833713a3b575' \
-d 'explorate_job_vo=null' \
-d 'sso_ticket=0a44ee7b1c994bea953ce186cedbb006a3415700'

# -*- coding: utf-8 -*-
import top.api

req=top.api.AlibabaDtOnecompareExplorateCreateRequest(url,port)
req.set_app_info(top.appinfo(appkey,secret))

req.explorate_job_vo="数据结构示例JSON格式"
req.sso_ticket="0a44ee7b1c994bea953ce186cedbb006a3415700"
req.app_code="1b7d1e7c9cd94274a04e833713a3b575"
try:
	resp= req.getResponse()
	print(resp)
except Exception,e:
	print(e)

pTopRequest pRequest = alloc_top_request();
pTopResponse pResponse = NULL;
pTaobaoClient pClient = alloc_taobao_client(url, appkey, appsecret);
set_api_name(pRequest,"alibaba.dt.onecompare.explorate.create");
add_param(pRequest,"explorate_job_vo","数据结构JSON示例");
add_param(pRequest,"sso_ticket","0a44ee7b1c994bea953ce186cedbb006a3415700");
add_param(pRequest,"app_code","1b7d1e7c9cd94274a04e833713a3b575");
pResponse = top_execute(pClient,pRequest,NULL);
printf("ret code:%d\n",pResponse->code);
if(pResponse->code == 0){
	pTopResponseIterator ite = init_response_iterator(pResponse);
	pResultItem pResultItem = alloc_result_item();
	while(parseNext(ite, pResultItem) == 0){
		printf("%s:%s\n",pResultItem->key,pResultItem->value);
	}
	destroy_response_iterator(ite);
	destroy_result_item(pResultItem);
}
destroy_top_request(pRequest);
destroy_top_response(pResponse);
destroy_taobao_client(pClient);

TopClient = require('./topClient').TopClient;
var client = new TopClient({
	'appkey': 'appkey',
	'appsecret': 'secret',
	'url': 'http://gw.api.taobao.com/router/rest'
});

client.execute('alibaba.dt.onecompare.explorate.create', {
	'explorate_job_vo':'数据结构JSON示例',
	'sso_ticket':'0a44ee7b1c994bea953ce186cedbb006a3415700',
	'app_code':'1b7d1e7c9cd94274a04e833713a3b575'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_dt_onecompare_explorate_create_response>
    <data>1</data>
    <success2>true</success2>
    <error_code2>0</error_code2>
    <cause>null</cause>
    <message2>null</message2>
</alibaba_dt_onecompare_explorate_create_response>

{
    "alibaba_dt_onecompare_explorate_create_response":{
        "data":1,
        "success2":true,
        "error_code2":0,
        "cause":"null",
        "message2":"null"
    }
}

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>

{
	"error_response":{
		"msg":"Remote service error",
		"code":50,
		"sub_msg":"非法参数",
		"sub_code":"isv.invalid-parameter"
	}
}

错误码	错误描述	解决方案

API测试工具错误码查询工具 SDK下载

开放平台

数据API

alibaba.dt.onecompare.explorate.create (创建数据探查任务)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ