淘宝开放平台 - 文档中心

请求地址：

环境	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。

名称	类型	是否必须	描述
context	DFContext	可选	上下文参数
└ run_id String 可选 1234 运行ID └ token String 可选 7110eda4d09e062aa5e4a390b0a572ac0d2c0220 用户TOKEN └ extra String 可选 {} 业务参数
req	DFRequest	可选	请求参数
param TaskParam 可选 {} 任务参数 └ task_id String 可选 1234 任务ID └ task_type String 可选 PERSPECT 任务类型 └ task_param String 可选 {} 输入参数

名称	类型	示例值	描述
result	RCode	{}	返回结果
data TaskResult {} 任务数据 └ task_id String 1234 任务ID └ status String SUCCESS 任务状态 └ data String PROCESS 任务进度 └ task_info String {} 任务运行信息 └ errcode Number 577040010000 错误码 └ errmsg String 系统内部错误错误信息 └ codeclass String INTERNAL_ERROR 错误级别

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaDatafactoryTaskRunRequest req = new AlibabaDatafactoryTaskRunRequest();
AlibabaDatafactoryTaskRunRequest.DFContext obj1 = new AlibabaDatafactoryTaskRunRequest.DFContext();
obj1.setRunId("1234");
obj1.setToken("7110eda4d09e062aa5e4a390b0a572ac0d2c0220");
obj1.setExtra("{}");
req.setContext(obj1);
AlibabaDatafactoryTaskRunRequest.DFRequest obj2 = new AlibabaDatafactoryTaskRunRequest.DFRequest();
AlibabaDatafactoryTaskRunRequest.TaskParam obj3 = new AlibabaDatafactoryTaskRunRequest.TaskParam();
obj3.setTaskId("1234");
obj3.setTaskType("PERSPECT");
obj3.setTaskParam("{}");
obj2.setParam(obj3);
req.setReq(obj2);
AlibabaDatafactoryTaskRunResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaDatafactoryTaskRunRequest req = new AlibabaDatafactoryTaskRunRequest();
AlibabaDatafactoryTaskRunRequest.DFContextDomain obj1 = new AlibabaDatafactoryTaskRunRequest.DFContextDomain();
obj1.RunId = "1234";
obj1.Token = "7110eda4d09e062aa5e4a390b0a572ac0d2c0220";
obj1.Extra = "{}";
req.Context_ = obj1;
AlibabaDatafactoryTaskRunRequest.DFRequestDomain obj2 = new AlibabaDatafactoryTaskRunRequest.DFRequestDomain();
AlibabaDatafactoryTaskRunRequest.TaskParamDomain obj3 = new AlibabaDatafactoryTaskRunRequest.TaskParamDomain();
obj3.TaskId = "1234";
obj3.TaskType = "PERSPECT";
obj3.TaskParam = "{}";
obj2.Param= obj3;
req.Req_ = obj2;
AlibabaDatafactoryTaskRunResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaDatafactoryTaskRunRequest;
$context = new DFContext;
$context->run_id="1234";
$context->token="7110eda4d09e062aa5e4a390b0a572ac0d2c0220";
$context->extra="{}";
$req->setContext(json_encode($context));
$req = new DFRequest;
$param = new TaskParam;
$param->task_id="1234";
$param->task_type="PERSPECT";
$param->task_param="{}";
$req->setParam(json_encode($param));
$req->setReq(json_encode($req));
$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.datafactory.task.run' \
-d 'partner_id=apidoc' \
-d 'sign=C770612EA346E30DE2FD54D32B8F878A' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-05+17%3A29%3A30' \
-d 'v=2.0' \
-d 'context=%7B%7D' \
-d 'req=%7B%7D'

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

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

req.context="{}"
req.req="{}"
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.datafactory.task.run");
add_param(pRequest,"context","数据结构JSON示例");
add_param(pRequest,"req","数据结构JSON示例");
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',
	'REST_URL': 'http://gw.api.taobao.com/router/rest'
});

client.execute('alibaba.datafactory.task.run', {
	'context':'数据结构JSON示例',
	'req':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_datafactory_task_run_response>
    <result>
        <data>
            <task_id>1234</task_id>
            <status>SUCCESS</status>
            <data>PROCESS</data>
            <task_info>{}</task_info>
        </data>
        <errcode>577040010000</errcode>
        <errmsg>系统内部错误</errmsg>
        <codeclass>INTERNAL_ERROR</codeclass>
    </result>
</alibaba_datafactory_task_run_response>

{
    "alibaba_datafactory_task_run_response":{
        "result":{
            "data":{
                "task_id":"1234",
                "status":"SUCCESS",
                "data":"PROCESS",
                "task_info":"{}"
            },
            "errcode":577040010000,
            "errmsg":"系统内部错误",
            "codeclass":"INTERNAL_ERROR"
        }
    }
}

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.datafactory.task.run (运行分析任务)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ