查询apikey
请求方式:GET
URL: http://API_ADDRESS/keys
URL参数
参数名称 |
格式 |
是否必须 |
说明 |
key |
string |
否 |
用于查询单独apikey详情 |
device_id |
string |
否 |
用于查询与某设备ID相关的apikey |
page |
string |
否 |
指定页码 |
per_page |
string |
否 |
每页输出个数,默认10,最多为100 |
返回参数
参数名称 |
格式 |
说明 |
errno |
int |
调用错误码,为0表示调用成功 |
error |
string |
错误描述,为"succ"表示调用成功 |
data |
json |
接口调用成功之后返回的相关信息,见data描述表 |
data描述表
参数名称 |
格式 |
说明 |
total_count |
int |
查询结果中设备的数量 |
page |
int |
当前页 |
per_page |
int |
每页设备数量 |
keys |
array-json |
设备信息的json数组,见keys描述表 |
keys描述表
参数名称 |
格式 |
说明 |
create_time |
string |
创建时间,示例:2017-08-22 11:52:29 |
key |
string |
apikey内容 |
permissions |
array-json |
访问资源权限(见新增api) |
title |
string |
apikey名称 |
请求示例1
查询某一apikey详情
GET http://API_ADDRESS/keys?key=7RM**************ao= HTTP/1.1
返回示例1
{
"errno": 0,
"data": {
"per_page": 1,
"total_count": 1,
"keys": [{
"title": "new1apikey",
"create_time": "2017-08-22 11:52:29",
"key": "7RM**************ao=",
"permissions": [{
"resources": [{
"dev_id": "39593230"
}]
}]
}],
"page": 1
},
"error": "succ"
}
请求示例2
查询某一设备关联的apikey详情
GET http://API_ADDRESS/keys?device_id=39593230 HTTP/1.1
返回示例1
{
"errno": 0,
"data": {
"per_page": 30,
"total_count": 2,
"keys": [{
"create_time": "2017-08-22 11:52:29",
"permissions": [{
"resources": [{
"dev_id": "39593230"
}]
}],
"title": "new1apikey",
"key": "7RM**************ao="
}, {
"create_time": "2017-08-23 09:01:45",
"permissions": [{
"resources": [{
"ds_id": "1312",
"dev_id": "39593230"
}, {
"dev_id": "39456825"
}]
}],
"title": "new2apikey",
"key": "F=***************RQ="
}],
"page": 1
},
"error": "succ"
}