淘宝开放平台

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
device_req	DeviceReq	必须			参数
└ device_name String 必须 installer_*_* 安装器的设备名称

名称	类型	示例值	描述
data	ProductUpgradeTask []		升级任务
└ device_name String YZ_OFFSER_888889_MAC 升级目标设备名称 └ install_oss_path String http://xxx.zip 安装包路径 └ install_type String 1 安装方式 └ e_tag String xxx oss的etag标签 └ publish_record_id String 1 发布单ID └ task_expiration_time String 2026-10-01 09:00:00 任务失效截止时间 └ spare_oss_path String http://xxx.zip 备选安装包路径 └ version_code String 1.0.0.0 升级产品版本 └ product_code String YZ_POS 升级产品编码 └ product_line String finixx 产品线编码 config_data UpgradeConfigData 备份策略等 └ upgrade_backup_db String Y 是否备份数据库 └ upgrade_restart_apps String a,b,c 重启产品编码 depend_data UpgradeTaskDependData [] 数据库依赖脚本 └ oss_path String http://xxx.zip 依赖包路径 └ e_tag String aabbcc 依赖包etag
result	Boolean	true	结果
result_code	String	200	错误码
result_msg	String	成功	提示信息

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
LarkProductUpgradeTaskRequest req = new LarkProductUpgradeTaskRequest();
LarkProductUpgradeTaskRequest.DeviceReq obj1 = new LarkProductUpgradeTaskRequest.DeviceReq();
obj1.setDeviceName("installer_***_***");
req.setDeviceReq(obj1);
LarkProductUpgradeTaskResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
LarkProductUpgradeTaskRequest req = new LarkProductUpgradeTaskRequest();
LarkProductUpgradeTaskRequest.DeviceReqDomain obj1 = new LarkProductUpgradeTaskRequest.DeviceReqDomain();
obj1.DeviceName = "installer_***_***";
req.DeviceReq_ = obj1;
LarkProductUpgradeTaskResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new LarkProductUpgradeTaskRequest;
$device_req = new DeviceReq;
$device_req->device_name="installer_***_***";
$req->setDeviceReq(json_encode($device_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=taobao.lark.product.upgrade.task' \
-d 'partner_id=apidoc' \
-d 'sign=9279C2C015BDD7BA3CB512CFB2D3E239' \
-d 'sign_method=hmac' \
-d 'timestamp=2026-10-08+02%3A58%3A59' \
-d 'v=2.0' \
-d 'device_req=null'

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

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

req.device_req="数据结构示例JSON格式"
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,"taobao.lark.product.upgrade.task");
add_param(pRequest,"device_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',
	'url': 'http://gw.api.taobao.com/router/rest'
});

client.execute('taobao.lark.product.upgrade.task', {
	'device_req':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<lark_product_upgrade_task_response>
    <data>
        <product_upgrade_task>
            <device_name>YZ_OFFSER_888889_MAC</device_name>
            <install_oss_path>http://xxx.zip</install_oss_path>
            <install_type>1</install_type>
            <e_tag>xxx</e_tag>
            <publish_record_id>1</publish_record_id>
            <task_expiration_time>2026-10-01 09:00:00</task_expiration_time>
            <spare_oss_path>http://xxx.zip</spare_oss_path>
            <version_code>1.0.0.0</version_code>
            <product_code>YZ_POS</product_code>
            <product_line>finixx</product_line>
            <config_data>
                <upgrade_backup_db>Y</upgrade_backup_db>
                <upgrade_restart_apps>a,b,c</upgrade_restart_apps>
            </config_data>
            <depend_data>
                <upgrade_task_depend_data>
                    <oss_path>http://xxx.zip</oss_path>
                    <e_tag>aabbcc</e_tag>
                </upgrade_task_depend_data>
            </depend_data>
        </product_upgrade_task>
    </data>
    <result>true</result>
    <result_code>200</result_code>
    <result_msg>成功</result_msg>
</lark_product_upgrade_task_response>

{
    "lark_product_upgrade_task_response":{
        "data":{
            "product_upgrade_task":[
                {
                    "device_name":"YZ_OFFSER_888889_MAC",
                    "install_oss_path":"http:\/\/xxx.zip",
                    "install_type":"1",
                    "e_tag":"xxx",
                    "publish_record_id":"1",
                    "task_expiration_time":"2026-10-01 09:00:00",
                    "spare_oss_path":"http:\/\/xxx.zip",
                    "version_code":"1.0.0.0",
                    "product_code":"YZ_POS",
                    "product_line":"finixx",
                    "config_data":{
                        "upgrade_backup_db":"Y",
                        "upgrade_restart_apps":"a,b,c"
                    },
                    "depend_data":{
                        "upgrade_task_depend_data":[
                            {
                                "oss_path":"http:\/\/xxx.zip",
                                "e_tag":"aabbcc"
                            }
                        ]
                    }
                }
            ]
        },
        "result":true,
        "result_code":"200",
        "result_msg":"成功"
    }
}

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

taobao.lark.product.upgrade.task (获取设备待升级任务)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ