Get Asset Tree¶
获取资产树信息。
如果你在使用 API 批量更新相关资产树信息后调用当前 API，建议两次调用间隔 2 秒左右，以免获取到未更新数据。
请求格式¶
GET https://{apigw-address}/asset-tree-service/v2.1/asset-trees?action=get
请求参数（URI）¶
| 名称 | 位置（Path/Query） | 必需/可选 | 数据类型 | 描述 |
|---|---|---|---|---|
| orgId | Query | 必需 | String | 资产所属的组织 ID。如何获取 orgId 信息>> |
| treeId | Query | 必需 | String | 需要获取的资产树 ID。如何获取资产树信息 ID>> |
响应参数¶
| 名称 | 数据类型 | 描述 |
|---|---|---|
| treeId | String | 资产树 ID。 |
| name | StringI18n | 支持国际化的资产树名称。其结构参见 国际化名称结构体>>。 |
| tags | Map（Key 为 String，Value 为 String） | 用户自定义的一组资产树标签。 |
| asset | Asset 结构体 | 资产树的根资产，其结构参见 Asset 结构体。 |
Asset 结构体
| 名称 | 数据类型 | 描述 |
|---|---|---|
| assetId | String | 资产 ID。 |
| modelId | String | 资产所属模型 ID。 |
| modelIdPath | String | 模型 ID 的路径。 |
| name | StringI18n | 支持国际化的资产名称。其结构参见 国际化名称结构体。 |
| timezone | String | 资产所属时区。 |
| description | String | 资产描述。 |
| label | String | 资产类型。
|
| inValid | Boolean | true 为无效节点，false 为有效节点。 |
| attributes | Map（Key 为 String，Value 为 Object） | 资产所属的模型属性。 |
| tags | Map（Key 为 String, Value 为 String） | 用户自定义标签。标签的作用与表示方法>> |
错误码¶
| 代码 | 错误信息 | 描述 |
|---|---|---|
| 17404 | TreeId is not exist | Tree ID 不存在。 |
| 99400 | Invalid arguments | 请求参数非法，请检查请求参数。 |
| 99500 | System error | 服务器内部错误，请联系 EnOS。 |
示例¶
请求示例¶
url: https://{apigw-address}/asset-tree-service/v2.1/asset-trees?action=get&treeId=yourTreeId&orgId=yourOrgId
method: GET
返回示例¶
{
"code":0,
"msg":"OK",
"requestId":"f3c1ffc7-cc8e-4a50-ad40-0fa7b0c3a7ac",
"data":{
"treeId":"ourTreeId",
"name":{
"defaultValue":"ourTreeId",
"i18nValue":{
"en_US":"ourTreeID"
}
},
"tags":{
"user":"zm",
"user0":"lily"
},
"asset":{
"inValid":false,
"assetId":"yourAssetId",
"modelId":"yourModelId",
"modelIdPath":"yourModelIdPath",
"name":{
"defaultValue":"0430343",
"i18nValue":{
"en_US":"0430343"
}
},
"timezone":"+08:00",
"description":null,
"label":"1",
"attributes":{
},
"tags":{
"tree":"0430"
}
}
}
}