Updated on 2026-07-30 GMT+08:00

Creating Tags in Batches

Function

This API is used to add tags to multiple resources of a cloud service. A maximum of 10 tags can be added to one resource. A maximum of 50 resources can be tagged at a time.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    tms:resourceTags:create

    Write

    -

    -

    -

    -

URI

POST /v1.0/resource-tags/batch-create

Request Parameters

Table 1 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token. For details about how to obtain it, see Authentication.

Constraints

TMS is a global service. Set scope to domain when you call the IAM API to obtain a user token.

Range

N/A

Default Value

N/A

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

project_id

No

String

Definition

Project ID. For details about how to obtain it, see Obtaining a Project ID.

Constraints

This parameter is mandatory when resource_type is set to a region-level service.

Range

N/A

Default Value

N/A

resources

Yes

Array of ResourceTagBody objects

Definition

Resource list. A maximum of 50 resources can be operated in a batch each time.

Constraints

N/A

tags

Yes

Array of CreateTagRequest objects

Definition

Tag list. A maximum of 10 tags can be operated in a batch each time.

Constraints

N/A

Table 3 ResourceTagBody

Parameter

Mandatory

Type

Description

resource_id

Yes

String

Definition

Cloud resource ID. You can query the ID on the cloud resource page.

Constraints

N/A

Range

N/A

Default Value

N/A

resource_type

Yes

String

Definition

Resource type. The options include ecs, scaling_group, images, disk, vpc, security-groups, shared_bandwidth, eip, and cdn. For details about how to obtain it, see Querying Services Supported by TMS.

Constraints

N/A

Range

N/A

Default Value

N/A

Table 4 CreateTagRequest

Parameter

Mandatory

Type

Description

key

Yes

String

Definition

Tag key. For details, see Notes and Constraints.

Constraints

N/A

Range

N/A

Default Value

N/A

value

Yes

String

Definition

Tag value. For details, see Notes and Constraints.

Constraints

N/A

Range

N/A

Default Value

N/A

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

failed_resources

Array of TagResponseItem objects

Definition

Resources that failed to be tagged. Each element is a TagResponseItem object, which contains the failure information, resource ID, resource type, and other information.

Table 6 TagResponseItem

Parameter

Type

Description

resource_id

String

Definition

Cloud resource ID. You can query the ID on the cloud resource page.

Range

N/A

resource_type

String

Definition

Resource type. Example values include ecs, scaling_group, images, disk, vpc, security-groups, shared_bandwidth, eip, and cdn. For details about how to obtain it, see Querying Services Supported by TMS.

Range

N/A

error_code

String

Definition

Error code. For details about the error codes of the corresponding cloud service, see Error Codes.

Range

N/A

error_msg

String

Definition

Error description.

Range

N/A

Status code: 400

Table 7 Response body parameters

Parameter

Type

Description

error

RespErrorMessage object

Definition

Error message in the response.

Table 8 RespErrorMessage

Parameter

Type

Description

error_code

String

Definition

Error code. For details about the error codes of the corresponding cloud service, see Error Codes.

Range

N/A

error_msg

String

Definition

Error description.

Range

N/A

Status code: 401

Table 9 Response body parameters

Parameter

Type

Description

error

RespErrorMessage object

Definition

Error message in the response.

Table 10 RespErrorMessage

Parameter

Type

Description

error_code

String

Definition

Error code. For details about the error codes of the corresponding cloud service, see Error Codes.

Range

N/A

error_msg

String

Definition

Error description.

Range

N/A

Status code: 403

Table 11 Response body parameters

Parameter

Type

Description

error

RespErrorMessage object

Definition

Error message in the response.

Table 12 RespErrorMessage

Parameter

Type

Description

error_code

String

Definition

Error code. For details about the error codes of the corresponding cloud service, see Error Codes.

Range

N/A

error_msg

String

Definition

Error description.

Range

N/A

Status code: 404

Table 13 Response body parameters

Parameter

Type

Description

error

RespErrorMessage object

Definition

Error message in the response.

Table 14 RespErrorMessage

Parameter

Type

Description

error_code

String

Definition

Error code. For details about the error codes of the corresponding cloud service, see Error Codes.

Range

N/A

error_msg

String

Definition

Error description.

Range

N/A

Status code: 405

Table 15 Response body parameters

Parameter

Type

Description

error

RespErrorMessage object

Definition

Error message in the response.

Table 16 RespErrorMessage

Parameter

Type

Description

error_code

String

Definition

Error code. For details about the error codes of the corresponding cloud service, see Error Codes.

Range

N/A

error_msg

String

Definition

Error description.

Range

N/A

Status code: 406

Table 17 Response body parameters

Parameter

Type

Description

error

RespErrorMessage object

Definition

Error message in the response.

Table 18 RespErrorMessage

Parameter

Type

Description

error_code

String

Definition

Error code. For details about the error codes of the corresponding cloud service, see Error Codes.

Range

N/A

error_msg

String

Definition

Error description.

Range

N/A

Status code: 409

Table 19 Response body parameters

Parameter

Type

Description

error

RespErrorMessage object

Definition

Error message in the response.

Table 20 RespErrorMessage

Parameter

Type

Description

error_code

String

Definition

Error code. For details about the error codes of the corresponding cloud service, see Error Codes.

Range

N/A

error_msg

String

Definition

Error description.

Range

N/A

Status code: 410

Table 21 Response body parameters

Parameter

Type

Description

error

RespErrorMessage object

Definition

Error message in the response.

Table 22 RespErrorMessage

Parameter

Type

Description

error_code

String

Definition

Error code. For details about the error codes of the corresponding cloud service, see Error Codes.

Range

N/A

error_msg

String

Definition

Error description.

Range

N/A

Status code: 412

Table 23 Response body parameters

Parameter

Type

Description

error

RespErrorMessage object

Definition

Error message in the response.

Table 24 RespErrorMessage

Parameter

Type

Description

error_code

String

Definition

Error code. For details about the error codes of the corresponding cloud service, see Error Codes.

Range

N/A

error_msg

String

Definition

Error description.

Range

N/A

Status code: 429

Table 25 Response body parameters

Parameter

Type

Description

error

RespErrorMessage object

Definition

Error message in the response.

Table 26 RespErrorMessage

Parameter

Type

Description

error_code

String

Definition

Error code. For details about the error codes of the corresponding cloud service, see Error Codes.

Range

N/A

error_msg

String

Definition

Error description.

Range

N/A

Status code: 500

Table 27 Response body parameters

Parameter

Type

Description

error

RespErrorMessage object

Definition

Error message in the response.

Table 28 RespErrorMessage

Parameter

Type

Description

error_code

String

Definition

Error code. For details about the error codes of the corresponding cloud service, see Error Codes.

Range

N/A

error_msg

String

Definition

Error description.

Range

N/A

Status code: 501

Table 29 Response body parameters

Parameter

Type

Description

error

RespErrorMessage object

Definition

Error message in the response.

Table 30 RespErrorMessage

Parameter

Type

Description

error_code

String

Definition

Error code. For details about the error codes of the corresponding cloud service, see Error Codes.

Range

N/A

error_msg

String

Definition

Error description.

Range

N/A

Status code: 503

Table 31 Response body parameters

Parameter

Type

Description

error

RespErrorMessage object

Definition

Error message in the response.

Table 32 RespErrorMessage

Parameter

Type

Description

error_code

String

Definition

Error code. For details about the error codes of the corresponding cloud service, see Error Codes.

Range

N/A

error_msg

String

Definition

Error description.

Range

N/A

Example Requests

Adding tags to a resource in batches

POST https://{Endpoint}/v1.0/resource-tags/batch-create

{
  "project_id" : "xxxdcffffffff",
  "resources" : [ {
    "resource_id" : "a28531fa-a8d5-468e-8417-86a80962ee5e",
    "resource_type" : "disk"
  }, {
    "resource_id" : "a28531fa-a8d5-468e-8417-86a8096ddddd",
    "resource_type" : "vpc"
  } ],
  "tags" : [ {
    "key" : "ENV",
    "value" : "dev"
  }, {
    "key" : "DEPT",
    "value" : "pdd"
  } ]
}

Example Responses

Status code: 200

Success

{
  "failed_resources" : [ {
    "resource_id" : "e1eb7c40cbea4c8389cde527594a306d",
    "resource_type" : "disk",
    "error_code" : "TMS.0002",
    "error_msg" : "Bad request"
  } ]
}

SDK Sample Code

The SDK sample code is as follows.

Java

Adding tags to a resource in batches

 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
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.GlobalCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.tms.v1.region.TmsRegion;
import com.huaweicloud.sdk.tms.v1.*;
import com.huaweicloud.sdk.tms.v1.model.*;

import java.util.List;
import java.util.ArrayList;

public class CreateResourceTagSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");

        ICredential auth = new GlobalCredentials()
                .withAk(ak)
                .withSk(sk);

        TmsClient client = TmsClient.newBuilder()
                .withCredential(auth)
                .withRegion(TmsRegion.valueOf("<YOUR REGION>"))
                .build();
        CreateResourceTagRequest request = new CreateResourceTagRequest();
        ReqCreateTag body = new ReqCreateTag();
        List<CreateTagRequest> listbodyTags = new ArrayList<>();
        listbodyTags.add(
            new CreateTagRequest()
                .withKey("ENV")
                .withValue("dev")
        );
        listbodyTags.add(
            new CreateTagRequest()
                .withKey("DEPT")
                .withValue("pdd")
        );
        List<ResourceTagBody> listbodyResources = new ArrayList<>();
        listbodyResources.add(
            new ResourceTagBody()
                .withResourceId("a28531fa-a8d5-468e-8417-86a80962ee5e")
                .withResourceType("disk")
        );
        listbodyResources.add(
            new ResourceTagBody()
                .withResourceId("a28531fa-a8d5-468e-8417-86a8096ddddd")
                .withResourceType("vpc")
        );
        body.withTags(listbodyTags);
        body.withResources(listbodyResources);
        body.withProjectId("xxxdcffffffff");
        request.withBody(body);
        try {
            CreateResourceTagResponse response = client.createResourceTag(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

Python

Adding tags to a resource in batches

 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
51
52
53
54
55
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import GlobalCredentials
from huaweicloudsdktms.v1.region.tms_region import TmsRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdktms.v1 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]

    credentials = GlobalCredentials(ak, sk)

    client = TmsClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(TmsRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = CreateResourceTagRequest()
        listTagsbody = [
            CreateTagRequest(
                key="ENV",
                value="dev"
            ),
            CreateTagRequest(
                key="DEPT",
                value="pdd"
            )
        ]
        listResourcesbody = [
            ResourceTagBody(
                resource_id="a28531fa-a8d5-468e-8417-86a80962ee5e",
                resource_type="disk"
            ),
            ResourceTagBody(
                resource_id="a28531fa-a8d5-468e-8417-86a8096ddddd",
                resource_type="vpc"
            )
        ]
        request.body = ReqCreateTag(
            tags=listTagsbody,
            resources=listResourcesbody,
            project_id="xxxdcffffffff"
        )
        response = client.create_resource_tag(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Go

Adding tags to a resource in batches

 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
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/global"
    tms "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/tms/v1"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/tms/v1/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/tms/v1/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")

    auth, err := global.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        SafeBuild()

    if err != nil {
        fmt.Println(err)
        return
    }

    hcClient, err := tms.TmsClientBuilder().
         WithRegion(region.ValueOf("<YOUR REGION>")).
         WithCredential(auth).
         SafeBuild()


    if err != nil {
        fmt.Println(err)
        return
    }

    client := tms.NewTmsClient(hcClient)

    request := &model.CreateResourceTagRequest{}
	var listTagsbody = []model.CreateTagRequest{
        {
            Key: "ENV",
            Value: "dev",
        },
        {
            Key: "DEPT",
            Value: "pdd",
        },
    }
	var listResourcesbody = []model.ResourceTagBody{
        {
            ResourceId: "a28531fa-a8d5-468e-8417-86a80962ee5e",
            ResourceType: "disk",
        },
        {
            ResourceId: "a28531fa-a8d5-468e-8417-86a8096ddddd",
            ResourceType: "vpc",
        },
    }
	projectIdReqCreateTag:= "xxxdcffffffff"
	request.Body = &model.ReqCreateTag{
		Tags: listTagsbody,
		Resources: listResourcesbody,
		ProjectId: &projectIdReqCreateTag,
	}
	response, err := client.CreateResourceTag(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

More

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

405

Method Not Allowed

406

Not Acceptable

409

Conflict

410

Gone

412

Precondition Failed

429

Too Many Requests

500

Internal Server Error

501

Not Implemented

503

Service Unavailable

Error Codes

See Error Codes.