Get Asset¶
根据资产 ID 获取资产数据。
如果你在使用 API 批量更新相关资产后调用当前 API,建议两次调用间隔 2 秒左右,以免获取到未更新数据。
请求格式¶
GET https://{apigw-address}/asset-service/v2.1/assets?action=get
请求参数(URI)¶
名称 | 位置(Path/Query) | 必需/可选 | 数据类型 | 描述 |
---|---|---|---|---|
orgId | Query | 必需 | String | 资产所属的组织 ID。如何获取 orgId 信息>> |
assetId | Query | 必需 | String | 资产ID。如何获取 Asset ID 信息>> |
响应参数¶
名称 | 数据类型 | 描述 |
---|---|---|
data | Asset 结构体 | 资产。见 Asset 结构体>> |
Asset 结构体¶
名称 | 数据类型 | 描述 |
---|---|---|
assetId | String | 资产 ID。 |
orgId | String | 资产所属的组织 ID。 |
name | StringI18n | 该资产的各语言名称。 |
description | String | 资产描述。 |
attributes | Map (Key 为 String, Value 类型取决于模型定义) |
|
timezone | String | 时区。 |
modelId | String | 资产所属模型ID。 |
modelIdPath | String |
|
tags | Map(Key 为 String, Value 为 String) | 用户自定义标签。 |
示例¶
请求示例¶
url: https://{apigw-address}/asset-service/v2.1/assets?action=get&orgId=yourOrgId&assetId=yourAssetId
method: GET
返回示例¶
{
"msg": "OK",
"code": 0,
"data": {
"modelId": "planet",
"assetId": "yourAssetId",
"timezone": "+00:00",
"name": {
"i18nValue": {
"en_US": "English name ",
"zh_CN": "Chinese name"
},
"defaultValue": "venus!"
},
"attributes": {
"system": "Solar System"
},
"modelIdPath": "/planet",
"orgId": "yourOrgId",
"description": "description",
"tags": {
"tag1":"bright"
}
},
"requestId": "9a5cfbac-b2f8-4a37-b38d-8bccdd77d073"
}