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

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
query	TemplateApiQuery	可选			设备模板查询对象
└ limit Number 可选 20 分页大小,限制limit<=500 └ code String 可选 Air_Conditioning_Panel 设备模板编码 └ current_page Number 可选 1 当前页 └ key String 可选 Air 模糊查询模板编码或名称 └ name String 可选控温面板设备模板名称

名称	类型	示例值	描述
result	PageResult	[]	返回结果
content Page [] 设备模板集合 └ total Number 500 总记录数 └ limit Number 20 分页大小 results TemplateApiDto [] [] 模板集合 └ id Number 283 模板id └ code String Air_Conditioning_Panel 模板编码 └ name String 控温面板模板名称 property_list PropertyApiDto [] [] 参数点集合 └ id Number 12476 参数点id └ name String 温度设定参数点名称 └ code String Temperature_config 参数点编码 └ type Number 10400 参数点类型id └ type_name String 执行类参数点类型名称 └ alarm Boolean false 是否报警类参数 └ value_type Number 20200 值类型id └ value_type_name String 数字型值类型名称 └ property_kind Number 31300 元数据id └ property_kind_code String temperature 元数据编码 └ control_enum_value String null 控制类参数枚举值 └ unit_id Number null 单位id └ unit_code String null 单位编码 └ 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);
AlibabaCampusDeviceOpenapiGettemplatelistRequest req = new AlibabaCampusDeviceOpenapiGettemplatelistRequest();
AlibabaCampusDeviceOpenapiGettemplatelistRequest.TemplateApiQuery obj1 = new AlibabaCampusDeviceOpenapiGettemplatelistRequest.TemplateApiQuery();
obj1.setLimit(20L);
obj1.setCode("Air_Conditioning_Panel");
obj1.setCurrentPage(1L);
obj1.setKey("Air");
obj1.setName("控温面板");
req.setQuery(obj1);
AlibabaCampusDeviceOpenapiGettemplatelistResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaCampusDeviceOpenapiGettemplatelistRequest req = new AlibabaCampusDeviceOpenapiGettemplatelistRequest();
AlibabaCampusDeviceOpenapiGettemplatelistRequest.TemplateApiQueryDomain obj1 = new AlibabaCampusDeviceOpenapiGettemplatelistRequest.TemplateApiQueryDomain();
obj1.Limit = 20L;
obj1.Code = "Air_Conditioning_Panel";
obj1.CurrentPage = 1L;
obj1.Key = "Air";
obj1.Name = "控温面板";
req.Query_ = obj1;
AlibabaCampusDeviceOpenapiGettemplatelistResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaCampusDeviceOpenapiGettemplatelistRequest;
$query = new TemplateApiQuery;
$query->limit="20";
$query->code="Air_Conditioning_Panel";
$query->current_page="1";
$query->key="Air";
$query->name="控温面板";
$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.gettemplatelist' \
-d 'partner_id=apidoc' \
-d 'sign=34B8317B536504B98728A55B962DA601' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-26+03%3A38%3A03' \
-d 'v=2.0' \
-d 'query=null'

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

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

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.gettemplatelist");
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.gettemplatelist', {
	'query':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_campus_device_openapi_gettemplatelist_response>
    <result>
        <content>
            <total>500</total>
            <limit>20</limit>
            <results>
                <template_api_dto>
                    <id>283</id>
                    <code>Air_Conditioning_Panel</code>
                    <name>控温面板</name>
                    <property_list>
                        <property_api_dto>
                            <id>12476</id>
                            <name>温度设定</name>
                            <code>Temperature_config</code>
                            <type>10400</type>
                            <type_name>执行类</type_name>
                            <alarm>false</alarm>
                            <value_type>20200</value_type>
                            <value_type_name>数字型</value_type_name>
                            <property_kind>31300</property_kind>
                            <property_kind_code>temperature</property_kind_code>
                            <control_enum_value>null</control_enum_value>
                            <unit_id>null</unit_id>
                            <unit_code>null</unit_code>
                        </property_api_dto>
                    </property_list>
                </template_api_dto>
            </results>
            <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_gettemplatelist_response>

{
    "alibaba_campus_device_openapi_gettemplatelist_response":{
        "result":{
            "content":{
                "total":500,
                "limit":20,
                "results":{
                    "template_api_dto":[
                        {
                            "id":283,
                            "code":"Air_Conditioning_Panel",
                            "name":"控温面板",
                            "property_list":{
                                "property_api_dto":[
                                    {
                                        "id":12476,
                                        "name":"温度设定",
                                        "code":"Temperature_config",
                                        "type":10400,
                                        "type_name":"执行类",
                                        "alarm":false,
                                        "value_type":20200,
                                        "value_type_name":"数字型",
                                        "property_kind":31300,
                                        "property_kind_code":"temperature",
                                        "control_enum_value":"null",
                                        "unit_id":null,
                                        "unit_code":"null"
                                    }
                                ]
                            }
                        }
                    ]
                },
                "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.gettemplatelist (查询设备模板)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ

用户导航

用户反馈

用户反馈

用户反馈