淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	描述
work_bench_context	WorkBenchContext	必须	平台统一参数
└ company_id Number 可选 10000 可选参数 └ campus_id Number 必须 100001 可选参数
query	DeviceApiQuery	必须	系统自动生成
└ key String 可选 device 模糊查询关键字 └ campus_id Number 可选 100002 园区id └ template_code String 可选 Light 设备模板code └ limit Number 必须 15 分页大小 └ current_page Number 必须 1 当前页 └ campus_id_list Number [] 可选 [] 园区id集合

名称	类型	示例值	描述
result	PageResult		返回值
content Page 分页对象 └ limit Number 15 页面大小 └ total Number 1000 总记录数 └ results String [] {} 分页结果集合 └ current_page Number 1 当前页 └ total_page Number 200 总页数 └ request_id String null 请求id └ error_code String error 错误代码 └ error_msg String 查询报错错误信息 └ success Boolean true 是否成功

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaCampusDeviceGetdeviceforqueryRequest req = new AlibabaCampusDeviceGetdeviceforqueryRequest();
AlibabaCampusDeviceGetdeviceforqueryRequest.WorkBenchContext obj1 = new AlibabaCampusDeviceGetdeviceforqueryRequest.WorkBenchContext();
obj1.setCompanyId(10000L);
obj1.setCampusId(100001L);
req.setWorkBenchContext(obj1);
AlibabaCampusDeviceGetdeviceforqueryRequest.DeviceApiQuery obj2 = new AlibabaCampusDeviceGetdeviceforqueryRequest.DeviceApiQuery();
obj2.setKey("device");
obj2.setCampusId(100002L);
obj2.setTemplateCode("Light");
obj2.setLimit(15L);
obj2.setCurrentPage(1L);
obj2.setCampusIdList(new Long[] {  };
);
req.setQuery(obj2);
AlibabaCampusDeviceGetdeviceforqueryResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaCampusDeviceGetdeviceforqueryRequest req = new AlibabaCampusDeviceGetdeviceforqueryRequest();
AlibabaCampusDeviceGetdeviceforqueryRequest.WorkBenchContextDomain obj1 = new AlibabaCampusDeviceGetdeviceforqueryRequest.WorkBenchContextDomain();
obj1.CompanyId = 10000L;
obj1.CampusId = 100001L;
req.WorkBenchContext_ = obj1;
AlibabaCampusDeviceGetdeviceforqueryRequest.DeviceApiQueryDomain obj2 = new AlibabaCampusDeviceGetdeviceforqueryRequest.DeviceApiQueryDomain();
obj2.Key = "device";
obj2.CampusId = 100002L;
obj2.TemplateCode = "Light";
obj2.Limit = 15L;
obj2.CurrentPage = 1L;
obj2.CampusIdList = new long[] {  };
;
req.Query_ = obj2;
AlibabaCampusDeviceGetdeviceforqueryResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaCampusDeviceGetdeviceforqueryRequest;
$work_bench_context = new WorkBenchContext;
$work_bench_context->company_id="10000";
$work_bench_context->campus_id="100001";
$req->setWorkBenchContext(json_encode($work_bench_context));
$query = new DeviceApiQuery;
$query->key="device";
$query->campus_id="100002";
$query->template_code="Light";
$query->limit="15";
$query->current_page="1";
$query->campus_id_list="[]";
$req->setQuery(json_encode($query));
$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.campus.device.getdeviceforquery' \
-d 'partner_id=apidoc' \
-d 'sign=55B005C8514A1CDD1DA847F9D898EB07' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-06-26+15%3A24%3A01' \
-d 'v=2.0' \
-d 'query=null' \
-d 'work_bench_context=null'

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

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

req.work_bench_context=""
req.query=""
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.campus.device.getdeviceforquery");
add_param(pRequest,"work_bench_context","数据结构JSON示例");
add_param(pRequest,"query","数据结构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.campus.device.getdeviceforquery', {
	'work_bench_context':'数据结构JSON示例',
	'query':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_campus_device_getdeviceforquery_response>
    <result>
        <content>
            <limit>15</limit>
            <total>1000</total>
            <results>
                <string>{}</string>
            </results>
            <current_page>1</current_page>
            <total_page>200</total_page>
        </content>
        <request_id>null</request_id>
        <error_code>error</error_code>
        <error_msg>查询报错</error_msg>
        <success>true</success>
    </result>
</alibaba_campus_device_getdeviceforquery_response>

{
    "alibaba_campus_device_getdeviceforquery_response":{
        "result":{
            "content":{
                "limit":15,
                "total":1000,
                "results":{
                    "string":[
                        "{}"
                    ]
                },
                "current_page":1,
                "total_page":200
            },
            "request_id":"null",
            "error_code":"error",
            "error_msg":"查询报错",
            "success":true
        }
    }
}

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.campus.device.getdeviceforquery (下发设备的分页接口(无需AOP控制))

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ