淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	描述
app_id	Number	必须	10001	应用ID
page	Number	必须	1	页码值
size	Number	必须	20	页大小

名称	类型	示例值	描述
result_list	TvAppVersion []		resultList
app AppDto app └ id Number 1001 应用ID └ name String TV桌面应用名称 └ package_name String com.yunos.tv.homeshell 应用包名 └ app_zip_type String 1 应用业务类型 device_adapter_list DeviceAdapterDto [] deviceAdapterList └ brand_id Number 2001 品牌ID └ brand_name String 天猫品牌名称 └ highest_system_version String 20170711ABC 最高系统版本 └ minimum_system_version String 20170711ABC 最低系统版本 └ model_id Number 1100 设备ID └ model_name String MagicBox2 设备名称 └ real_type_id Number 120001 类型ID └ real_type_name String 魔盒真实类型名称 └ download_path String http://tvosupdate.cn-hangzhou.oss.aliyun-inc.com/resgin-ota-package/579/ota_sepolicyhomeshell20567331_579-Release-resigned.zip 下载地址 └ downloadmd5 String 1C105DC4DB9B6FE1345BB49368C10A2C 下载md5 └ gmt_create Date 2017-07-11 00:00:00 创建时间 └ gmt_modify Date 2017-07-11 00:00:00 更新时间 └ has_notified String Y 是否通知 └ id Number 112 任务ID └ need_restart String N 是否重启 └ release_note String aaaa 发布说明 └ restart_app_param String 32423 重启应用参数 └ restart_app_type String system 重启应用类型 └ restart_type String system 重启类型 └ size String 0.0 文件大小 └ status String CREATE 状态 └ version String 201707112332 版本 └ version_code Number 201707112332 版本号
total_count	Number	100	总数

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
YunosOsupdateAppversionQueryRequest req = new YunosOsupdateAppversionQueryRequest();
req.setAppId(10001L);
req.setPage(1L);
req.setSize(20L);
YunosOsupdateAppversionQueryResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
YunosOsupdateAppversionQueryRequest req = new YunosOsupdateAppversionQueryRequest();
req.AppId = 10001L;
req.Page = 1L;
req.Size = 20L;
YunosOsupdateAppversionQueryResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new YunosOsupdateAppversionQueryRequest;
$req->setAppId("10001");
$req->setPage("1");
$req->setSize("20");
$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=yunos.osupdate.appversion.query' \
-d 'partner_id=apidoc' \
-d 'sign=5FAB46C5A15A33D68B891026800B6642' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-07-18+18%3A05%3A10' \
-d 'v=2.0' \
-d 'app_id=10001' \
-d 'page=1' \
-d 'size=20'

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

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

req.app_id=10001
req.page=1
req.size=20
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,"yunos.osupdate.appversion.query");
add_param(pRequest,"app_id","10001");
add_param(pRequest,"page","1");
add_param(pRequest,"size","20");
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('yunos.osupdate.appversion.query', {
	'app_id':'10001',
	'page':'1',
	'size':'20'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<yunos_osupdate_appversion_query_response>
    <result_list>
        <tv_app_version>
            <app>
                <id>1001</id>
                <name>TV桌面</name>
                <package_name>com.yunos.tv.homeshell</package_name>
            </app>
            <app_zip_type>1</app_zip_type>
            <device_adapter_list>
                <device_adapter_dto>
                    <brand_id>2001</brand_id>
                    <brand_name>天猫</brand_name>
                    <highest_system_version>20170711ABC</highest_system_version>
                    <minimum_system_version>20170711ABC</minimum_system_version>
                    <model_id>1100</model_id>
                    <model_name>MagicBox2</model_name>
                    <real_type_id>120001</real_type_id>
                    <real_type_name>魔盒</real_type_name>
                </device_adapter_dto>
            </device_adapter_list>
            <download_path>http://tvosupdate.cn-hangzhou.oss.aliyun-inc.com/resgin-ota-package/579/ota_sepolicyhomeshell20567331_579-Release-resigned.zip</download_path>
            <downloadmd5>1C105DC4DB9B6FE1345BB49368C10A2C</downloadmd5>
            <gmt_create>2017-07-11 00:00:00</gmt_create>
            <gmt_modify>2017-07-11 00:00:00</gmt_modify>
            <has_notified>Y</has_notified>
            <id>112</id>
            <need_restart>N</need_restart>
            <release_note>aaaa</release_note>
            <restart_app_param>32423</restart_app_param>
            <restart_app_type>system</restart_app_type>
            <restart_type>system</restart_type>
            <size>0.0</size>
            <status>CREATE</status>
            <version>201707112332</version>
            <version_code>201707112332</version_code>
        </tv_app_version>
    </result_list>
    <total_count>100</total_count>
</yunos_osupdate_appversion_query_response>

{
    "yunos_osupdate_appversion_query_response":{
        "result_list":{
            "tv_app_version":[
                {
                    "app":{
                        "id":1001,
                        "name":"TV桌面",
                        "package_name":"com.yunos.tv.homeshell"
                    },
                    "app_zip_type":"1",
                    "device_adapter_list":{
                        "device_adapter_dto":[
                            {
                                "brand_id":2001,
                                "brand_name":"天猫",
                                "highest_system_version":"20170711ABC",
                                "minimum_system_version":"20170711ABC",
                                "model_id":1100,
                                "model_name":"MagicBox2",
                                "real_type_id":120001,
                                "real_type_name":"魔盒"
                            }
                        ]
                    },
                    "download_path":"http:\/\/tvosupdate.cn-hangzhou.oss.aliyun-inc.com\/resgin-ota-package\/579\/ota_sepolicyhomeshell20567331_579-Release-resigned.zip",
                    "downloadmd5":"1C105DC4DB9B6FE1345BB49368C10A2C",
                    "gmt_create":"2017-07-11 00:00:00",
                    "gmt_modify":"2017-07-11 00:00:00",
                    "has_notified":"Y",
                    "id":112,
                    "need_restart":"N",
                    "release_note":"aaaa",
                    "restart_app_param":"32423",
                    "restart_app_type":"system",
                    "restart_type":"system",
                    "size":"0.0",
                    "status":"CREATE",
                    "version":"201707112332",
                    "version_code":201707112332
                }
            ]
        },
        "total_count":100
    }
}

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下载

开放平台

迎客松牌照审核接口

yunos.osupdate.appversion.query (分页获取桌面升级任务)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ