Help Center/ Object Storage Service/ SDK Reference/ Node.js/ Object APIs (SDK for Node.js)/ Object Tags (SDK for Node.js)/ Setting Object Tags (SDK for Node.js)
Updated on 2026-07-22 GMT+08:00
View PDF
Share

Setting Object Tags (SDK for Node.js)

If you have any questions during development, post them on the Issues page of GitHub.

Function

This API sets or updates tags for an object. Each tag is a key-value pair.

Restrictions

  • To set object tags, you must be the bucket owner or have the required permission (obs:object:PutObjectTagging in IAM or PutObjectTagging in a bucket policy if versionId is not specified; obs:object:PutObjectVersionTagging in IAM or PutObjectVersionTagging in a bucket policy if versionId is specified). For details, see Introduction to OBS Access Control, IAM Custom Policies, and Creating a Custom Bucket Policy.
  • By default, tags are added to the latest object version. You can specify the versionId parameter to apply tags to a specific object version. If you add tags to a delete marker, 404 Not Found is returned.
  • Parallel file systems do not support this function.
  • Each object can have up to 10 tags.
  • To learn about the mappings between OBS regions and endpoints, see Regions and Endpoints.

Method

ObsClient.setObjectTagging(params)

Request Parameters

Table 1 List of request parameters

Parameter

Type

Mandatory (Yes/No)

Description

Bucket

string

Yes

Bucket name

Restrictions:

  • A bucket name must be unique across all accounts and regions.
  • A bucket name:
    • Must be 3 to 63 characters long and start with a digit or letter. Lowercase letters, digits, hyphens (-), and periods (.) are allowed.
    • Cannot be formatted as an IP address.
    • Cannot start or end with a hyphen (-) or period (.).
    • Cannot contain two consecutive periods (..), for example, my..bucket.
    • Cannot contain a period (.) and a hyphen (-) adjacent to each other, for example, my-.bucket or my.-bucket.
  • If you repeatedly create buckets with the same name in the same region, no error will be reported, and the bucket attributes comply with those set in the first creation request.

Value range:

The value can contain 3 to 63 characters.

Default value:

None

Key

string

Yes

Explanation:

Object name. An object is uniquely identified by an object name in a bucket. An object name is a complete path of the object that does not contain the bucket name.

For example, if the address for accessing the object is examplebucket.obs.ap-southeast-1.myhuaweicloud.com/folder/test.txt, the object name is folder/test.txt.

Restrictions:

None

Value range:

The value can contain 1 to 1,024 characters.

Default value:

None

VersionId

string

No

Explanation:

Object version ID, for example, G001117FCE89978B0000401205D5DC9A

Restrictions:

None

Value range:

The value must contain 32 characters.

Default value:

None

Tags

Tag[]

Yes

Explanation:

List of object tags

Restrictions:

  • A bucket can have a maximum of 10 tags. Each tag can contain only one key-value pair.
  • For the same bucket, tag keys must be unique, but tag values can be duplicated or left blank.

Value range:

See Tag.

Default value:

None
Table 2 Tag

Parameter

Type

Mandatory (Yes/No)

Description

Key

string

Yes if used as a request parameter

Explanation:

Tag key.

Restrictions:

  • The tag key in the same bucket must be unique.
  • The tag key contains a maximum of 36 characters.
  • The tag key allows UTF-8 letters, digits, spaces, and these characters: _.:=+-@
  • The tag key is case-sensitive.
  • The tag key cannot be left blank.

Value range:

The key contains 1 to 36 characters.

Default value:

None

Value

string

Yes if used as a request parameter

Explanation:

Tag value.

Restrictions:

  • Tag values can be duplicated.
  • The value must contain 0 to 43 characters.
  • The tag value allows UTF-8 letters, digits, spaces, and these characters: _.:=+-@
  • The value is case-sensitive.
  • The value can be left blank.

Value range:

The value contains 0 to 43 characters.

Default value:

None

Responses

Table 3 Responses

Type

Description

Table 4

NOTE:

This API returns a Promise response, which requires the Promise or async/await syntax.

Explanation:

Returned results. For details, see Table 4.
Table 4 Response

Parameter

Type

Description

CommonMsg

ICommonMsg

Explanation:

Common information generated after an API call is complete, including the HTTP status code and error code. For details, see Table 5.

InterfaceResult

Table 6

Explanation:

Results outputted for a successful call. For details, see Table 6.

Restrictions:

This parameter is not included if the value of Status is greater than 300.
Table 5 ICommonMsg

Parameter

Type

Description

Status

number

Explanation:

HTTP status code returned by the OBS server.

Value range:

A status code is a group of digits indicating the status of a response. It ranges from 2xx (indicating successes) to 4xx or 5xx (indicating errors). For details, see Status Codes.

Code

string

Explanation:

Error code returned by the OBS server.

Message

string

Explanation:

Error description returned by the OBS server.

HostId

string

Explanation:

Request server ID returned by the OBS server.

RequestId

string

Explanation:

Request ID returned by the OBS server.

Id2

string

Explanation:

Request ID2 returned by the OBS server.

Indicator

string

Explanation:

Error code details returned by the OBS server.
Table 6 BaseResponseOutput

Parameter

Type

Description

RequestId

string

Explanation:

Request ID returned by the OBS server

Code Examples

This example sets tags for object example/objectname in bucket examplebucket.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
 
// Import the OBS library.
// Use npm to install the client.
const ObsClient = require("esdk-obs-nodejs");
// Use the source code to install the client.
// var ObsClient = require('./lib/obs');

// Create an instance of ObsClient.
const obsClient = new ObsClient({
  // Obtain an AK/SK pair using environment variables or import an AK/SK pair in other ways. Using hard coding may result in leakage.
  // Obtain an AK/SK pair on the management console. For details, see https://support.huaweicloud.com/intl/en-us/usermanual-ca/ca_01_0003.html.
  access_key_id: process.env.ACCESS_KEY_ID,
  secret_access_key: process.env.SECRET_ACCESS_KEY,
  // (Optional) If you use a temporary AK/SK pair and a security token to access OBS, you are advised not to use hard coding, which may result in information leakage. You can obtain an AK/SK pair using environment variables or import an AK/SK pair in other ways.
  // security_token: process.env.SECURITY_TOKEN,
  // Enter the endpoint corresponding to the region where the bucket is located. CN-Hong Kong is used here in this example. Replace it with the one currently in use.
  server: "https://obs.ap-southeast-1.myhuaweicloud.com"
});

async function setObjectTagging() {
  try {
    const params = {
      // Specify the bucket name.
      Bucket: "examplebucket",
      // Specify an object. example/objectname is used in this example.
      Key: "example/objectname",
      // Specify tags.
      Tags: [
        {Key: "key0", Value: "value0"},
        {Key: "key1", Value: "value1"},
      ]
    };
    // Set object tags.
    const result = await obsClient.setObjectTagging(params);
    if (result.CommonMsg.Status <= 300) {
      console.log("Set Object(%s)'s tagging configuration successful with Bucket(%s)", params.Bucket);
      console.log("RequestId: %s", result.CommonMsg.RequestId);
      return;
    };
    console.log("An ObsError was found, which means your request sent to OBS was rejected with an error response.");
    console.log("Status: %d", result.CommonMsg.Status);
    console.log("Code: %s", result.CommonMsg.Code);
    console.log("Message: %s", result.CommonMsg.Message);
    console.log("RequestId: %s", result.CommonMsg.RequestId);
  } catch (error) {
    console.log("An Exception was found, which means the client encountered an internal problem when attempting to communicate with OBS, for example, the client was unable to access the network.");
    console.log(error);
  };
};

setObjectTagging();