Get Asset Trees¶
根据一组assetId
搜索资产所在的资产树。若assetId
不在树上,则data
中无该key。
操作权限¶
需授权的资源 |
所需操作权限 |
---|---|
资产树管理 |
Read |
请求格式¶
POST http://{apigw-address}/asset-tree-service/v2.1/asset-nodes?action=getAssetTree
请求参数(URI)¶
名称 |
位置(Path/Query) |
是否必须 |
数据类型 |
描述 |
---|---|---|---|---|
orgId |
Query |
true |
String |
资产所属的组织ID。如何获取orgId信息>> |
请求参数(Body)¶
名称 |
位置(Path/Query) |
是否必须 |
数据类型 |
描述 |
---|---|---|---|---|
assetIds |
Query |
true |
String Array |
一组资产ID,最多100个。如何获取Asset ID信息>> |
projection |
Query |
false |
String Array |
用于在接口请求中描述待返回的对象projection。详见projection参数如何对结果集做裁剪>> |
响应参数¶
名称 |
数据类型 |
描述 |
---|---|---|
data |
Map(Key为assetId,Value为AssetTree结构体Array) |
资产和其所在的资产树列表,见AssetTree结构体>> |
AssetTree结构体¶
名称 |
数据类型 |
描述 |
---|---|---|
treeId |
String |
资产树ID |
tags |
Map<String, String> |
用户自定义的一组资产树标签 |
asset |
asset 结构体 |
资产树上的根资产 |
示例 1¶
请求示例¶
POST https://{apigw-address}/asset-tree-service/v2.1/asset-nodes?action=getAssetTree&orgId=yourOrgId
{
"assetIds": ["BtsYmF2r", "qf1vsBQW"]
}
返回示例¶
{
"code": 0,
"msg": "OK",
"requestId": "82248518-6da4-49d2-8d07-cf7a0ff55b60",
"data": {
"BtsYmF2r" : [{
"treeId" : "QafeaWe",
"tags" : { },
"asset": {
"modelId": "NULLMODEL",
"assetId": "qf1vsBQW",
"timezone": "+08:00",
"name": {
"i18nValue": {
"en_US": "zmTree604111zzz"
},
"defaultValue": "zmTree604"
},
"description": "",
"attributes": {},
"inValid": false,
"label": "1",
"modelIdPath": "/NULLMODEL",
"tags": {}
}]
}