Update Asset¶

Update asset information.

Action Permissions¶

Before invoking this API, ensure that the service account has been authorized the policy that includes the following service(s) and action permission(s). For how to authorize the service account, see Managing Service Accounts.

Required Service	Required Action Permission
Asset Tree	Full Access

Prerequisite¶

The asset to be updated must exist.
The fields to be updated must exist.

Request Format¶

POST https://{apigw-address}/asset-service/v2.1/assets?action=update

Request Parameters (URI)¶

Name

Location (Path/Query)

Mandatory/Optional

Data Type

Description

orgId

Query

Mandatory

String

The organization ID which the asset belongs to. How to get orgId>>

(deprecated) isPatchUpdate

Query

Optional

Boolean

This parameter is deprecated. It is recommended to use updateMode instead.

true (default): Only the fields specified in the parameters are updated. The values of those fields not specified will be retained.
false: The fields specified in the parameters are updated. Those fields not specified will have their existing values (if any) deleted or be overwritten by their default values (if any).

updateMode

Query

Optional

String

The update method. If both updateMode and isPatchUpdate parameters are in the request, isPatchUpdate will be ignored. Available options are as per the below.

patchUpdate (default): Only the fields specified in the parameters are updated. The values of those fields not specified will be retained.
overwrite: All fields are updated. Mandatory fields such as the asset name, timezone, etc. must be specified, otherwise the API call will fail. If the values of non-mandatory fields are not specified, they will be changed to “null” or be overwritten by their default values (if any).
tagDelete: Only the specified tags in tagKeys under the specified assetId are deleted. All fields not in tagKeys will remain unchanged.

Request Parameters (Body)¶

Name	Mandatory/Optional	Data Type	Description
asset	Mandatory	AssetUpdateVo Struct	The details for updating the asset. For more information, see AssetUpdateVo Struct.

AssetUpdateVo Struct ¶

Name	Mandatory/Optional	Data Type	Description
assetId	Mandatory	String	The asset ID. How to get assetId>>
name	Optional	StringI18n	Specify the asset’s name in its respective locale’s language. For more details on the structure and locales supported, see Internationalized name struct.
description	Optional	String	The asset description.
attributes	If `updateMode` is `overwrite` or `isPatchUpdate` is `false`, this is mandatory, and must include all the attributes prescribed in the model feature definition and their values. If `updateMode` is `patchUpdate` or `isPatchUpdate` is `true`, this is optional, and can include all or part of the attributes prescribed in the model feature definition and their values. The values can be left blank.	Map (Key is of String type, and Value depends on the attribute defined in the model)	Attributes of the model which the asset belongs to. Key is the attribute ID. For more information, see attributes representation.
timezone	Optional	String	The timezone where the asset is located. Use the “+08:00” format for time zones that do not support Daylight Saving Time (DST). Use the “Asia/Shanghai” format for time zones that support DST. For details, see Timezone representation.
tags	Optional	Map (Key and Value are of String type)	User-defined tags. For more information, see How to use tag.
tagKeys	Only applicable when `updateMode` is `tagDelete`.	String Array	The list of tags under the asset to be deleted, defined by their tag keys.

Error Codes¶

Code	Message	Description
12404	Asset is not existent	The `assetId` cannot be found or does not exist.
12958	Asset validate failed	Update failed due to asset attribute verification failure.

Samples¶

Request Sample¶

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"]
  }
}

Return Sample¶

{
  "code": 0,
  "msg": "OK",
  "requestId": "fa11232e-7e45-4176-a382-963c1240a27f"
}

SDK Samples¶

You can access the SDK samples for Asset Service on GitHub:

Java
Python