阿里安全开放平台-阿里聚安全

请求地址：

环境	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 公司id └ system_id String 可选 111111111 系统id └ campus_code String 可选 111111 园区编码 └ campus_id Number 可选 10000 园区id └ language String 可选 en 语言 └ app_code String 可选 1234 应用编码 └ user_name String 可选 zy 用户名称 └ user_id Number 可选 1111334455 用户id
query	DeviceApiQuery	可选	查询条件
└ code String 可选测试设备编号 └ campus_id_list Number [] 可选设备园区id列表 └ template_code String 可选 Face 设备模板code └ uuid_list String [] 可选 ["uuid","uuid2"] 设备uuid列表 └ floor_id Number 可选 1 设备楼层id └ building_id_list Number [] 可选设备楼宇id列表 └ space_id Number 可选 1 设备空间id └ space_id_list Number [] 可选设备空间id列表 └ limit Number 可选 10 查询条件limit └ be_run Boolean 可选 true 设备启用状态 └ key String 可选测试设备模糊搜索 └ run_status Number 可选 1 设备运行状态 └ floor_id_list Number [] 可选 [1,2] 设备楼层id列表 └ template_code_list String [] 可选 ["Face","Face2"] 设备模板code 列表 └ campus_id Number 可选 10000 园区id └ tag_name String 可选 aaa 标签名称 └ building_id Number 可选 10001 楼宇id └ company_id Number 可选 10000 公司id └ name_or_code String 可选 aaaa 模糊搜索 └ current_page Number 可选 1 查询条件当前页

名称	类型	示例值	描述
result	PageResult		返回结果
└ success Boolean true 成功结果 └ request_id String 11121111aaa 请求id └ error_code String 400 错误编码 └ error_ext_info String 扩展信息 content Page 分页结果 result DeviceStandardApiDto [] 返回结果类 └ code String jsfgjshgj 设备编号 └ company_id Number 10000 公司id └ campus_id Number 10001 园区id └ uuid String afafafadad 设备uuid app_protocol DeviceConnectConfigApiDTO 111 协议信息 └ param Json 11 协议字段 └ total String 12 总数 └ total_page String 2 总页数 └ limit String 10 限制 └ page_size Number 10 页码数 └ total_count Number 12 总数 └ current_page Number 1 当前页数 └ error_msg String aaa 错误信息 └ error_level String aaa 错误级别

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaCampusDeviceOpenapiGetdeviceforqueryRequest req = new AlibabaCampusDeviceOpenapiGetdeviceforqueryRequest();
AlibabaCampusDeviceOpenapiGetdeviceforqueryRequest.WorkBenchContext obj1 = new AlibabaCampusDeviceOpenapiGetdeviceforqueryRequest.WorkBenchContext();
obj1.setCompanyId(10000L);
obj1.setSystemId("111111111");
obj1.setCampusCode("111111");
obj1.setCampusId(10000L);
obj1.setLanguage("en");
obj1.setAppCode("1234");
obj1.setUserName("zy");
obj1.setUserId(1111334455L);
req.setWorkBenchContext(obj1);
AlibabaCampusDeviceOpenapiGetdeviceforqueryRequest.DeviceApiQuery obj2 = new AlibabaCampusDeviceOpenapiGetdeviceforqueryRequest.DeviceApiQuery();
obj2.setCode("测试");
obj2.setCampusIdList(new Long[] {  };
);
obj2.setTemplateCode("Face");
obj2.setUuidList(""uuid","uuid2"");
obj2.setFloorId(1L);
obj2.setBuildingIdList(new Long[] {  };
);
obj2.setSpaceId(1L);
obj2.setSpaceIdList(new Long[] {  };
);
obj2.setLimit(10L);
obj2.setBeRun(true);
obj2.setKey("测试");
obj2.setRunStatus(1L);
obj2.setFloorIdList(new Long[] { 1,2 };
);
obj2.setTemplateCodeList(""Face","Face2"");
obj2.setCampusId(10000L);
obj2.setTagName("aaa");
obj2.setBuildingId(10001L);
obj2.setCompanyId(10000L);
obj2.setNameOrCode("aaaa");
obj2.setCurrentPage(1L);
req.setQuery(obj2);
AlibabaCampusDeviceOpenapiGetdeviceforqueryResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaCampusDeviceOpenapiGetdeviceforqueryRequest req = new AlibabaCampusDeviceOpenapiGetdeviceforqueryRequest();
AlibabaCampusDeviceOpenapiGetdeviceforqueryRequest.WorkBenchContextDomain obj1 = new AlibabaCampusDeviceOpenapiGetdeviceforqueryRequest.WorkBenchContextDomain();
obj1.CompanyId = 10000L;
obj1.SystemId = "111111111";
obj1.CampusCode = "111111";
obj1.CampusId = 10000L;
obj1.Language = "en";
obj1.AppCode = "1234";
obj1.UserName = "zy";
obj1.UserId = 1111334455L;
req.WorkBenchContext_ = obj1;
AlibabaCampusDeviceOpenapiGetdeviceforqueryRequest.DeviceApiQueryDomain obj2 = new AlibabaCampusDeviceOpenapiGetdeviceforqueryRequest.DeviceApiQueryDomain();
obj2.Code = "测试";
obj2.CampusIdList = new long[] {  };
;
obj2.TemplateCode = "Face";
obj2.UuidList = ""uuid","uuid2"";
obj2.FloorId = 1L;
obj2.BuildingIdList = new long[] {  };
;
obj2.SpaceId = 1L;
obj2.SpaceIdList = new long[] {  };
;
obj2.Limit = 10L;
obj2.BeRun = true;
obj2.Key = "测试";
obj2.RunStatus = 1L;
obj2.FloorIdList = new long[] { 1,2 };
;
obj2.TemplateCodeList = ""Face","Face2"";
obj2.CampusId = 10000L;
obj2.TagName = "aaa";
obj2.BuildingId = 10001L;
obj2.CompanyId = 10000L;
obj2.NameOrCode = "aaaa";
obj2.CurrentPage = 1L;
req.Query_ = obj2;
AlibabaCampusDeviceOpenapiGetdeviceforqueryResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaCampusDeviceOpenapiGetdeviceforqueryRequest;
$work_bench_context = new WorkBenchContext;
$work_bench_context->company_id="10000";
$work_bench_context->system_id="111111111";
$work_bench_context->campus_code="111111";
$work_bench_context->campus_id="10000";
$work_bench_context->language="en";
$work_bench_context->app_code="1234";
$work_bench_context->user_name="zy";
$work_bench_context->user_id="1111334455";
$req->setWorkBenchContext(json_encode($work_bench_context));
$query = new DeviceApiQuery;
$query->code="测试";
$query->campus_id_list="";
$query->template_code="Face";
$query->uuid_list="[\"uuid\",\"uuid2\"]";
$query->floor_id="1";
$query->building_id_list="";
$query->space_id="1";
$query->space_id_list="";
$query->limit="10";
$query->be_run="true";
$query->key="测试";
$query->run_status="1";
$query->floor_id_list="[1,2]";
$query->template_code_list="[\"Face\",\"Face2\"]";
$query->campus_id="10000";
$query->tag_name="aaa";
$query->building_id="10001";
$query->company_id="10000";
$query->name_or_code="aaaa";
$query->current_page="1";
$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.openapi.getdeviceforquery' \
-d 'partner_id=apidoc' \
-d 'sign=B1393637B90802FA8451513351580085' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-25+19%3A19%3A41' \
-d 'v=2.0' \
-d 'query=null' \
-d 'work_bench_context=null'

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

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

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

XML示例
JSON示例

<alibaba_campus_device_openapi_getdeviceforquery_response>
    <result>
        <success>true</success>
        <request_id>11121111aaa</request_id>
        <error_code>400</error_code>
        <content>
            <result>
                <device_standard_api_dto>
                    <code>jsfgjshgj</code>
                    <company_id>10000</company_id>
                    <campus_id>10001</campus_id>
                    <uuid>afafafadad</uuid>
                    <app_protocol>
                        <param>11</param>
                    </app_protocol>
                </device_standard_api_dto>
            </result>
            <total>12</total>
            <total_page>2</total_page>
            <limit>10</limit>
            <page_size>10</page_size>
            <total_count>12</total_count>
            <current_page>1</current_page>
        </content>
        <error_msg>aaa</error_msg>
        <error_level>aaa</error_level>
    </result>
</alibaba_campus_device_openapi_getdeviceforquery_response>

{
    "alibaba_campus_device_openapi_getdeviceforquery_response":{
        "result":{
            "success":true,
            "request_id":"11121111aaa",
            "error_code":"400",
            "content":{
                "result":{
                    "device_standard_api_dto":[
                        {
                            "code":"jsfgjshgj",
                            "company_id":10000,
                            "campus_id":10001,
                            "uuid":"afafafadad",
                            "app_protocol":{
                                "param":"11"
                            }
                        }
                    ]
                },
                "total":"12",
                "total_page":"2",
                "limit":"10",
                "page_size":10,
                "total_count":12,
                "current_page":1
            },
            "error_msg":"aaa",
            "error_level":"aaa"
        }
    }
}

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.openapi.getdeviceforquery (查询设备详细信息列表)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ

用户导航

用户反馈

用户反馈

用户反馈