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

请求地址：

环境	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 所属园区Id
query	DeviceApiQuery	必须	多条件查询对象
└ template_code_list String [] 可选 brightness_sensor,light 模板code集合,具体设备模板code信息请查阅‘平台技术’下‘设备详细信息开发文档’。[生成参考文档该字段入参是数组，有误。入参类型请使用java.lang.List类型] └ floor_id Number 可选 100004 楼层id └ template_code String 可选 brightness_sensor 模板code,具体设备模板code信息请查阅‘平台技术’下‘设备详细信息开发文档’。 └ space_id Number 可选 -1 空间单元id └ campus_id_list Number [] 可选 100001,100002 园区id集合 └ uuid_list String [] 可选 ca99e9e9-e40d-483e-a011-20a7a440450d 设备uuid集合[生成参考文档该字段入参是数组，有误。入参类型请使用java.lang.List类型] └ campus_id Number 可选 100001 园区id └ building_id Number 可选 100001 楼宇id └ current_page Number 可选 1 当前页(如果设置currentPage<=0，则会查询出所有结果集，即忽略分页条件[建议开发者使用分页查询，不然因返回数量过多可能导致接口超时]) └ limit Number 可选 15 分页大小，默认值100。单次最多查询1000条记录 └ space_id_list Number [] 可选 [] 空间单元id集合[生成参考文档该字段入参是数组，有误。入参类型请使用java.lang.List类型] └ be_run Boolean 可选 true 是否启用 └ run_status Number 可选 0 0->在线 1->离线 2->故障 └ tag_name String 可选 JACE 根据标签名称精确查询 └ name_or_code String 可选 A 模糊查询设备code或名称 └ code String 可选 8-5-W1-6 根据设备code精确匹配

名称	类型	示例值	描述
result	PageResult		返回对象
content Page 设备分页集合数据 └ limit Number 15 分页大小 └ total Number 100 总记录数 result_list DeviceStandardApiDto [] [] 分页集合 └ code String logic-ib 设备code └ campus_id Number 100001 campusId └ campus_name String 西溪园区园区名称 └ building_id Number 100009 楼宇id └ building_name String 1号楼楼宇名称 └ floor_id Number 100049 楼层id └ floor_name String 1F 楼层名称 └ template_code String BrakeMachine 模板code └ last_update_time Date 2017-10-22 17:00:42 最后更新时间 └ uuid String f42bc4f8-9cf4-4a29-9239-7962a33fbab8 设备uuid └ device_id String f42bc4f8-9cf4-4a29-9239-7962a33fbab8 设备id └ be_run Boolean true 设备是否运行 └ template_id Number 110 模板id └ version String 1.0.0 版本信息 └ be_logic Boolean false 是否是逻辑设备 └ longitude String 10.12545 经度 └ latitude String 50.1546254 纬度 └ space_id Number 100045 空间单元id └ space_name String 会议室空间单元名称 └ template_name String 车牌识别道闸一体机模板名称 meta_point_datas MeatDataApiDto [] 设备参数信息 └ code String audio 参数code └ alarm Boolean false 是否报警值 └ mapping_point String null 地图映射 └ data_type String null 数据类型 └ ref_device_id String fb95eb11-4cc6-49d1-87b3-8d851906af02 被关联设备uuid └ ref_property_code String lightBrightness 被关联属性code └ nickname String 测试设备别名设备别名 tag_info_list TagInfoApiDto [] [] 设备标签列表 └ tag_name String jace 标签名称 └ system_tag Boolean true 是否系统标签 └ tag_desc String null 标签描述 └ tag_type_name String Marker 标签类型 └ run_status Number 0 设备运行状态。0->在线 1->离线 2->故障 └ run_status_name String 在线设备运行状态展示字段 └ current_page Number 1 当前页 └ request_id String null 请求id └ error_code String 200 错误码 └ error_msg String null 错误信息 └ success Boolean true 是否成功

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaCampusDeviceOpenapiGetdevicelistRequest req = new AlibabaCampusDeviceOpenapiGetdevicelistRequest();
AlibabaCampusDeviceOpenapiGetdevicelistRequest.WorkBenchContext obj1 = new AlibabaCampusDeviceOpenapiGetdevicelistRequest.WorkBenchContext();
obj1.setCompanyId(10000L);
obj1.setCampusId(100001L);
req.setWorkBenchContext(obj1);
AlibabaCampusDeviceOpenapiGetdevicelistRequest.DeviceApiQuery obj2 = new AlibabaCampusDeviceOpenapiGetdevicelistRequest.DeviceApiQuery();
obj2.setTemplateCodeList("brightness_sensor,light");
obj2.setFloorId(100004L);
obj2.setTemplateCode("brightness_sensor");
obj2.setSpaceId(-1L);
obj2.setCampusIdList(new Long[] { 100001,100002 };
);
obj2.setUuidList("ca99e9e9-e40d-483e-a011-20a7a440450d");
obj2.setCampusId(100001L);
obj2.setBuildingId(100001L);
obj2.setCurrentPage(1L);
obj2.setLimit(15L);
obj2.setSpaceIdList(new Long[] {  };
);
obj2.setBeRun(true);
obj2.setRunStatus(0L);
obj2.setTagName("JACE");
obj2.setNameOrCode("A");
obj2.setCode("8-5-W1-6");
req.setQuery(obj2);
AlibabaCampusDeviceOpenapiGetdevicelistResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaCampusDeviceOpenapiGetdevicelistRequest req = new AlibabaCampusDeviceOpenapiGetdevicelistRequest();
AlibabaCampusDeviceOpenapiGetdevicelistRequest.WorkBenchContextDomain obj1 = new AlibabaCampusDeviceOpenapiGetdevicelistRequest.WorkBenchContextDomain();
obj1.CompanyId = 10000L;
obj1.CampusId = 100001L;
req.WorkBenchContext_ = obj1;
AlibabaCampusDeviceOpenapiGetdevicelistRequest.DeviceApiQueryDomain obj2 = new AlibabaCampusDeviceOpenapiGetdevicelistRequest.DeviceApiQueryDomain();
obj2.TemplateCodeList = "brightness_sensor,light";
obj2.FloorId = 100004L;
obj2.TemplateCode = "brightness_sensor";
obj2.SpaceId = -1L;
obj2.CampusIdList = new long[] { 100001,100002 };
;
obj2.UuidList = "ca99e9e9-e40d-483e-a011-20a7a440450d";
obj2.CampusId = 100001L;
obj2.BuildingId = 100001L;
obj2.CurrentPage = 1L;
obj2.Limit = 15L;
obj2.SpaceIdList = new long[] {  };
;
obj2.BeRun = true;
obj2.RunStatus = 0L;
obj2.TagName = "JACE";
obj2.NameOrCode = "A";
obj2.Code = "8-5-W1-6";
req.Query_ = obj2;
AlibabaCampusDeviceOpenapiGetdevicelistResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaCampusDeviceOpenapiGetdevicelistRequest;
$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->template_code_list="brightness_sensor,light";
$query->floor_id="100004";
$query->template_code="brightness_sensor";
$query->space_id="-1";
$query->campus_id_list="100001,100002";
$query->uuid_list="ca99e9e9-e40d-483e-a011-20a7a440450d";
$query->campus_id="100001";
$query->building_id="100001";
$query->current_page="1";
$query->limit="15";
$query->space_id_list="[]";
$query->be_run="true";
$query->run_status="0";
$query->tag_name="JACE";
$query->name_or_code="A";
$query->code="8-5-W1-6";
$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.getdevicelist' \
-d 'partner_id=apidoc' \
-d 'sign=76CA3F9C7127027AF9C394E1073ED218' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-25+21%3A03%3A11' \
-d 'v=2.0' \
-d 'query=null' \
-d 'work_bench_context=null'

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

req=top.api.AlibabaCampusDeviceOpenapiGetdevicelistRequest(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.openapi.getdevicelist");
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.getdevicelist', {
	'work_bench_context':'数据结构JSON示例',
	'query':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_campus_device_openapi_getdevicelist_response>
    <result>
        <content>
            <limit>15</limit>
            <total>100</total>
            <result_list>
                <device_standard_api_dto>
                    <code>logic-ib</code>
                    <campus_id>100001</campus_id>
                    <campus_name>西溪园区</campus_name>
                    <building_id>100009</building_id>
                    <building_name>1号楼</building_name>
                    <floor_id>100049</floor_id>
                    <floor_name>1F</floor_name>
                    <template_code>BrakeMachine</template_code>
                    <last_update_time>2017-10-22 17:00:42</last_update_time>
                    <uuid>f42bc4f8-9cf4-4a29-9239-7962a33fbab8</uuid>
                    <device_id>f42bc4f8-9cf4-4a29-9239-7962a33fbab8</device_id>
                    <be_run>true</be_run>
                    <template_id>110</template_id>
                    <version>1.0.0</version>
                    <be_logic>false</be_logic>
                    <longitude>10.12545</longitude>
                    <latitude>50.1546254</latitude>
                    <space_id>100045</space_id>
                    <space_name>会议室</space_name>
                    <template_name>车牌识别道闸一体机</template_name>
                    <meta_point_datas>
                        <meat_data_api_dto>
                            <code>audio</code>
                            <alarm>false</alarm>
                            <mapping_point>null</mapping_point>
                            <data_type>null</data_type>
                            <ref_device_id>fb95eb11-4cc6-49d1-87b3-8d851906af02</ref_device_id>
                            <ref_property_code>lightBrightness</ref_property_code>
                        </meat_data_api_dto>
                    </meta_point_datas>
                    <nickname>测试设备别名</nickname>
                    <tag_info_list>
                        <tag_info_api_dto>
                            <tag_name>jace</tag_name>
                            <system_tag>true</system_tag>
                            <tag_desc>null</tag_desc>
                            <tag_type_name>Marker</tag_type_name>
                        </tag_info_api_dto>
                    </tag_info_list>
                    <run_status>0</run_status>
                    <run_status_name>在线</run_status_name>
                </device_standard_api_dto>
            </result_list>
            <current_page>1</current_page>
        </content>
        <request_id>null</request_id>
        <error_code>200</error_code>
        <error_msg>null</error_msg>
        <success>true</success>
    </result>
</alibaba_campus_device_openapi_getdevicelist_response>

{
    "alibaba_campus_device_openapi_getdevicelist_response":{
        "result":{
            "content":{
                "limit":15,
                "total":100,
                "result_list":{
                    "device_standard_api_dto":[
                        {
                            "code":"logic-ib",
                            "campus_id":100001,
                            "campus_name":"西溪园区",
                            "building_id":100009,
                            "building_name":"1号楼",
                            "floor_id":100049,
                            "floor_name":"1F",
                            "template_code":"BrakeMachine",
                            "last_update_time":"2017-10-22 17:00:42",
                            "uuid":"f42bc4f8-9cf4-4a29-9239-7962a33fbab8",
                            "device_id":"f42bc4f8-9cf4-4a29-9239-7962a33fbab8",
                            "be_run":true,
                            "template_id":110,
                            "version":"1.0.0",
                            "be_logic":false,
                            "longitude":"10.12545",
                            "latitude":"50.1546254",
                            "space_id":100045,
                            "space_name":"会议室",
                            "template_name":"车牌识别道闸一体机",
                            "meta_point_datas":{
                                "meat_data_api_dto":[
                                    {
                                        "code":"audio",
                                        "alarm":false,
                                        "mapping_point":"null",
                                        "data_type":"null",
                                        "ref_device_id":"fb95eb11-4cc6-49d1-87b3-8d851906af02",
                                        "ref_property_code":"lightBrightness"
                                    }
                                ]
                            },
                            "nickname":"测试设备别名",
                            "tag_info_list":{
                                "tag_info_api_dto":[
                                    {
                                        "tag_name":"jace",
                                        "system_tag":true,
                                        "tag_desc":"null",
                                        "tag_type_name":"Marker"
                                    }
                                ]
                            },
                            "run_status":0,
                            "run_status_name":"在线"
                        }
                    ]
                },
                "current_page":1
            },
            "request_id":"null",
            "error_code":"200",
            "error_msg":"null",
            "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.openapi.getdevicelist (多条件查询设备分组)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ

用户导航

用户反馈

用户反馈

用户反馈