淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	描述
ref_ent_id	String	必须	cb14553ed7654ff586b87b637ba23e2c	操作企业ID （appkey授权）
target_ref_ent_id	String	必须	cb14553ed7654ff586b87b637ba23e2c	目标企业ID
equipment_code_or_name	String	可选	疫苗专库	设备编号或名称
equipment_type	String	可选	冷库	设备类型
status	String	可选	1	设备状态，1：正常；0：停止
page	Number	必须	1	页码
page_size	Number	必须	10	每页显示数量

名称	类型	示例值	描述
result	Result	无	接口返回model
└ success Boolean true 是否成功 model Model 无 model list Result [] 无查询列表 └ mod_date String 2019-10-24 修改时间 └ address String 北京市东城区设备地址 └ comments String demo 备注 └ equipment_code String 1111 设备编号 └ crt_date String 2019-10-24 记录时间 └ equipment_type String 冷库设备类型 └ associated_status String 0 关联状态 └ probe String 1111111 关联探头 └ mod_ic_code String demo 记录修改人 └ address_detail String 111111 详细地址 └ dict_region_d_t_o String demo 地区 └ crt_ic_code String 500000012 记录创建人 └ ref_ent_id String cb14553ed7654ff586b87b637ba23e2c 所属企业 └ equipment_name String 1111111 设备名称 └ va_equipment_id String 638a39c77d514a0592a0dc69bc679813 设备主键 └ status String 1 设备状态 └ pages Number 0 页数 └ total_num Number 45 总数 └ page_size Number 10 每页显示数量 └ page Number 1 页码 └ msg_info String 调用成功 msgInfo └ msg_code String SUCCESS msgCode

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaAlihealthDrugKytDrVaequipmentListRequest req = new AlibabaAlihealthDrugKytDrVaequipmentListRequest();
req.setRefEntId("cb14553ed7654ff586b87b637ba23e2c");
req.setTargetRefEntId("cb14553ed7654ff586b87b637ba23e2c");
req.setEquipmentCodeOrName("疫苗专库");
req.setEquipmentType("冷库");
req.setStatus("1");
req.setPage(1L);
req.setPageSize(10L);
AlibabaAlihealthDrugKytDrVaequipmentListResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaAlihealthDrugKytDrVaequipmentListRequest req = new AlibabaAlihealthDrugKytDrVaequipmentListRequest();
req.RefEntId = "cb14553ed7654ff586b87b637ba23e2c";
req.TargetRefEntId = "cb14553ed7654ff586b87b637ba23e2c";
req.EquipmentCodeOrName = "疫苗专库";
req.EquipmentType = "冷库";
req.Status = "1";
req.Page = 1L;
req.PageSize = 10L;
AlibabaAlihealthDrugKytDrVaequipmentListResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaAlihealthDrugKytDrVaequipmentListRequest;
$req->setRefEntId("cb14553ed7654ff586b87b637ba23e2c");
$req->setTargetRefEntId("cb14553ed7654ff586b87b637ba23e2c");
$req->setEquipmentCodeOrName("疫苗专库");
$req->setEquipmentType("冷库");
$req->setStatus("1");
$req->setPage("1");
$req->setPageSize("10");
$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.alihealth.drug.kyt.dr.vaequipment.list' \
-d 'partner_id=apidoc' \
-d 'sign=268E33066380D9949AFBA1FC591C8AD0' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-21+20%3A12%3A23' \
-d 'v=2.0' \
-d 'equipment_code_or_name=%E7%96%AB%E8%8B%97%E4%B8%93%E5%BA%93' \
-d 'equipment_type=%E5%86%B7%E5%BA%93' \
-d 'page=1' \
-d 'page_size=10' \
-d 'ref_ent_id=cb14553ed7654ff586b87b637ba23e2c' \
-d 'status=1' \
-d 'target_ref_ent_id=cb14553ed7654ff586b87b637ba23e2c'

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

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

req.ref_ent_id="cb14553ed7654ff586b87b637ba23e2c"
req.target_ref_ent_id="cb14553ed7654ff586b87b637ba23e2c"
req.equipment_code_or_name="疫苗专库"
req.equipment_type="冷库"
req.status="1"
req.page=1
req.page_size=10
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.alihealth.drug.kyt.dr.vaequipment.list");
add_param(pRequest,"ref_ent_id","cb14553ed7654ff586b87b637ba23e2c");
add_param(pRequest,"target_ref_ent_id","cb14553ed7654ff586b87b637ba23e2c");
add_param(pRequest,"equipment_code_or_name","疫苗专库");
add_param(pRequest,"equipment_type","冷库");
add_param(pRequest,"status","1");
add_param(pRequest,"page","1");
add_param(pRequest,"page_size","10");
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.alihealth.drug.kyt.dr.vaequipment.list', {
	'ref_ent_id':'cb14553ed7654ff586b87b637ba23e2c',
	'target_ref_ent_id':'cb14553ed7654ff586b87b637ba23e2c',
	'equipment_code_or_name':'疫苗专库',
	'equipment_type':'冷库',
	'status':'1',
	'page':'1',
	'page_size':'10'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_alihealth_drug_kyt_dr_vaequipment_list_response>
    <result>
        <success>true</success>
        <model>
            <list>
                <result>
                    <mod_date>2019-10-24</mod_date>
                    <address>北京市东城区</address>
                    <comments>demo</comments>
                    <equipment_code>1111</equipment_code>
                    <crt_date>2019-10-24</crt_date>
                    <equipment_type>冷库</equipment_type>
                    <associated_status>0</associated_status>
                    <probe>1111111</probe>
                    <mod_ic_code>demo</mod_ic_code>
                    <address_detail>111111</address_detail>
                    <dict_region_d_t_o>demo</dict_region_d_t_o>
                    <crt_ic_code>500000012</crt_ic_code>
                    <ref_ent_id>cb14553ed7654ff586b87b637ba23e2c</ref_ent_id>
                    <equipment_name>1111111</equipment_name>
                    <va_equipment_id>638a39c77d514a0592a0dc69bc679813</va_equipment_id>
                    <status>1</status>
                </result>
            </list>
            <pages>0</pages>
            <total_num>45</total_num>
            <page_size>10</page_size>
            <page>1</page>
        </model>
        <msg_info>调用成功</msg_info>
        <msg_code>SUCCESS</msg_code>
    </result>
</alibaba_alihealth_drug_kyt_dr_vaequipment_list_response>

{
    "alibaba_alihealth_drug_kyt_dr_vaequipment_list_response":{
        "result":{
            "success":true,
            "model":{
                "list":{
                    "result":[
                        {
                            "mod_date":"2019-10-24",
                            "address":"北京市东城区",
                            "comments":"demo",
                            "equipment_code":"1111",
                            "crt_date":"2019-10-24",
                            "equipment_type":"冷库",
                            "associated_status":"0",
                            "probe":"1111111",
                            "mod_ic_code":"demo",
                            "address_detail":"111111",
                            "dict_region_d_t_o":"demo",
                            "crt_ic_code":"500000012",
                            "ref_ent_id":"cb14553ed7654ff586b87b637ba23e2c",
                            "equipment_name":"1111111",
                            "va_equipment_id":"638a39c77d514a0592a0dc69bc679813",
                            "status":"1"
                        }
                    ]
                },
                "pages":0,
                "total_num":45,
                "page_size":10,
                "page":1
            },
            "msg_info":"调用成功",
            "msg_code":"SUCCESS"
        }
    }
}

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

开放平台

阿里健康追溯码

alibaba.alihealth.drug.kyt.dr.vaequipment.list (获取企业冷链设备信息)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ