Update Asset¶
全量或部分更新资产信息。
请求参数(URI)¶
名称 | 位置(Path/Query) | 必需/可选 | 数据类型 | 描述 |
---|---|---|---|---|
orgId | Query | 必需 | String | 资产所属的组织 ID。如何获取 orgId 信息>> |
弃用 isPatchUpdate | Query | 可选 | Boolean | 该参数已弃用,推荐使用
|
updateMode | Query | 可选 | String | 更新模式。如果请求中包含此参数与
|
请求参数(Body)¶
名称 | 必需/可选 | 数据类型 | 描述 |
---|---|---|---|
asset | 必需 | AssetUpdateVo 结构体 | 用于资产更新的信息。其结构参见 AssetUpdateVo 结构体。 |
AssetUpdateVo 结构体 ¶
名称 | 必需/可选 | 数据类型 | 描述 |
---|---|---|---|
assetId | 必需 | String | 资产 ID。如何获取 Asset ID 信息>> |
name | 可选 | StringI18n | 该资产的各语言名称。结构请见 国际化名称结构体>> |
description | 可选 | String | 资产描述 |
attributes |
|
Map(Key 为 String,Value 的数据类型由模型功能定义决定) | 资产所属的模型属性,Key 为属性 ID。更多信息,参见 attributes 的表示方法>> |
timezone | 可选 | String | 时区。时区表示方法>> |
tags | 可选 | Map (Key 和 Value 为 String) | 用户自定义标签。标签的作用与表示方法>> |
tagKeys | 仅当 updateMode 为 tagDelete 才生效。 |
String 数组 | 待删除资产标签的列表,由其标签键定义。 |
错误码¶
代码 | 错误信息 | 描述 |
---|---|---|
12404 | Asset is not existent | assetId 未找到或不存在。 |
12958 | Asset validate failed | 由于资产属性校验失败导致更新失败。 |
示例¶
请求示例¶
url: https://{apigw-address}/asset-service/v2.1/assets?action=update&orgId=yourOrgId&updateMode=tagDelete
method: POST
requestBody:
{
"asset": {
"assetId": "yourAssetId",
"name": {
"defaultValue": "instanceName",
"i18nValue": {
"en_US": "English name ",
"zh_CN": "Chinese name"
}
},
"description": "description",
"attributes": {
"number": 135
},
"timezone": "+08:00",
"tags": {
"year": "2000",
"author": "authorName"
},
"tagKeys": ["book1","book2"]
}
}